org.apache.xml.security.encryption

Interface CipherData

public interface CipherData

CipherData provides encrypted data. It must either contain the encrypted octet sequence as base64 encoded text of the CipherValue element, or provide a reference to an external location containing the encrypted octet sequence via the CipherReference element.

The schema definition is as follows:

Field Summary

Fields

Modifier and Type	Field and Description
static int	REFERENCE_TYPE REFERENCE_TYPE ASN
static int	VALUE_TYPE VALUE_TYPE ASN

Method Summary

Modifier and Type	Method and Description
CipherReference	getCipherReference() Returns a reference to an external location containing the encrypted octet sequence (byte array).
CipherValue	getCipherValue() Returns the cipher value as a base64 encoded byte array.
int	getDataType() Returns the type of encrypted data contained in the CipherData.
void	setCipherReference(CipherReference reference) Sets the CipherData's reference.
void	setCipherValue(CipherValue value) Sets the CipherData's value.

Field Detail

VALUE_TYPE

static final int VALUE_TYPE

VALUE_TYPE ASN

See Also:

Constant Field Values

REFERENCE_TYPE

static final int REFERENCE_TYPE

REFERENCE_TYPE ASN

See Also:

Constant Field Values

Method Detail

getDataType

int getDataType()

Returns the type of encrypted data contained in the CipherData.

Returns:

VALUE_TYPE if the encrypted data is contained as CipherValue or REFERENCE_TYPE if the encrypted data is contained as CipherReference.

getCipherValue

CipherValue getCipherValue()

Returns the cipher value as a base64 encoded byte array.

Returns:

the CipherData's value.

setCipherValue

void setCipherValue(CipherValue value)
             throws XMLEncryptionException

Sets the CipherData's value.

Parameters:

value - the value of the CipherData.

Throws:

XMLEncryptionException

getCipherReference

CipherReference getCipherReference()

Returns a reference to an external location containing the encrypted octet sequence (byte array).

Returns:

the reference to an external location containing the encrypted octet sequence.

setCipherReference

void setCipherReference(CipherReference reference)
                 throws XMLEncryptionException

Sets the CipherData's reference.

Parameters:

reference - an external location containing the encrypted octet sequence.

Throws:

XMLEncryptionException