iaik.xml.crypto.dsig.keyinfo

Class KeyInfoFactory

java.lang.Object

javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

iaik.xml.crypto.dsig.keyinfo.KeyInfoFactory

public class KeyInfoFactory
extends KeyInfoFactory

An implementation of the KeyInfoFactory that supports the DOM XML representation and processing mechanism.

Constructor Summary

Constructors

Constructor and Description
KeyInfoFactory()

Method Summary

Modifier and Type	Method and Description
URIDereferencer	getURIDereferencer() Returns a reference to the URIDereferencer that is used by default to dereference URIs in RetrievalMethod objects.
boolean	isFeatureSupported(String arg0) Indicates whether a specified feature is supported.
KeyInfo	newKeyInfo(List content) Creates a KeyInfo containing the specified list of key information types.
KeyInfo	newKeyInfo(List content, String id) Creates a KeyInfo containing the specified list of key information types and optional id.
KeyName	newKeyName(String name) Creates a KeyName from the specified name.
KeyValue	newKeyValue(PublicKey key) Creates a KeyValue from the specified public key.
PGPData	newPGPData(byte[] keyId) Creates a PGPData from the specified PGP public key identifier.
PGPData	newPGPData(byte[] keyId, byte[] keyPacket, List other) Creates a PGPData from the specified PGP public key identifier, and optional key material packet and list of external elements.
PGPData	newPGPData(byte[] keyPacket, List other) Creates a PGPData from the specified PGP key material packet and optional list of external elements.
RetrievalMethod	newRetrievalMethod(String uri) Creates a RetrievalMethod from the specified URI.
RetrievalMethod	newRetrievalMethod(String uri, String type, List transforms) Creates a RetrievalMethod from the specified parameters.
X509Data	newX509Data(List content) Creates a X509Data containing the specified list of X.509 content.
X509IssuerSerial	newX509IssuerSerial(String issuerName, BigInteger serialNumber) Creates an X509IssuerSerial from the specified X.500 issuer distinguished name and serial number.
KeyInfo	unmarshalKeyInfo(XMLStructure xmlStructure) Unmarshals a new KeyInfo instance from a mechanism-specific XMLStructure (ex: DOMStructure) instance.

Methods inherited from class javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

getInstance, getInstance, getInstance, getInstance, getMechanismType, getProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyInfoFactory

public KeyInfoFactory()

Method Detail

newKeyInfo

public KeyInfo newKeyInfo(List content)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a KeyInfo containing the specified list of key information types.

Specified by:

newKeyInfo in class KeyInfoFactory

Parameters:

content - a list of one or more XMLStructures representing key information types. The list is defensively copied to protect against subsequent modification.

Returns:

a KeyInfo

See Also:

KeyInfoFactory.newKeyInfo(java.util.List)

newKeyInfo

public KeyInfo newKeyInfo(List content,
                          String id)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a KeyInfo containing the specified list of key information types and optional id. The id parameter represents the value of an XML ID attribute and is useful for referencing the KeyInfo from other XML structures.

Specified by:

newKeyInfo in class KeyInfoFactory

Parameters:

content - a list of one or more XMLStructures representing key information types. The list is defensively copied to protect against subsequent modification.

id - the value of an XML ID (may be null)

Returns:

a KeyInfo

See Also:

KeyInfoFactory.newKeyInfo(java.util.List, java.lang.String)

newKeyName

public KeyName newKeyName(String name)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a KeyName from the specified name.

Specified by:

newKeyName in class KeyInfoFactory

Parameters:

name - the name that identifies the key

Returns:

a KeyName

See Also:

KeyInfoFactory.newKeyName(java.lang.String)

newKeyValue

public KeyValue newKeyValue(PublicKey key)
                     throws KeyException

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a KeyValue from the specified public key.

Specified by:

newKeyValue in class KeyInfoFactory

Parameters:

key - the public key

Returns:

a KeyValue

Throws:

KeyException - if the key's algorithm is not recognized or supported by this KeyInfoFactory

See Also:

KeyInfoFactory.newKeyValue(java.security.PublicKey)

newPGPData

public PGPData newPGPData(byte[] keyId)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a PGPData from the specified PGP public key identifier.

Specified by:

newPGPData in class KeyInfoFactory

Parameters:

keyId - a PGP public key identifier as defined in RFC 2440 , section 11.2. The array is cloned to protect against subsequent modification.

Returns:

a PGPData

See Also:

KeyInfoFactory.newPGPData(byte[])

newPGPData

public PGPData newPGPData(byte[] keyId,
                          byte[] keyPacket,
                          List other)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a PGPData from the specified PGP public key identifier, and optional key material packet and list of external elements.

Specified by:

newPGPData in class KeyInfoFactory

Parameters:

