8019539: Fix doclint errors in java.security and its subpackages
Reviewed-by: darcy
This commit is contained in:
parent
a0fa326cb4
commit
200428aa69
@ -227,15 +227,13 @@ public class KeyStore {
|
|||||||
* {@link #store(KeyStore.LoadStoreParameter) store} operations.
|
* {@link #store(KeyStore.LoadStoreParameter) store} operations.
|
||||||
* <p>
|
* <p>
|
||||||
* The following syntax is supported for configuration data:
|
* The following syntax is supported for configuration data:
|
||||||
* <pre>
|
* <pre>{@code
|
||||||
*
|
|
||||||
* domain <domainName> [<property> ...] {
|
* domain <domainName> [<property> ...] {
|
||||||
* keystore <keystoreName> [<property> ...] ;
|
* keystore <keystoreName> [<property> ...] ;
|
||||||
* ...
|
* ...
|
||||||
* };
|
* };
|
||||||
* ...
|
* ...
|
||||||
*
|
* }</pre>
|
||||||
* </pre>
|
|
||||||
* where {@code domainName} and {@code keystoreName} are identifiers
|
* where {@code domainName} and {@code keystoreName} are identifiers
|
||||||
* and {@code property} is a key/value pairing. The key and value are
|
* and {@code property} is a key/value pairing. The key and value are
|
||||||
* separated by an 'equals' symbol and the value is enclosed in double
|
* separated by an 'equals' symbol and the value is enclosed in double
|
||||||
|
@ -67,6 +67,7 @@ import java.lang.reflect.*;
|
|||||||
* or modified by applications.
|
* or modified by applications.
|
||||||
* The following attributes are automatically placed in each Provider object:
|
* The following attributes are automatically placed in each Provider object:
|
||||||
* <table cellspacing=4>
|
* <table cellspacing=4>
|
||||||
|
* <caption><b>Attributes Automatically Placed in a Provider Object</b></caption>
|
||||||
* <tr><th>Name</th><th>Value</th>
|
* <tr><th>Name</th><th>Value</th>
|
||||||
* <tr><td>{@code Provider.id name}</td>
|
* <tr><td>{@code Provider.id name}</td>
|
||||||
* <td>{@code String.valueOf(provider.getName())}</td>
|
* <td>{@code String.valueOf(provider.getName())}</td>
|
||||||
|
@ -480,8 +480,8 @@ public final class Security {
|
|||||||
* Returns an array containing all installed providers that satisfy the
|
* Returns an array containing all installed providers that satisfy the
|
||||||
* specified selection criterion, or null if no such providers have been
|
* specified selection criterion, or null if no such providers have been
|
||||||
* installed. The returned providers are ordered
|
* installed. The returned providers are ordered
|
||||||
* according to their <a href=
|
* according to their
|
||||||
* "#insertProviderAt(java.security.Provider, int)">preference order</a>.
|
* {@linkplain #insertProviderAt(java.security.Provider, int) preference order}.
|
||||||
*
|
*
|
||||||
* <p> A cryptographic service is always associated with a particular
|
* <p> A cryptographic service is always associated with a particular
|
||||||
* algorithm or type. For example, a digital signature service is
|
* algorithm or type. For example, a digital signature service is
|
||||||
@ -492,8 +492,8 @@ public final class Security {
|
|||||||
* <p>The selection criterion must be specified in one of the following two
|
* <p>The selection criterion must be specified in one of the following two
|
||||||
* formats:
|
* formats:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li> <i><crypto_service>.<algorithm_or_type></i> <p> The
|
* <li> <i>{@literal <crypto_service>.<algorithm_or_type>}</i>
|
||||||
* cryptographic service name must not contain any dots.
|
* <p> The cryptographic service name must not contain any dots.
|
||||||
* <p> A
|
* <p> A
|
||||||
* provider satisfies the specified selection criterion iff the provider
|
* provider satisfies the specified selection criterion iff the provider
|
||||||
* implements the
|
* implements the
|
||||||
@ -501,11 +501,12 @@ public final class Security {
|
|||||||
* <p> For example, "CertificateFactory.X.509"
|
* <p> For example, "CertificateFactory.X.509"
|
||||||
* would be satisfied by any provider that supplied
|
* would be satisfied by any provider that supplied
|
||||||
* a CertificateFactory implementation for X.509 certificates.
|
* a CertificateFactory implementation for X.509 certificates.
|
||||||
* <li> <i><crypto_service>.<algorithm_or_type>
|
* <li> <i>{@literal <crypto_service>.<algorithm_or_type>
|
||||||
* <attribute_name>:< attribute_value></i>
|
* <attribute_name>:<attribute_value>}</i>
|
||||||
* <p> The cryptographic service name must not contain any dots. There
|
* <p> The cryptographic service name must not contain any dots. There
|
||||||
* must be one or more space charaters between the
|
* must be one or more space charaters between the
|
||||||
* <i><algorithm_or_type></i> and the <i><attribute_name></i>.
|
* <i>{@literal <algorithm_or_type>}</i> and the
|
||||||
|
* <i>{@literal <attribute_name>}</i>.
|
||||||
* <p> A provider satisfies this selection criterion iff the
|
* <p> A provider satisfies this selection criterion iff the
|
||||||
* provider implements the specified algorithm or type for the specified
|
* provider implements the specified algorithm or type for the specified
|
||||||
* cryptographic service and its implementation meets the
|
* cryptographic service and its implementation meets the
|
||||||
@ -558,8 +559,9 @@ public final class Security {
|
|||||||
* Returns an array containing all installed providers that satisfy the
|
* Returns an array containing all installed providers that satisfy the
|
||||||
* specified* selection criteria, or null if no such providers have been
|
* specified* selection criteria, or null if no such providers have been
|
||||||
* installed. The returned providers are ordered
|
* installed. The returned providers are ordered
|
||||||
* according to their <a href=
|
* according to their
|
||||||
* "#insertProviderAt(java.security.Provider, int)">preference order</a>.
|
* {@linkplain #insertProviderAt(java.security.Provider, int)
|
||||||
|
* preference order}.
|
||||||
*
|
*
|
||||||
* <p>The selection criteria are represented by a map.
|
* <p>The selection criteria are represented by a map.
|
||||||
* Each map entry represents a selection criterion.
|
* Each map entry represents a selection criterion.
|
||||||
@ -567,16 +569,18 @@ public final class Security {
|
|||||||
* criteria. The key for any entry in such a map must be in one of the
|
* criteria. The key for any entry in such a map must be in one of the
|
||||||
* following two formats:
|
* following two formats:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li> <i><crypto_service>.<algorithm_or_type></i>
|
* <li> <i>{@literal <crypto_service>.<algorithm_or_type>}</i>
|
||||||
* <p> The cryptographic service name must not contain any dots.
|
* <p> The cryptographic service name must not contain any dots.
|
||||||
* <p> The value associated with the key must be an empty string.
|
* <p> The value associated with the key must be an empty string.
|
||||||
* <p> A provider
|
* <p> A provider
|
||||||
* satisfies this selection criterion iff the provider implements the
|
* satisfies this selection criterion iff the provider implements the
|
||||||
* specified algorithm or type for the specified cryptographic service.
|
* specified algorithm or type for the specified cryptographic service.
|
||||||
* <li> <i><crypto_service>.<algorithm_or_type> <attribute_name></i>
|
* <li> <i>{@literal <crypto_service>}.
|
||||||
|
* {@literal <algorithm_or_type> <attribute_name>}</i>
|
||||||
* <p> The cryptographic service name must not contain any dots. There
|
* <p> The cryptographic service name must not contain any dots. There
|
||||||
* must be one or more space charaters between the <i><algorithm_or_type></i>
|
* must be one or more space charaters between the
|
||||||
* and the <i><attribute_name></i>.
|
* <i>{@literal <algorithm_or_type>}</i>
|
||||||
|
* and the <i>{@literal <attribute_name>}</i>.
|
||||||
* <p> The value associated with the key must be a non-empty string.
|
* <p> The value associated with the key must be a non-empty string.
|
||||||
* A provider satisfies this selection criterion iff the
|
* A provider satisfies this selection criterion iff the
|
||||||
* provider implements the specified algorithm or type for the specified
|
* provider implements the specified algorithm or type for the specified
|
||||||
|
@ -249,7 +249,8 @@ public abstract class X509CRL extends CRL implements X509Extension {
|
|||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* version Version OPTIONAL,
|
* version Version OPTIONAL,
|
||||||
* -- if present, must be v2<p>
|
* -- if present, must be v2
|
||||||
|
*
|
||||||
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
|
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
|
||||||
* -- v3 does not apply to CRLs but appears for consistency
|
* -- v3 does not apply to CRLs but appears for consistency
|
||||||
* -- with definition of Version for certs
|
* -- with definition of Version for certs
|
||||||
@ -413,7 +414,8 @@ public abstract class X509CRL extends CRL implements X509Extension {
|
|||||||
* signature algorithm. An example is the string "SHA256withRSA".
|
* signature algorithm. An example is the string "SHA256withRSA".
|
||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* signatureAlgorithm AlgorithmIdentifier<p>
|
* signatureAlgorithm AlgorithmIdentifier
|
||||||
|
*
|
||||||
* AlgorithmIdentifier ::= SEQUENCE {
|
* AlgorithmIdentifier ::= SEQUENCE {
|
||||||
* algorithm OBJECT IDENTIFIER,
|
* algorithm OBJECT IDENTIFIER,
|
||||||
* parameters ANY DEFINED BY algorithm OPTIONAL }
|
* parameters ANY DEFINED BY algorithm OPTIONAL }
|
||||||
|
@ -43,11 +43,11 @@ import sun.security.x509.X509CRLEntryImpl;
|
|||||||
* crlEntryExtensions Extensions OPTIONAL
|
* crlEntryExtensions Extensions OPTIONAL
|
||||||
* -- if present, must be v2
|
* -- if present, must be v2
|
||||||
* } OPTIONAL
|
* } OPTIONAL
|
||||||
*<p>
|
*
|
||||||
* CertificateSerialNumber ::= INTEGER
|
* CertificateSerialNumber ::= INTEGER
|
||||||
*<p>
|
*
|
||||||
* Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
|
* Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
|
||||||
*<p>
|
*
|
||||||
* Extension ::= SEQUENCE {
|
* Extension ::= SEQUENCE {
|
||||||
* extnId OBJECT IDENTIFIER,
|
* extnId OBJECT IDENTIFIER,
|
||||||
* critical BOOLEAN DEFAULT FALSE,
|
* critical BOOLEAN DEFAULT FALSE,
|
||||||
|
@ -126,10 +126,12 @@ implements X509Extension {
|
|||||||
* is valid. It is defined in
|
* is valid. It is defined in
|
||||||
* ASN.1 as:
|
* ASN.1 as:
|
||||||
* <pre>
|
* <pre>
|
||||||
* validity Validity<p>
|
* validity Validity
|
||||||
|
*
|
||||||
* Validity ::= SEQUENCE {
|
* Validity ::= SEQUENCE {
|
||||||
* notBefore CertificateValidityDate,
|
* notBefore CertificateValidityDate,
|
||||||
* notAfter CertificateValidityDate }<p>
|
* notAfter CertificateValidityDate }
|
||||||
|
*
|
||||||
* CertificateValidityDate ::= CHOICE {
|
* CertificateValidityDate ::= CHOICE {
|
||||||
* utcTime UTCTime,
|
* utcTime UTCTime,
|
||||||
* generalTime GeneralizedTime }
|
* generalTime GeneralizedTime }
|
||||||
@ -165,7 +167,8 @@ implements X509Extension {
|
|||||||
* certificate.
|
* certificate.
|
||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* version [0] EXPLICIT Version DEFAULT v1<p>
|
* version [0] EXPLICIT Version DEFAULT v1
|
||||||
|
*
|
||||||
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
|
* Version ::= INTEGER { v1(0), v2(1), v3(2) }
|
||||||
* </pre>
|
* </pre>
|
||||||
* @return the version number, i.e. 1, 2 or 3.
|
* @return the version number, i.e. 1, 2 or 3.
|
||||||
@ -180,7 +183,7 @@ implements X509Extension {
|
|||||||
* serial number identify a unique certificate).
|
* serial number identify a unique certificate).
|
||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* serialNumber CertificateSerialNumber<p>
|
* serialNumber CertificateSerialNumber
|
||||||
*
|
*
|
||||||
* CertificateSerialNumber ::= INTEGER
|
* CertificateSerialNumber ::= INTEGER
|
||||||
* </pre>
|
* </pre>
|
||||||
@ -204,7 +207,7 @@ implements X509Extension {
|
|||||||
* X.500 distinguished name (DN).
|
* X.500 distinguished name (DN).
|
||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* issuer Name<p>
|
* issuer Name
|
||||||
*
|
*
|
||||||
* Name ::= CHOICE { RDNSequence }
|
* Name ::= CHOICE { RDNSequence }
|
||||||
* RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
|
* RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
|
||||||
@ -295,11 +298,12 @@ implements X509Extension {
|
|||||||
* the certificate.
|
* the certificate.
|
||||||
* The relevant ASN.1 definitions are:
|
* The relevant ASN.1 definitions are:
|
||||||
* <pre>
|
* <pre>
|
||||||
* validity Validity<p>
|
* validity Validity
|
||||||
*
|
*
|
||||||
* Validity ::= SEQUENCE {
|
* Validity ::= SEQUENCE {
|
||||||
* notBefore CertificateValidityDate,
|
* notBefore CertificateValidityDate,
|
||||||
* notAfter CertificateValidityDate }<p>
|
* notAfter CertificateValidityDate }
|
||||||
|
*
|
||||||
* CertificateValidityDate ::= CHOICE {
|
* CertificateValidityDate ::= CHOICE {
|
||||||
* utcTime UTCTime,
|
* utcTime UTCTime,
|
||||||
* generalTime GeneralizedTime }
|
* generalTime GeneralizedTime }
|
||||||
@ -348,7 +352,8 @@ implements X509Extension {
|
|||||||
* signature algorithm. An example is the string "SHA256withRSA".
|
* signature algorithm. An example is the string "SHA256withRSA".
|
||||||
* The ASN.1 definition for this is:
|
* The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* signatureAlgorithm AlgorithmIdentifier<p>
|
* signatureAlgorithm AlgorithmIdentifier
|
||||||
|
*
|
||||||
* AlgorithmIdentifier ::= SEQUENCE {
|
* AlgorithmIdentifier ::= SEQUENCE {
|
||||||
* algorithm OBJECT IDENTIFIER,
|
* algorithm OBJECT IDENTIFIER,
|
||||||
* parameters ANY DEFINED BY algorithm OPTIONAL }
|
* parameters ANY DEFINED BY algorithm OPTIONAL }
|
||||||
@ -410,7 +415,8 @@ implements X509Extension {
|
|||||||
*
|
*
|
||||||
* <p>The ASN.1 definition for this is:
|
* <p>The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* issuerUniqueID [1] IMPLICIT UniqueIdentifier OPTIONAL<p>
|
* issuerUniqueID [1] IMPLICIT UniqueIdentifier OPTIONAL
|
||||||
|
*
|
||||||
* UniqueIdentifier ::= BIT STRING
|
* UniqueIdentifier ::= BIT STRING
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
@ -424,7 +430,8 @@ implements X509Extension {
|
|||||||
*
|
*
|
||||||
* <p>The ASN.1 definition for this is:
|
* <p>The ASN.1 definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* subjectUniqueID [2] IMPLICIT UniqueIdentifier OPTIONAL<p>
|
* subjectUniqueID [2] IMPLICIT UniqueIdentifier OPTIONAL
|
||||||
|
*
|
||||||
* UniqueIdentifier ::= BIT STRING
|
* UniqueIdentifier ::= BIT STRING
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
@ -474,9 +481,9 @@ implements X509Extension {
|
|||||||
* indicated in the key usage extension field. The ASN.1
|
* indicated in the key usage extension field. The ASN.1
|
||||||
* definition for this is:
|
* definition for this is:
|
||||||
* <pre>
|
* <pre>
|
||||||
* ExtKeyUsageSyntax ::= SEQUENCE SIZE (1..MAX) OF KeyPurposeId<p>
|
* ExtKeyUsageSyntax ::= SEQUENCE SIZE (1..MAX) OF KeyPurposeId
|
||||||
*
|
*
|
||||||
* KeyPurposeId ::= OBJECT IDENTIFIER<p>
|
* KeyPurposeId ::= OBJECT IDENTIFIER
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* Key purposes may be defined by any organization with a
|
* Key purposes may be defined by any organization with a
|
||||||
|
Loading…
x
Reference in New Issue
Block a user