org.opensaml.saml2.metadata
Interface EntitiesDescriptor

All Superinterfaces:

CacheableSAMLObject, SAMLObject, SignableSAMLObject, SignableXMLObject, TimeBoundSAMLObject, ValidatingXMLObject, XMLObject

All Known Implementing Classes:

ChainingMetadataProvider.ChainingEntitiesDescriptor, EntitiesDescriptorImpl

public interface EntitiesDescriptor
extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject

SAML 2.0 Metadata EntitiesDescriptor.

Field Summary

static String	DEFAULT_ELEMENT_LOCAL_NAME Element name, no namespace
static QName	DEFAULT_ELEMENT_NAME Default element name
static QName	ELEMENT_QNAME Element QName, no prefix
static String	ID_ATTRIB_NAME "ID" attribute name
static String	NAME_ATTRIB_NAME "Name" attribute name
static String	TYPE_LOCAL_NAME Local name of the XSI type
static QName	TYPE_NAME QName of the XSI type

Fields inherited from interface org.opensaml.saml2.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

Fields inherited from interface org.opensaml.saml2.common.CacheableSAMLObject

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

Method Summary

List<EntitiesDescriptor>	getEntitiesDescriptors() Gets a list of child EntitiesDescriptors.
List<EntityDescriptor>	getEntityDescriptors() Gets a list of child EntityDescriptors.
Extensions	getExtensions() Gets the Extensions child of this object.
String	getID() Gets the ID of this entity group.
String	getName() Gets the name of this entity group.
void	setExtensions(Extensions extensions) Sets the Extensions child of this object.
void	setID(String newID) Sets the ID of this entity group.
void	setName(String name) Sets the name of this entity group.

Methods inherited from interface org.opensaml.common.SignableSAMLObject

getSignatureReferenceID

Methods inherited from interface org.opensaml.xml.signature.SignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.saml2.common.TimeBoundSAMLObject

getValidUntil, isValid, setValidUntil

Methods inherited from interface org.opensaml.saml2.common.CacheableSAMLObject

getCacheDuration, setCacheDuration

Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject

deregisterValidator, getValidators, registerValidator, validate

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element name, no namespace

See Also:

Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type

ELEMENT_QNAME

static final QName ELEMENT_QNAME

Element QName, no prefix

ID_ATTRIB_NAME

static final String ID_ATTRIB_NAME

"ID" attribute name

See Also:

Constant Field Values

NAME_ATTRIB_NAME

static final String NAME_ATTRIB_NAME

"Name" attribute name

See Also:

Constant Field Values

Method Detail

getName

String getName()

Gets the name of this entity group.

Returns:

the name of this entity group

setName

void setName(String name)

Sets the name of this entity group.

Parameters:

name - the name of this entity group

getID

String getID()

Gets the ID of this entity group.

Returns:

the id of this entity group

setID

void setID(String newID)

Sets the ID of this entity group.

Parameters:

newID - the ID of this entity group

getExtensions

Extensions getExtensions()

Gets the Extensions child of this object.

Returns:

the Extensions child of this object

setExtensions

void setExtensions(Extensions extensions)
                   throws IllegalArgumentException

Sets the Extensions child of this object.

Parameters:

extensions - the Extensions child of this object

Throws:

IllegalArgumentException - thrown if the given extensions Object is already a child of another SAMLObject

getEntitiesDescriptors

List<EntitiesDescriptor> getEntitiesDescriptors()

Gets a list of child EntitiesDescriptors.

Returns:

list of descriptors

getEntityDescriptors

List<EntityDescriptor> getEntityDescriptors()

Gets a list of child EntityDescriptors.

Returns:

list of child descriptors