File	Doc	Category	Size	Date	Package
KeyInfoFactory.java	API Doc	Java SE 6 API	22644	Tue Jun 10 00:27:06 BST 2008	javax.xml.crypto.dsig.keyinfo

KeyInfoFactory

• java.lang.Object

put("KeyInfoFactory.DOM", "org.example.DOMKeyInfoFactory");

Fields Summary
private String	mechanismType
private Provider	provider

Constructors Summary
protected KeyInfoFactory() Default constructor, for invocation by subclasses.

Methods Summary
public static javax.xml.crypto.dsig.keyinfo.KeyInfoFactory	getInstance(java.lang.String mechanismType) Returns a KeyInfoFactory that supports the specified XML processing mechanism and representation type (ex: "DOM"). This method uses the standard JCA provider lookup mechanism to locate and instantiate a KeyInfoFactory implementation of the desired mechanism type. It traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyInfoFactory object from the first Provider that supports the specified mechanism is returned. Note that the list of registered providers may be retrieved via the {@link Security#getProviders() Security.getProviders()} method. param mechanismType the type of the XML processing mechanism and representation. See the Service Providers section of the API overview for a list of standard mechanism types. return a new KeyInfoFactory throws NullPointerException if mechanismType is null throws NoSuchMechanismException if no Provider supports a KeyInfoFactory implementation for the specified mechanism see Provider if (mechanismType == null) { throw new NullPointerException("mechanismType cannot be null"); } Instance instance; try { instance = GetInstance.getInstance ("KeyInfoFactory", null, mechanismType); } catch (NoSuchAlgorithmException nsae) { throw new NoSuchMechanismException(nsae); } KeyInfoFactory factory = (KeyInfoFactory) instance.impl; factory.mechanismType = mechanismType; factory.provider = instance.provider; return factory;
public static javax.xml.crypto.dsig.keyinfo.KeyInfoFactory	getInstance(java.lang.String mechanismType, java.security.Provider provider) Returns a KeyInfoFactory that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. Note that the specified Provider object does not have to be registered in the provider list. param mechanismType the type of the XML processing mechanism and representation. See the Service Providers section of the API overview for a list of standard mechanism types. param provider the Provider object return a new KeyInfoFactory throws NullPointerException if mechanismType or provider are null throws NoSuchMechanismException if a KeyInfoFactory implementation for the specified mechanism is not available from the specified Provider object see Provider if (mechanismType == null) { throw new NullPointerException("mechanismType cannot be null"); } else if (provider == null) { throw new NullPointerException("provider cannot be null"); } Instance instance; try { instance = GetInstance.getInstance ("KeyInfoFactory", null, mechanismType, provider); } catch (NoSuchAlgorithmException nsae) { throw new NoSuchMechanismException(nsae); } KeyInfoFactory factory = (KeyInfoFactory) instance.impl; factory.mechanismType = mechanismType; factory.provider = instance.provider; return factory;
public static javax.xml.crypto.dsig.keyinfo.KeyInfoFactory	getInstance(java.lang.String mechanismType, java.lang.String provider) Returns a KeyInfoFactory that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. The specified provider must be registered in the security provider list. Note that the list of registered providers may be retrieved via the {@link Security#getProviders() Security.getProviders()} method. param mechanismType the type of the XML processing mechanism and representation. See the Service Providers section of the API overview for a list of standard mechanism types. param provider the string name of the provider return a new KeyInfoFactory throws NoSuchProviderException if the specified provider is not registered in the security provider list throws NullPointerException if mechanismType or provider are null throws NoSuchMechanismException if a KeyInfoFactory implementation for the specified mechanism is not available from the specified provider see Provider if (mechanismType == null) { throw new NullPointerException("mechanismType cannot be null"); } else if (provider == null) { throw new NullPointerException("provider cannot be null"); } else if (provider.length() == 0) { throw new NoSuchProviderException(); } Instance instance; try { instance = GetInstance.getInstance ("KeyInfoFactory", null, mechanismType, provider); } catch (NoSuchAlgorithmException nsae) { throw new NoSuchMechanismException(nsae); } KeyInfoFactory factory = (KeyInfoFactory) instance.impl; factory.mechanismType = mechanismType; factory.provider = instance.provider; return factory;
public static javax.xml.crypto.dsig.keyinfo.KeyInfoFactory	getInstance() Returns a KeyInfoFactory that supports the default XML processing mechanism and representation type ("DOM"). This method uses the standard JCA provider lookup mechanism to locate and instantiate a KeyInfoFactory implementation of the default mechanism type. It traverses the list of registered security Providers, starting with the most preferred Provider. A new KeyInfoFactory object from the first Provider that supports the DOM mechanism is returned. Note that the list of registered providers may be retrieved via the {@link Security#getProviders() Security.getProviders()} method. return a new KeyInfoFactory throws NoSuchMechanismException if no Provider supports a KeyInfoFactory implementation for the DOM mechanism see Provider return getInstance("DOM");
public final java.lang.String	getMechanismType() Returns the type of the XML processing mechanism and representation supported by this KeyInfoFactory (ex: "DOM") return the XML processing mechanism type supported by this KeyInfoFactory return mechanismType;
public final java.security.Provider	getProvider() Returns the provider of this KeyInfoFactory. return the provider of this KeyInfoFactory return provider;
public abstract javax.xml.crypto.URIDereferencer	getURIDereferencer() Returns a reference to the URIDereferencer that is used by default to dereference URIs in {@link RetrievalMethod} objects. return a reference to the default URIDereferencer
public abstract boolean	isFeatureSupported(java.lang.String feature) Indicates whether a specified feature is supported. param feature the feature name (as an absolute URI) return true if the specified feature is supported, false otherwise throws NullPointerException if feature is null
public abstract javax.xml.crypto.dsig.keyinfo.KeyInfo	newKeyInfo(java.util.List content) Creates a KeyInfo containing the specified list of key information types. param content a list of one or more {@link XMLStructure}s representing key information types. The list is defensively copied to protect against subsequent modification. return a KeyInfo throws NullPointerException if content is null throws IllegalArgumentException if content is empty throws ClassCastException if content contains any entries that are not of type {@link XMLStructure}
public abstract javax.xml.crypto.dsig.keyinfo.KeyInfo	newKeyInfo(java.util.List content, java.lang.String id) 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. param content a list of one or more {@link XMLStructure}s representing key information types. The list is defensively copied to protect against subsequent modification. param id the value of an XML ID (may be null) return a KeyInfo throws NullPointerException if content is null throws IllegalArgumentException if content is empty throws ClassCastException if content contains any entries that are not of type {@link XMLStructure}
public abstract javax.xml.crypto.dsig.keyinfo.KeyName	newKeyName(java.lang.String name) Creates a KeyName from the specified name. param name the name that identifies the key return a KeyName throws NullPointerException if name is null
public abstract javax.xml.crypto.dsig.keyinfo.KeyValue	newKeyValue(java.security.PublicKey key) Creates a KeyValue from the specified public key. param key the public key return a KeyValue throws KeyException if the key's algorithm is not recognized or supported by this KeyInfoFactory throws NullPointerException if key is null
public abstract javax.xml.crypto.dsig.keyinfo.PGPData	newPGPData(byte[] keyId) Creates a PGPData from the specified PGP public key identifier. param keyId a PGP public key identifier as defined in RFC 2440, section 11.2. The array is cloned to protect against subsequent modification. return a PGPData throws NullPointerException if keyId is null throws IllegalArgumentException if the key id is not in the correct format
public abstract javax.xml.crypto.dsig.keyinfo.PGPData	newPGPData(byte[] keyId, byte[] keyPacket, java.util.List other) Creates a PGPData from the specified PGP public key identifier, and optional key material packet and list of external elements. param keyId a PGP public key identifier as defined in RFC 2440, section 11.2. The array is cloned to protect against subsequent modification. param 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. param other a list of {@link XMLStructure}s representing elements from an external namespace. The list is defensively copied to protect against subsequent modification. May be null or empty. return a PGPData throws NullPointerException if keyId is null throws IllegalArgumentException if the keyId or keyPacket is not in the correct format. For keyPacket, the format of the packet header is checked and the tag is verified that it is of type key material. The contents and format of the packet body are not checked. throws ClassCastException if other contains any entries that are not of type {@link XMLStructure}
public abstract javax.xml.crypto.dsig.keyinfo.PGPData	newPGPData(byte[] keyPacket, java.util.List other) Creates a PGPData from the specified PGP key material packet and optional list of external elements. param keyPacket a PGP key material packet as defined in RFC 2440, section 5.5. The array is cloned to protect against subsequent modification. param other a list of {@link XMLStructure}s representing elements from an external namespace. The list is defensively copied to protect against subsequent modification. May be null or empty. return a PGPData throws NullPointerException if keyPacket is null throws IllegalArgumentException if keyPacket is not in the correct format. For keyPacket, the format of the packet header is checked and the tag is verified that it is of type key material. The contents and format of the packet body are not checked. throws ClassCastException if other contains any entries that are not of type {@link XMLStructure}
public abstract javax.xml.crypto.dsig.keyinfo.RetrievalMethod	newRetrievalMethod(java.lang.String uri) Creates a RetrievalMethod from the specified URI. param uri the URI that identifies the KeyInfo information to be retrieved return a RetrievalMethod throws NullPointerException if uri is null throws IllegalArgumentException if uri is not RFC 2396 compliant
public abstract javax.xml.crypto.dsig.keyinfo.RetrievalMethod	newRetrievalMethod(java.lang.String uri, java.lang.String type, java.util.List transforms) Creates a RetrievalMethod from the specified parameters. param uri the URI that identifies the KeyInfo information to be retrieved param type a URI that identifies the type of KeyInfo information to be retrieved (may be null) param transforms a list of {@link Transform}s. The list is defensively copied to protect against subsequent modification. May be null or empty. return a RetrievalMethod throws NullPointerException if uri is null throws IllegalArgumentException if uri is not RFC 2396 compliant throws ClassCastException if transforms contains any entries that are not of type {@link Transform}
public abstract javax.xml.crypto.dsig.keyinfo.X509Data	newX509Data(java.util.List content) Creates a X509Data containing the specified list of X.509 content. param content a list of one or more X.509 content types. Valid types are {@link String} (subject names), byte[] (subject key ids), {@link java.security.cert.X509Certificate}, {@link X509CRL}, or {@link XMLStructure} ({@link X509IssuerSerial} objects 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. return a X509Data throws NullPointerException if content is null throws IllegalArgumentException if content is empty, or if a subject name is not RFC 2253 compliant or one of the attribute type keywords is not recognized. throws ClassCastException if content contains any entries that are not of one of the valid types mentioned above
public abstract javax.xml.crypto.dsig.keyinfo.X509IssuerSerial	newX509IssuerSerial(java.lang.String issuerName, java.math.BigInteger serialNumber) Creates an X509IssuerSerial from the specified X.500 issuer distinguished name and serial number. param 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. param serialNumber the serial number return an X509IssuerSerial throws NullPointerException if issuerName or serialNumber are null throws IllegalArgumentException if the issuer name is not RFC 2253 compliant or one of the attribute type keywords is not recognized.
public abstract javax.xml.crypto.dsig.keyinfo.KeyInfo	unmarshalKeyInfo(javax.xml.crypto.XMLStructure xmlStructure) Unmarshals a new KeyInfo instance from a mechanism-specific XMLStructure (ex: {@link DOMStructure}) instance. param xmlStructure a mechanism-specific XML structure from which to unmarshal the keyinfo from return the KeyInfo throws NullPointerException if xmlStructure is null throws ClassCastException if the type of xmlStructure is inappropriate for this factory throws MarshalException if an unrecoverable exception occurs during unmarshalling