org.apache.xml.security.encryption
Interface EncryptedType

All Known Subinterfaces:

EncryptedData, EncryptedKey

public interface EncryptedType

EncryptedType is the abstract type from which EncryptedData and EncryptedKey are derived. While these two latter element types are very similar with respect to their content models, a syntactical distinction is useful to processing.

Its schema definition is as follows:

<complexType name='EncryptedType' abstract='true'> <sequence> <element name='EncryptionMethod' type='xenc:EncryptionMethodType' minOccurs='0'/> <element ref='ds:KeyInfo' minOccurs='0'/> <element ref='xenc:CipherData'/> <element ref='xenc:EncryptionProperties' minOccurs='0'/> </sequence> <attribute name='Id' type='ID' use='optional'/> <attribute name='Type' type='anyURI' use='optional'/> <attribute name='MimeType' type='string' use='optional'/> <attribute name='Encoding' type='anyURI' use='optional'/> </complexType>

Author:

Axl Mattheus

Method Summary

CipherData	getCipherData() Returns the CipherReference that contains the CipherValue or CipherReference with the encrypted data.
java.lang.String	getEncoding() Retusn an URI representing the encoding of the EncryptedType.
EncryptionMethod	getEncryptionMethod() Returns an EncryptionMethod that describes the encryption algorithm applied to the cipher data.
EncryptionProperties	getEncryptionProperties() Returns additional information concerning the generation of the EncryptedType.
java.lang.String	getId() Returns a String providing for the standard method of assigning an id to the element within the document context.
KeyInfo	getKeyInfo() Returns the ds:KeyInfo, that carries information about the key used to encrypt the data.
java.lang.String	getMimeType() Returns a String which describes the media type of the data which has been encrypted.
java.lang.String	getType() Returns an URI identifying type information about the plaintext form of the encrypted content.
void	setEncoding(java.lang.String encoding) Sets the URI representing the encoding of the EncryptedType.
void	setEncryptionMethod(EncryptionMethod method) Sets the EncryptionMethod used to encrypt the cipher data.
void	setEncryptionProperties(EncryptionProperties properties) Sets the EncryptionProperties that supplies additional information about the generation of the EncryptedType.
void	setId(java.lang.String id) Sets the id.
void	setKeyInfo(KeyInfo info) Sets the encryption key information.
void	setMimeType(java.lang.String type) Sets the mime type.
void	setType(java.lang.String type) Sets the type.

Method Detail

getId

public java.lang.String getId()

Returns a String providing for the standard method of assigning an id to the element within the document context.

Returns:

the id for the EncryptedType.

setId

public void setId(java.lang.String id)

Sets the id.

getType

public java.lang.String getType()

Returns an URI identifying type information about the plaintext form of the encrypted content. While optional, this specification takes advantage of it for mandatory processing described in Processing Rules: Decryption (section 4.2). If the EncryptedData element contains data of Type 'element' or element 'content', and replaces that data in an XML document context, it is strongly recommended the Type attribute be provided. Without this information, the decryptor will be unable to automatically restore the XML document to its original cleartext form.

Returns:

the identifier for the type of information in plaintext form of encrypted content.

setType

public void setType(java.lang.String type)

Sets the type.

Parameters:

type - an URI identifying type information about the plaintext form of the encrypted content.

getMimeType

public java.lang.String getMimeType()

Returns a String which describes the media type of the data which has been encrypted. The value of this attribute has values defined by [MIME]. For example, if the data that is encrypted is a base64 encoded PNG, the transfer Encoding may be specified as 'http://www.w3.org/2000/09/xmldsig#base64' and the MimeType as 'image/png'.
This attribute is purely advisory; no validation of the MimeType information is required and it does not indicate the encryption application must do any additional processing. Note, this information may not be necessary if it is already bound to the identifier in the Type attribute. For example, the Element and Content types defined in this specification are always UTF-8 encoded text.

Returns:

the media type of the data which was encrypted.

setMimeType

public void setMimeType(java.lang.String type)

Sets the mime type.

Parameters:

type - a String which describes the media type of the data which has been encrypted.

getEncoding

public java.lang.String getEncoding()

Retusn an URI representing the encoding of the EncryptedType.

Returns:

the encoding of this EncryptedType.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the URI representing the encoding of the EncryptedType.

getEncryptionMethod

public EncryptionMethod getEncryptionMethod()

Returns an EncryptionMethod that describes the encryption algorithm applied to the cipher data. If the element is absent, the encryption algorithm must be known by the recipient or the decryption will fail.

Returns:

the method used to encrypt the cipher data.

setEncryptionMethod

public void setEncryptionMethod(EncryptionMethod method)

Sets the EncryptionMethod used to encrypt the cipher data.

Parameters:

method - the EncryptionMethod.

getKeyInfo

public KeyInfo getKeyInfo()

Returns the ds:KeyInfo, that carries information about the key used to encrypt the data. Subsequent sections of this specification define new elements that may appear as children of ds:KeyInfo.

Returns:

information about the key that encrypted the cipher data.

setKeyInfo

public void setKeyInfo(KeyInfo info)

Sets the encryption key information.

Parameters:

info - the ds:KeyInfo, that carries information about the key used to encrypt the data.

getCipherData

public CipherData getCipherData()

Returns the CipherReference that contains the CipherValue or CipherReference with the encrypted data.

Returns:

the cipher data for the encrypted type.

getEncryptionProperties

public EncryptionProperties getEncryptionProperties()

Returns additional information concerning the generation of the EncryptedType.

Returns:

information relating to the generation of the EncryptedType.

setEncryptionProperties

public void setEncryptionProperties(EncryptionProperties properties)

Sets the EncryptionProperties that supplies additional information about the generation of the EncryptedType.