org.opensaml.saml2.metadata
Interface AffiliationDescriptor

All Superinterfaces:

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

All Known Implementing Classes:

AffiliationDescriptorImpl

public interface AffiliationDescriptor
extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject, AttributeExtensibleXMLObject

SAML 2.0 Metadata AffiliationDescriptorType

Field Summary

static String	DEFAULT_ELEMENT_LOCAL_NAME Element name, no namespace
static QName	DEFAULT_ELEMENT_NAME Default element name
static String	ID_ATTRIB_NAME ID attribute's local name
static String	OWNER_ID_ATTRIB_NAME "affiliationOwnerID" attribute's local 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

Extensions	getExtensions() Gets the Extensions child of this object.
String	getID() Gets the ID of this Descriptor.
List<KeyDescriptor>	getKeyDescriptors() Gets an immutable list of KeyDescriptors for this affiliation.
List<AffiliateMember>	getMembers() Gets a list of the members of this affiliation.
String	getOwnerID() Gets the ID of the owner of this affiliation.
void	setExtensions(Extensions extensions) Sets the Extensions child of this object.
void	setID(String newID) Sets the ID of this descriptor.
void	setOwnerID(String ownerID) Sets the ID of the owner of this affiliation.

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

Methods inherited from interface org.opensaml.xml.AttributeExtensibleXMLObject

getUnknownAttributes

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

OWNER_ID_ATTRIB_NAME

static final String OWNER_ID_ATTRIB_NAME

"affiliationOwnerID" attribute's local name

See Also:

Constant Field Values

ID_ATTRIB_NAME

static final String ID_ATTRIB_NAME

ID attribute's local name

See Also:

Constant Field Values

Method Detail

getOwnerID

String getOwnerID()

Gets the ID of the owner of this affiliation. The owner may, or may not, be a memeber of the affiliation.

Returns:

the ID of the owner of this affiliation

getID

String getID()

Gets the ID of this Descriptor.

Returns:

the ID of this Descriptor

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

setOwnerID

void setOwnerID(String ownerID)

Sets the ID of the owner of this affiliation.

Parameters:

ownerID - the ID of the owner of this affiliation

setID

void setID(String newID)

Sets the ID of this descriptor.

Parameters:

newID - the ID of this descriptor

getMembers

List<AffiliateMember> getMembers()

Gets a list of the members of this affiliation.

Returns:

a list of affiliate members

getKeyDescriptors

List<KeyDescriptor> getKeyDescriptors()

Gets an immutable list of KeyDescriptors for this affiliation.

Returns:

list of KeyDescriptors for this affiliation