public interface EncryptedType
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:
Modifier and Type | Method and Description |
---|---|
CipherData |
getCipherData()
Returns the
CipherReference that contains the
CipherValue or CipherReference with the
encrypted data. |
String |
getEncoding()
Return 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 . |
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. |
String |
getMimeType()
Returns a
String which describes the media type of the data
which has been encrypted. |
String |
getType()
Returns an
URI identifying type information about the
plaintext form of the encrypted content. |
void |
setEncoding(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(String id)
Sets the id.
|
void |
setKeyInfo(KeyInfo info)
Sets the encryption key information.
|
void |
setMimeType(String type)
Sets the mime type.
|
void |
setType(String type)
Sets the type.
|
String getId()
String
providing for the standard method of
assigning an id to the element within the document context.EncryptedType
.void setId(String id)
id
- String getType()
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.void setType(String type)
type
- an URI
identifying type information about the
plaintext form of the encrypted content.String getMimeType()
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'.
void setMimeType(String type)
type
- a String
which describes the media type of the
data which has been encrypted.String getEncoding()
URI
representing the encoding of the
EncryptedType
.EncryptedType
.void setEncoding(String encoding)
URI
representing the encoding of the
EncryptedType
.encoding
- EncryptionMethod getEncryptionMethod()
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.void setEncryptionMethod(EncryptionMethod method)
EncryptionMethod
used to encrypt the cipher data.method
- the EncryptionMethod
.KeyInfo getKeyInfo()
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
.void setKeyInfo(KeyInfo info)
info
- the ds:KeyInfo
, that carries information about
the key used to encrypt the data.CipherData getCipherData()
CipherReference
that contains the
CipherValue
or CipherReference
with the
encrypted data.EncryptionProperties getEncryptionProperties()
EncryptedType
.EncryptedType
.void setEncryptionProperties(EncryptionProperties properties)
EncryptionProperties
that supplies additional
information about the generation of the EncryptedType
.properties
- Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.