FileDocCategorySizeDatePackage
EncryptedType.javaAPI DocJava SE 6 API6684Tue Jun 10 00:23:00 BST 2008com.sun.org.apache.xml.internal.security.encryption

EncryptedType

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

Fields Summary
Constructors Summary
Methods Summary
public CipherDatagetCipherData()
Returns the CipherReference that contains the CipherValue or CipherReference with the encrypted data.

return
the cipher data for the encrypted type.

public java.lang.StringgetEncoding()
Retusn an URI representing the encoding of the EncryptedType.

return
the encoding of this EncryptedType.

public EncryptionMethodgetEncryptionMethod()
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.

return
the method used to encrypt the cipher data.

public EncryptionPropertiesgetEncryptionProperties()
Returns additional information concerning the generation of the EncryptedType.

return
information relating to the generation of the EncryptedType.

public java.lang.StringgetId()
Returns a String providing for the standard method of assigning an id to the element within the document context.

return
the id for the EncryptedType.

public com.sun.org.apache.xml.internal.security.keys.KeyInfogetKeyInfo()
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.

return
information about the key that encrypted the cipher data.

public java.lang.StringgetMimeType()
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.

return
the media type of the data which was encrypted.

public java.lang.StringgetType()
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.

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

public voidsetEncoding(java.lang.String encoding)
Sets the URI representing the encoding of the EncryptedType.

param
encoding.

public voidsetEncryptionMethod(EncryptionMethod method)
Sets the EncryptionMethod used to encrypt the cipher data.

param
method the EncryptionMethod.

public voidsetEncryptionProperties(EncryptionProperties properties)
Sets the EncryptionProperties that supplies additional information about the generation of the EncryptedType.

param
properties.

public voidsetId(java.lang.String id)
Sets the id.

param
id.

public voidsetKeyInfo(com.sun.org.apache.xml.internal.security.keys.KeyInfo info)
Sets the encryption key information.

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

public voidsetMimeType(java.lang.String type)
Sets the mime type.

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

public voidsetType(java.lang.String type)
Sets the type.

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