24 */ |
24 */ |
25 |
25 |
26 package java.security.cert; |
26 package java.security.cert; |
27 |
27 |
28 /** |
28 /** |
29 * A specification of <code>CertStore</code> parameters. |
29 * A specification of {@code CertStore} parameters. |
30 * <p> |
30 * <p> |
31 * The purpose of this interface is to group (and provide type safety for) |
31 * The purpose of this interface is to group (and provide type safety for) |
32 * all <code>CertStore</code> parameter specifications. All |
32 * all {@code CertStore} parameter specifications. All |
33 * <code>CertStore</code> parameter specifications must implement this |
33 * {@code CertStore} parameter specifications must implement this |
34 * interface. |
34 * interface. |
35 * <p> |
35 * <p> |
36 * Typically, a <code>CertStoreParameters</code> object is passed as a parameter |
36 * Typically, a {@code CertStoreParameters} object is passed as a parameter |
37 * to one of the {@link CertStore#getInstance CertStore.getInstance} methods. |
37 * to one of the {@link CertStore#getInstance CertStore.getInstance} methods. |
38 * The <code>getInstance</code> method returns a <code>CertStore</code> that |
38 * The {@code getInstance} method returns a {@code CertStore} that |
39 * is used for retrieving <code>Certificate</code>s and <code>CRL</code>s. The |
39 * is used for retrieving {@code Certificate}s and {@code CRL}s. The |
40 * <code>CertStore</code> that is returned is initialized with the specified |
40 * {@code CertStore} that is returned is initialized with the specified |
41 * parameters. The type of parameters needed may vary between different types |
41 * parameters. The type of parameters needed may vary between different types |
42 * of <code>CertStore</code>s. |
42 * of {@code CertStore}s. |
43 * |
43 * |
44 * @see CertStore#getInstance |
44 * @see CertStore#getInstance |
45 * |
45 * |
46 * @since 1.4 |
46 * @since 1.4 |
47 * @author Steve Hanna |
47 * @author Steve Hanna |
48 */ |
48 */ |
49 public interface CertStoreParameters extends Cloneable { |
49 public interface CertStoreParameters extends Cloneable { |
50 |
50 |
51 /** |
51 /** |
52 * Makes a copy of this <code>CertStoreParameters</code>. |
52 * Makes a copy of this {@code CertStoreParameters}. |
53 * <p> |
53 * <p> |
54 * The precise meaning of "copy" may depend on the class of |
54 * The precise meaning of "copy" may depend on the class of |
55 * the <code>CertStoreParameters</code> object. A typical implementation |
55 * the {@code CertStoreParameters} object. A typical implementation |
56 * performs a "deep copy" of this object, but this is not an absolute |
56 * performs a "deep copy" of this object, but this is not an absolute |
57 * requirement. Some implementations may perform a "shallow copy" of some |
57 * requirement. Some implementations may perform a "shallow copy" of some |
58 * or all of the fields of this object. |
58 * or all of the fields of this object. |
59 * <p> |
59 * <p> |
60 * Note that the <code>CertStore.getInstance</code> methods make a copy |
60 * Note that the {@code CertStore.getInstance} methods make a copy |
61 * of the specified <code>CertStoreParameters</code>. A deep copy |
61 * of the specified {@code CertStoreParameters}. A deep copy |
62 * implementation of <code>clone</code> is safer and more robust, as it |
62 * implementation of {@code clone} is safer and more robust, as it |
63 * prevents the caller from corrupting a shared <code>CertStore</code> by |
63 * prevents the caller from corrupting a shared {@code CertStore} by |
64 * subsequently modifying the contents of its initialization parameters. |
64 * subsequently modifying the contents of its initialization parameters. |
65 * However, a shallow copy implementation of <code>clone</code> is more |
65 * However, a shallow copy implementation of {@code clone} is more |
66 * appropriate for applications that need to hold a reference to a |
66 * appropriate for applications that need to hold a reference to a |
67 * parameter contained in the <code>CertStoreParameters</code>. For example, |
67 * parameter contained in the {@code CertStoreParameters}. For example, |
68 * a shallow copy clone allows an application to release the resources of |
68 * a shallow copy clone allows an application to release the resources of |
69 * a particular <code>CertStore</code> initialization parameter immediately, |
69 * a particular {@code CertStore} initialization parameter immediately, |
70 * rather than waiting for the garbage collection mechanism. This should |
70 * rather than waiting for the garbage collection mechanism. This should |
71 * be done with the utmost care, since the <code>CertStore</code> may still |
71 * be done with the utmost care, since the {@code CertStore} may still |
72 * be in use by other threads. |
72 * be in use by other threads. |
73 * <p> |
73 * <p> |
74 * Each subclass should state the precise behavior of this method so |
74 * Each subclass should state the precise behavior of this method so |
75 * that users and developers know what to expect. |
75 * that users and developers know what to expect. |
76 * |
76 * |
77 * @return a copy of this <code>CertStoreParameters</code> |
77 * @return a copy of this {@code CertStoreParameters} |
78 */ |
78 */ |
79 Object clone(); |
79 Object clone(); |
80 } |
80 } |