keyId - a PGP public key identifier as defined in RFC 2440 , section 11.2. The array is cloned to protect against subsequent modification.

keyPacket - a PGP key material packet as defined in RFC 2440 , section 5.5. The array is cloned to protect against subsequent modification. May be null.

other - a list of XMLStructures representing elements from an external namespace. The list is defensively copied to protect against subsequent modification. May be null or empty.

Returns:

a PGPData

See Also:

KeyInfoFactory.newPGPData(byte[], byte[], java.util.List)

newPGPData

public PGPData newPGPData(byte[] keyPacket,
                          List other)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a PGPData from the specified PGP key material packet and optional list of external elements.

Specified by:

newPGPData in class KeyInfoFactory

Parameters:

keyPacket - a PGP key material packet as defined in RFC 2440 , section 5.5. The array is cloned to protect against subsequent modification.

other - a list of XMLStructures representing elements from an external namespace. The list is defensively copied to protect against subsequent modification. May be null or empty.

Returns:

a PGPData

See Also:

KeyInfoFactory.newPGPData(byte[], java.util.List)

newRetrievalMethod

public RetrievalMethod newRetrievalMethod(String uri)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a RetrievalMethod from the specified URI.

Specified by:

newRetrievalMethod in class KeyInfoFactory

Parameters:

uri - the URI that identifies the KeyInfo information to be retrieved

Returns:

a RetrievalMethod

See Also:

KeyInfoFactory.newRetrievalMethod(java.lang.String)

newRetrievalMethod

public RetrievalMethod newRetrievalMethod(String uri,
                                          String type,
                                          List transforms)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a RetrievalMethod from the specified parameters.

Specified by:

newRetrievalMethod in class KeyInfoFactory

Parameters:

uri - the URI that identifies the KeyInfo information to be retrieved

type - a URI that identifies the type of KeyInfo information to be retrieved (may be null)

transforms - a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null or empty.

Returns:

a RetrievalMethod

See Also:

KeyInfoFactory.newRetrievalMethod(java.lang.String, java.lang.String, java.util.List)

newX509Data

public X509Data newX509Data(List content)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates a X509Data containing the specified list of X.509 content.

Specified by:

newX509Data in class KeyInfoFactory

Parameters:

content - a list of one or more X.509 content types. Valid types are String(subject names), byte[] (subject key ids), X509CRL, or X509IssuerSerialobjects or elements from an external namespace). Subject names are distinguished names in RFC 2253 String format. Implementations MUST support the attribute type keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC and UID). Implementations MAY support additional keywords. The list is defensively copied to protect against subsequent modification.

Returns:

a X509Data

See Also:

KeyInfoFactory.newX509Data(java.util.List)

newX509IssuerSerial

public X509IssuerSerial newX509IssuerSerial(String issuerName,
                                            BigInteger serialNumber)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Creates an X509IssuerSerial from the specified X.500 issuer distinguished name and serial number.

Specified by:

newX509IssuerSerial in class KeyInfoFactory

Parameters:

issuerName - the issuer's distinguished name in RFC 2253 String format. Implementations MUST support the attribute type keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC and UID). Implementations MAY support additional keywords.

serialNumber - the serial number

Returns:

an X509IssuerSerial

See Also:

KeyInfoFactory.newX509IssuerSerial(java.lang.String, java.math.BigInteger)

isFeatureSupported

public boolean isFeatureSupported(String arg0)

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Indicates whether a specified feature is supported.

Specified by:

isFeatureSupported in class KeyInfoFactory

Parameters:

arg0 - the feature name (as an absolute URI)

Returns:

true if the specified feature is supported, false otherwise

See Also:

KeyInfoFactory.isFeatureSupported(java.lang.String)

getURIDereferencer

public URIDereferencer getURIDereferencer()

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Returns a reference to the URIDereferencer that is used by default to dereference URIs in RetrievalMethod objects.

Specified by:

getURIDereferencer in class KeyInfoFactory

Returns:

a reference to the default URIDereferencer

See Also:

KeyInfoFactory.getURIDereferencer()

unmarshalKeyInfo

public KeyInfo unmarshalKeyInfo(XMLStructure xmlStructure)
                         throws MarshalException

Description copied from class: javax.xml.crypto.dsig.keyinfo.KeyInfoFactory

Unmarshals a new KeyInfo instance from a mechanism-specific XMLStructure (ex: DOMStructure) instance.

Specified by:

unmarshalKeyInfo in class KeyInfoFactory

Parameters:

xmlStructure - a mechanism-specific XML structure from which to unmarshal the keyinfo from

Returns:

the KeyInfo

Throws:

MarshalException - if an unrecoverable exception occurs during unmarshalling

See Also:

KeyInfoFactory.unmarshalKeyInfo(javax.xml.crypto.XMLStructure)