Package org.mozilla.jss.netscape.security.x509

Interface CertAttrSet

All Known Implementing Classes:

ACertAttrSet, AuthInfoAccessExtension, AuthorityKeyIdentifierExtension, BasicConstraintsExtension, CertificateAlgorithmId, CertificateExtensions, CertificateIssuerExtension, CertificateIssuerName, CertificateIssuerUniqueIdentity, CertificatePoliciesExtension, CertificateRenewalWindowExtension, CertificateScopeOfUseExtension, CertificateSerialNumber, CertificateSubjectName, CertificateSubjectUniqueIdentity, CertificateValidity, CertificateVersion, CertificateX509Key, CertInfo, CRLDistributionPointsExtension, CRLNumberExtension, CRLReasonExtension, DeltaCRLIndicatorExtension, ExtendedKeyUsageExtension, Extensions, FreshestCRLExtension, GenericASN1Extension, HoldInstructionExtension, InhibitAnyPolicyExtension, InvalidityDateExtension, IssuerAlternativeNameExtension, IssuingDistributionPointExtension, KeyUsageExtension, NameConstraintsExtension, NSCCommentExtension, NSCertTypeExtension, OCSPNoCheckExtension, PolicyConstraintsExtension, PolicyMappingsExtension, PresenceServerExtension, PrivateKeyUsageExtension, SubjectAlternativeNameExtension, SubjectDirAttributesExtension, SubjectInfoAccessExtension, SubjectKeyIdentifierExtension, X509CertInfo

public interface CertAttrSet

This interface defines the methods required of a certificate attribute. Examples of X.509 certificate attributes are Validity, Issuer_Name, and Subject Name. A CertAttrSet may compromise one attribute or many attributes.

A CertAttrSet itself can also be comprised of other sub-sets. In the case of X.509 V3 certificates, for example, the "extensions" attribute has subattributes, such as those for KeyUsage and AuthorityKeyIdentifier.

See Also:

CertificateException

Method Summary

Modifier and Type	Method	Description
void	decode(java.io.InputStream in)	Decodes the attribute in the input stream.
void	delete(java.lang.String name)	Deletes an attribute value from this CertAttrSet.
void	encode(java.io.OutputStream out)	Encodes the attribute to the output stream in a format that can be parsed by the decode method.
java.lang.Object	get(java.lang.String name)	Gets an attribute value for this CertAttrSet.
java.util.Enumeration<java.lang.String>	getAttributeNames()	Returns an enumeration of the names of the attributes existing within this attribute.
java.lang.String	getName()	Returns the name (identifier) of this CertAttrSet.
void	set(java.lang.String name, java.lang.Object obj)	Sets an attribute value within this CertAttrSet.
java.lang.String	toString()	Returns a short string describing this certificate attribute.

Method Detail

toString

java.lang.String toString()

Returns a short string describing this certificate attribute.

Overrides:

toString in class java.lang.Object

Returns:

value of this certificate attribute in printable form.

encode

void encode(java.io.OutputStream out)
     throws java.security.cert.CertificateException,
            java.io.IOException

Encodes the attribute to the output stream in a format that can be parsed by the decode method.

Parameters:

out - the OutputStream to encode the attribute to.

Throws:

java.security.cert.CertificateException - on encoding or validity errors.

java.io.IOException - on other errors.

decode

void decode(java.io.InputStream in)
     throws java.security.cert.CertificateException,
            java.io.IOException

Decodes the attribute in the input stream.

Parameters:

in - the InputStream to read the encoded attribute from.

Throws:

java.security.cert.CertificateException - on decoding or validity errors.

java.io.IOException - on other errors.

set

void set(java.lang.String name,
         java.lang.Object obj)
  throws java.security.cert.CertificateException,
         java.io.IOException

Sets an attribute value within this CertAttrSet.

Parameters:

name - the name of the attribute (e.g. "x509.info.key")

obj - the attribute object.

Throws:

java.security.cert.CertificateException - on attribute handling errors.

java.io.IOException - on other errors.

get

java.lang.Object get(java.lang.String name)
              throws java.security.cert.CertificateException,
                     java.io.IOException

Gets an attribute value for this CertAttrSet.

Parameters:

name - the name of the attribute to return.

Throws:

java.security.cert.CertificateException - on attribute handling errors.

java.io.IOException - on other errors.

delete

void delete(java.lang.String name)
     throws java.security.cert.CertificateException,
            java.io.IOException

Deletes an attribute value from this CertAttrSet.

Parameters:

name - the name of the attribute to delete.

Throws:

java.security.cert.CertificateException - on attribute handling errors.

java.io.IOException - on other errors.

getAttributeNames

java.util.Enumeration<java.lang.String> getAttributeNames()

Returns an enumeration of the names of the attributes existing within this attribute.

Returns:

an enumeration of the attribute names.

getName

java.lang.String getName()

Returns the name (identifier) of this CertAttrSet.

Returns:

the name of this CertAttrSet.