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
187 */
188 public final String getAlgorithm() {
189 return this.algorithm;
190 }
191
192 /**
193 * Returns a {@code KeyGenerator} object that generates secret keys
194 * for the specified algorithm.
195 *
196 * <p> This method traverses the list of registered security Providers,
197 * starting with the most preferred Provider.
198 * A new KeyGenerator object encapsulating the
199 * KeyGeneratorSpi implementation from the first
200 * Provider that supports the specified algorithm is returned.
201 *
202 * <p> Note that the list of registered providers may be retrieved via
203 * the {@link Security#getProviders() Security.getProviders()} method.
204 *
205 * @implNote
206 * The JDK Reference Implementation additionally uses the
207 * {@code jdk.security.provider.preferred} property to determine
208 * the preferred provider order for the specified algorithm. This
209 * may be different than the order of providers returned by
210 * {@link Security#getProviders() Security.getProviders()}.
211 *
212 * @param algorithm the standard name of the requested key algorithm.
213 * See the KeyGenerator section in the <a href=
214 * "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyGenerator">
215 * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
216 * for information about standard algorithm names.
217 *
218 * @return the new {@code KeyGenerator} object.
219 *
220 * @exception NullPointerException if the specified algorithm is null.
221 *
222 * @exception NoSuchAlgorithmException if no Provider supports a
223 * KeyGeneratorSpi implementation for the
224 * specified algorithm.
225 *
226 * @see java.security.Provider
227 */
|
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
187 */
188 public final String getAlgorithm() {
189 return this.algorithm;
190 }
191
192 /**
193 * Returns a {@code KeyGenerator} object that generates secret keys
194 * for the specified algorithm.
195 *
196 * <p> This method traverses the list of registered security Providers,
197 * starting with the most preferred Provider.
198 * A new KeyGenerator object encapsulating the
199 * KeyGeneratorSpi implementation from the first
200 * Provider that supports the specified algorithm is returned.
201 *
202 * <p> Note that the list of registered providers may be retrieved via
203 * the {@link Security#getProviders() Security.getProviders()} method.
204 *
205 * @implNote
206 * The JDK Reference Implementation additionally uses the
207 * {@code jdk.security.provider.preferred}
208 * {@link Security#getProperty(String) Security} property to determine
209 * the preferred provider order for the specified algorithm. This
210 * may be different than the order of providers returned by
211 * {@link Security#getProviders() Security.getProviders()}.
212 *
213 * @param algorithm the standard name of the requested key algorithm.
214 * See the KeyGenerator section in the <a href=
215 * "{@docRoot}/../technotes/guides/security/StandardNames.html#KeyGenerator">
216 * Java Cryptography Architecture Standard Algorithm Name Documentation</a>
217 * for information about standard algorithm names.
218 *
219 * @return the new {@code KeyGenerator} object.
220 *
221 * @exception NullPointerException if the specified algorithm is null.
222 *
223 * @exception NoSuchAlgorithmException if no Provider supports a
224 * KeyGeneratorSpi implementation for the
225 * specified algorithm.
226 *
227 * @see java.security.Provider
228 */
|