Package org.apache.xml.security.encryption

Interface ReferenceList

public interface ReferenceList

ReferenceList is an element that contains pointers from a key value of an EncryptedKey to items encrypted by that key value (EncryptedData or EncryptedKey elements).

It is defined as follows:

<element name='ReferenceList'> <complexType> <choice minOccurs='1' maxOccurs='unbounded'> <element name='DataReference' type='xenc:ReferenceType'/> <element name='KeyReference' type='xenc:ReferenceType'/> </choice> </complexType> </element>

Author:

Axl Mattheus

See Also:

Reference

Field Summary

Fields

Modifier and Type	Field	Description
static int	DATA_REFERENCE	DATA TAG
static int	KEY_REFERENCE	KEY TAG

Method Summary

Modifier and Type	Method	Description
void	add(Reference reference)	Adds a reference to this reference list.
Iterator<Reference>	getReferences()	Returns an Iterator over all the References contained in this ReferenceList.
boolean	isEmpty()	Indicates if the ReferenceList is empty.
Reference	newDataReference(String uri)	DataReference factory method.
Reference	newKeyReference(String uri)	KeyReference factory method.
void	remove(Reference reference)	Removes a reference from the ReferenceList.
int	size()	Returns the size of the ReferenceList.

Field Detail

DATA_REFERENCE

static final int DATA_REFERENCE

DATA TAG

See Also:

Constant Field Values

KEY_REFERENCE

static final int KEY_REFERENCE

KEY TAG

See Also:

Constant Field Values

Method Detail

add

void add(Reference reference)

Adds a reference to this reference list.

Parameters:

reference - the reference to add.

Throws:

IllegalAccessException - if the Reference is not an instance of DataReference or KeyReference.

remove

void remove(Reference reference)

Removes a reference from the ReferenceList.

Parameters:

reference - the reference to remove.

size

int size()

Returns the size of the ReferenceList.

Returns:

the size of the ReferenceList.

isEmpty

boolean isEmpty()

Indicates if the ReferenceList is empty.

Returns:

true if the ReferenceList is empty, else false.

getReferences

Iterator<Reference> getReferences()

Returns an Iterator over all the References contained in this ReferenceList.

Returns:

Iterator.

newDataReference

Reference newDataReference(String uri)

DataReference factory method. Returns a DataReference.

Parameters:

uri -

Returns:

a DataReference.

newKeyReference

Reference newKeyReference(String uri)

KeyReference factory method. Returns a KeyReference.

Parameters:

uri -

Returns:

a KeyReference.