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:
-
Method Summary
Modifier and TypeMethodDescriptionReturns theCipherReferencethat contains theCipherValueorCipherReferencewith the encrypted data.Return anURIrepresenting the encoding of theEncryptedType.Returns anEncryptionMethodthat describes the encryption algorithm applied to the cipher data.Returns additional information concerning the generation of theEncryptedType.getId()Returns aStringproviding for the standard method of assigning an id to the element within the document context.Returns theds:KeyInfo, that carries information about the key used to encrypt the data.Returns aStringwhich describes the media type of the data which has been encrypted.getType()Returns anURIidentifying type information about the plaintext form of the encrypted content.voidsetEncoding(String encoding) Sets theURIrepresenting the encoding of theEncryptedType.voidsetEncryptionMethod(EncryptionMethod method) Sets theEncryptionMethodused to encrypt the cipher data.voidsetEncryptionProperties(EncryptionProperties properties) Sets theEncryptionPropertiesthat supplies additional information about the generation of theEncryptedType.voidSets the id.voidsetKeyInfo(KeyInfo info) Sets the encryption key information.voidsetMimeType(String type) Sets the mime type.voidSets the type.
-
Method Details
-
getId
String getId()Returns aStringproviding for the standard method of assigning an id to the element within the document context.- Returns:
- the id for the
EncryptedType.
-
setId
Sets the id.- Parameters:
id-
-
getType
String getType()Returns anURIidentifying 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 theEncryptedDataelement 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
Sets the type.- Parameters:
type- anURIidentifying type information about the plaintext form of the encrypted content.
-
getMimeType
String getMimeType()Returns aStringwhich 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
Sets the mime type.- Parameters:
type- aStringwhich describes the media type of the data which has been encrypted.
-
getEncoding
String getEncoding()Return anURIrepresenting the encoding of theEncryptedType.- Returns:
- the encoding of this
EncryptedType.
-
setEncoding
Sets theURIrepresenting the encoding of theEncryptedType.- Parameters:
encoding-
-
getEncryptionMethod
EncryptionMethod getEncryptionMethod()Returns anEncryptionMethodthat 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
Sets theEncryptionMethodused to encrypt the cipher data.- Parameters:
method- theEncryptionMethod.
-
getKeyInfo
KeyInfo getKeyInfo()Returns theds: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 ofds:KeyInfo.- Returns:
- information about the key that encrypted the cipher data.
-
setKeyInfo
Sets the encryption key information.- Parameters:
info- theds:KeyInfo, that carries information about the key used to encrypt the data.
-
getCipherData
CipherData getCipherData()Returns theCipherReferencethat contains theCipherValueorCipherReferencewith the encrypted data.- Returns:
- the cipher data for the encrypted type.
-
getEncryptionProperties
EncryptionProperties getEncryptionProperties()Returns additional information concerning the generation of theEncryptedType.- Returns:
- information relating to the generation of the
EncryptedType.
-
setEncryptionProperties
Sets theEncryptionPropertiesthat supplies additional information about the generation of theEncryptedType.- Parameters:
properties-
-