< prev index next >

src/java.base/share/classes/javax/crypto/Mac.java

Print this page


   1 /*
   2  * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


 137      */
 138     public final String getAlgorithm() {
 139         return this.algorithm;
 140     }
 141 
 142     /**
 143      * Returns a {@code Mac} object that implements the
 144      * specified MAC algorithm.
 145      *
 146      * <p> This method traverses the list of registered security Providers,
 147      * starting with the most preferred Provider.
 148      * A new Mac object encapsulating the
 149      * MacSpi implementation from the first
 150      * Provider that supports the specified algorithm is returned.
 151      *
 152      * <p> Note that the list of registered providers may be retrieved via
 153      * the {@link Security#getProviders() Security.getProviders()} method.
 154      *
 155      * @implNote
 156      * The JDK Reference Implementation additionally uses the
 157      * {@code jdk.security.provider.preferred} property to determine

 158      * the preferred provider order for the specified algorithm. This
 159      * may be different than the order of providers returned by
 160      * {@link Security#getProviders() Security.getProviders()}.
 161      *
 162      * @param algorithm the standard name of the requested MAC algorithm.
 163      * See the Mac section in the <a href=
 164      *   "{@docRoot}/../technotes/guides/security/StandardNames.html#Mac">
 165      * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 166      * for information about standard algorithm names.
 167      *
 168      * @return the new {@code Mac} object.
 169      *
 170      * @exception NoSuchAlgorithmException if no Provider supports a
 171      *          MacSpi implementation for the
 172      *          specified algorithm.
 173      *
 174      * @see java.security.Provider
 175      */
 176     public static final Mac getInstance(String algorithm)
 177             throws NoSuchAlgorithmException {


   1 /*
   2  * Copyright (c) 1998, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


 137      */
 138     public final String getAlgorithm() {
 139         return this.algorithm;
 140     }
 141 
 142     /**
 143      * Returns a {@code Mac} object that implements the
 144      * specified MAC algorithm.
 145      *
 146      * <p> This method traverses the list of registered security Providers,
 147      * starting with the most preferred Provider.
 148      * A new Mac object encapsulating the
 149      * MacSpi implementation from the first
 150      * Provider that supports the specified algorithm is returned.
 151      *
 152      * <p> Note that the list of registered providers may be retrieved via
 153      * the {@link Security#getProviders() Security.getProviders()} method.
 154      *
 155      * @implNote
 156      * The JDK Reference Implementation additionally uses the
 157      * {@code jdk.security.provider.preferred}
 158      * {@link Security#getProperty(String) Security} property to determine
 159      * the preferred provider order for the specified algorithm. This
 160      * may be different than the order of providers returned by
 161      * {@link Security#getProviders() Security.getProviders()}.
 162      *
 163      * @param algorithm the standard name of the requested MAC algorithm.
 164      * See the Mac section in the <a href=
 165      *   "{@docRoot}/../technotes/guides/security/StandardNames.html#Mac">
 166      * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 167      * for information about standard algorithm names.
 168      *
 169      * @return the new {@code Mac} object.
 170      *
 171      * @exception NoSuchAlgorithmException if no Provider supports a
 172      *          MacSpi implementation for the
 173      *          specified algorithm.
 174      *
 175      * @see java.security.Provider
 176      */
 177     public static final Mac getInstance(String algorithm)
 178             throws NoSuchAlgorithmException {


< prev index next >