Package org.opensaml.saml.saml2.metadata

Interface EntitiesDescriptor

All Superinterfaces:

CacheableSAMLObject, SAMLObject, SignableSAMLObject, SignableXMLObject, TimeBoundSAMLObject, XMLObject

All Known Implementing Classes:

EntitiesDescriptorImpl

public interface EntitiesDescriptor
extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject

SAML 2.0 Metadata EntitiesDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ELEMENT_LOCAL_NAME	Element name, no namespace.
static final QName	DEFAULT_ELEMENT_NAME	Default element name.
static final QName	ELEMENT_QNAME	Element QName, no prefix.
static final String	ID_ATTRIB_NAME	"ID" attribute name.
static final String	NAME_ATTRIB_NAME	"Name" attribute name.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.

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

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

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

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

Method Summary

Modifier and Type	Method	Description
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.saml.saml2.common.CacheableSAMLObject

getCacheDuration, setCacheDuration

Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject

getSignatureReferenceID

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

getSignature, isSigned, setSignature

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

getValidUntil, isValid, setValidUntil

Methods inherited from interface org.opensaml.core.xml.XMLObject

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

Field Details

DEFAULT_ELEMENT_LOCAL_NAME

@Nonnull
@NotEmpty
static final String DEFAULT_ELEMENT_LOCAL_NAME

Element name, no namespace.

See Also:

• Constant Field Values

DEFAULT_ELEMENT_NAME

@Nonnull
static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

@Nonnull
@NotEmpty
static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

• Constant Field Values

TYPE_NAME

@Nonnull
static final QName TYPE_NAME

QName of the XSI type.

ELEMENT_QNAME

@Nonnull
static final QName ELEMENT_QNAME

Element QName, no prefix.

ID_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String ID_ATTRIB_NAME

"ID" attribute name.

See Also:

• Constant Field Values

NAME_ATTRIB_NAME

@Nonnull
@NotEmpty
static final String NAME_ATTRIB_NAME

"Name" attribute name.

See Also:

• Constant Field Values

Method Details

getName

@Nullable
String getName()

Gets the name of this entity group.

Returns:

the name of this entity group

setName

void setName(@Nullable
 String name)

Sets the name of this entity group.

Parameters:

name - the name of this entity group

getID

@Nullable
String getID()

Gets the ID of this entity group.

Returns:

the id of this entity group

setID

void setID(@Nullable
 String newID)

Sets the ID of this entity group.

Parameters:

newID - the ID of this entity group

getExtensions

@Nullable
Extensions getExtensions()

Gets the Extensions child of this object.

Returns:

the Extensions child of this object

setExtensions

void setExtensions(@Nullable
 Extensions extensions)

Sets the Extensions child of this object.

Parameters:

extensions - the Extensions child of this object

getEntitiesDescriptors

@Nonnull
@Live
List<EntitiesDescriptor> getEntitiesDescriptors()

Gets a list of child EntitiesDescriptors.

Returns:

list of descriptors

getEntityDescriptors

@Nonnull
@Live
List<EntityDescriptor> getEntityDescriptors()

Gets a list of child EntityDescriptors.

Returns:

list of child descriptors