< prev index next >

src/java.base/share/classes/java/security/AlgorithmParameterGenerator.java

Print this page


   1 /*
   2  * Copyright (c) 1997, 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


 123      */
 124     public final String getAlgorithm() {
 125         return this.algorithm;
 126     }
 127 
 128     /**
 129      * Returns an AlgorithmParameterGenerator object for generating
 130      * a set of parameters to be used with the specified algorithm.
 131      *
 132      * <p> This method traverses the list of registered security Providers,
 133      * starting with the most preferred Provider.
 134      * A new AlgorithmParameterGenerator object encapsulating the
 135      * AlgorithmParameterGeneratorSpi implementation from the first
 136      * Provider that supports the specified algorithm is returned.
 137      *
 138      * <p> Note that the list of registered providers may be retrieved via
 139      * the {@link Security#getProviders() Security.getProviders()} method.
 140      *
 141      * @implNote
 142      * The JDK Reference Implementation additionally uses the
 143      * {@code jdk.security.provider.preferred} property to determine

 144      * the preferred provider order for the specified algorithm. This
 145      * may be different than the order of providers returned by
 146      * {@link Security#getProviders() Security.getProviders()}.
 147      *
 148      * @param algorithm the name of the algorithm this
 149      * parameter generator is associated with.
 150      * See the AlgorithmParameterGenerator section in the <a href=
 151      * "{@docRoot}/../technotes/guides/security/StandardNames.html#AlgorithmParameterGenerator">
 152      * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 153      * for information about standard algorithm names.
 154      *
 155      * @return the new AlgorithmParameterGenerator object.
 156      *
 157      * @exception NoSuchAlgorithmException if no Provider supports an
 158      *          AlgorithmParameterGeneratorSpi implementation for the
 159      *          specified algorithm.
 160      *
 161      * @see Provider
 162      */
 163     public static AlgorithmParameterGenerator getInstance(String algorithm)


   1 /*
   2  * Copyright (c) 1997, 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


 123      */
 124     public final String getAlgorithm() {
 125         return this.algorithm;
 126     }
 127 
 128     /**
 129      * Returns an AlgorithmParameterGenerator object for generating
 130      * a set of parameters to be used with the specified algorithm.
 131      *
 132      * <p> This method traverses the list of registered security Providers,
 133      * starting with the most preferred Provider.
 134      * A new AlgorithmParameterGenerator object encapsulating the
 135      * AlgorithmParameterGeneratorSpi implementation from the first
 136      * Provider that supports the specified algorithm is returned.
 137      *
 138      * <p> Note that the list of registered providers may be retrieved via
 139      * the {@link Security#getProviders() Security.getProviders()} method.
 140      *
 141      * @implNote
 142      * The JDK Reference Implementation additionally uses the
 143      * {@code jdk.security.provider.preferred}
 144      * {@link Security#getProperty(String) Security} property to determine
 145      * the preferred provider order for the specified algorithm. This
 146      * may be different than the order of providers returned by
 147      * {@link Security#getProviders() Security.getProviders()}.
 148      *
 149      * @param algorithm the name of the algorithm this
 150      * parameter generator is associated with.
 151      * See the AlgorithmParameterGenerator section in the <a href=
 152      * "{@docRoot}/../technotes/guides/security/StandardNames.html#AlgorithmParameterGenerator">
 153      * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
 154      * for information about standard algorithm names.
 155      *
 156      * @return the new AlgorithmParameterGenerator object.
 157      *
 158      * @exception NoSuchAlgorithmException if no Provider supports an
 159      *          AlgorithmParameterGeneratorSpi implementation for the
 160      *          specified algorithm.
 161      *
 162      * @see Provider
 163      */
 164     public static AlgorithmParameterGenerator getInstance(String algorithm)


< prev index next >