org.opensaml.saml2.metadata

インタフェース EntityDescriptor

すべてのスーパーインタフェース:

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

既知の実装クラスのリスト:

EntityDescriptorImpl

public interface EntityDescriptor
extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject, AttributeExtensibleXMLObject

SAML 2.0 Metadata EntityDescriptor

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
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	ENTITY_ID_ATTRIB_NAME "Name" attribute name
static String	ID_ATTRIB_NAME "ID" attribute name
static String	TYPE_LOCAL_NAME Local name of the XSI type
static QName	TYPE_NAME QName of the XSI type

インタフェースから継承されたフィールド org.opensaml.saml2.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

インタフェースから継承されたフィールド org.opensaml.saml2.common.CacheableSAMLObject

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
List<AdditionalMetadataLocation>	getAdditionalMetadataLocations() Gets the additional metadata locations for this entity.
AffiliationDescriptor	getAffiliationDescriptor() Gets the affiliation descriptor for this entity.
AttributeAuthorityDescriptor	getAttributeAuthorityDescriptor(String supportedProtocol) Gets the first AttributeAuthorityDescriptor role descriptor for this entity that supports the given protocol.
AuthnAuthorityDescriptor	getAuthnAuthorityDescriptor(String supportedProtocol) Gets the first AuthnAuthorityDescriptor role descriptor for this entity that supports the given protocol.
List<ContactPerson>	getContactPersons() Get the contact people for this entity.
String	getEntityID() Gets the entity ID for this entity descriptor.
Extensions	getExtensions() Gets the Extensions child of this object.
String	getID() Gets the ID for this entity descriptor.
IDPSSODescriptor	getIDPSSODescriptor(String supportedProtocol) Gets the first IDPSSODescriptor role descriptor for this entity that supports the given protocol.
Organization	getOrganization() Gets the organization for this entity.
PDPDescriptor	getPDPDescriptor(String supportedProtocol) Gets the first PDPDescriptor role descriptor for this entity that supports the given protocol.
List<RoleDescriptor>	getRoleDescriptors() Gets all the role descriptors for this entity descriptor.
List<RoleDescriptor>	getRoleDescriptors(QName typeOrName) Gets all the role descriptors for this entity descriptor that match the supplied QName parameter.
List<RoleDescriptor>	getRoleDescriptors(QName typeOrName, String supportedProtocol) Gets all the role descriptors for this entity that support the given protocol.
SPSSODescriptor	getSPSSODescriptor(String supportedProtocol) Gets the first SPSSODescriptor role descriptor for this entity that supports the given protocol.
void	setAffiliationDescriptor(AffiliationDescriptor descriptor) Sets the affiliation descriptor for this entity.
void	setEntityID(String id) Sets the entity ID for this entity descriptor.
void	setExtensions(Extensions extensions) Sets the Extensions child of this object.
void	setID(String newID) Sets the ID for this entity descriptor.
void	setOrganization(Organization organization) Sets the organization for this entity.

インタフェースから継承されたメソッド org.opensaml.common.SignableSAMLObject

getSignatureReferenceID

インタフェースから継承されたメソッド org.opensaml.xml.signature.SignableXMLObject

getSignature, isSigned, setSignature

インタフェースから継承されたメソッド org.opensaml.saml2.common.TimeBoundSAMLObject

getValidUntil, isValid, setValidUntil

インタフェースから継承されたメソッド org.opensaml.saml2.common.CacheableSAMLObject

getCacheDuration, setCacheDuration

インタフェースから継承されたメソッド org.opensaml.xml.validation.ValidatingXMLObject

deregisterValidator, getValidators, registerValidator, validate

インタフェースから継承されたメソッド 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

インタフェースから継承されたメソッド org.opensaml.xml.AttributeExtensibleXMLObject

getUnknownAttributes

フィールドの詳細

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element name, no namespace

関連項目:

定数フィールド値

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

関連項目:

定数フィールド値

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

関連項目:

定数フィールド値

ENTITY_ID_ATTRIB_NAME

static final String ENTITY_ID_ATTRIB_NAME

"Name" attribute name

関連項目:

定数フィールド値

メソッドの詳細

getEntityID

String getEntityID()

Gets the entity ID for this entity descriptor.

戻り値:

the entity ID for this entity descriptor

setEntityID

void setEntityID(String id)

Sets the entity ID for this entity descriptor.

パラメータ:

id - the entity ID for this entity descriptor

getID

String getID()

Gets the ID for this entity descriptor.

戻り値:

the ID for this entity descriptor

setID

void setID(String newID)

Sets the ID for this entity descriptor.

パラメータ:

newID - the ID for this entity descriptor

getExtensions

Extensions getExtensions()

Gets the Extensions child of this object.

戻り値:

the Extensions child of this object

setExtensions

void setExtensions(Extensions extensions)
                   throws IllegalArgumentException

Sets the Extensions child of this object.

パラメータ:

extensions - the Extensions child of this object

例外:

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

getRoleDescriptors

List<RoleDescriptor> getRoleDescriptors()

Gets all the role descriptors for this entity descriptor.

戻り値:

the role descriptors for this entity descriptor

getRoleDescriptors

List<RoleDescriptor> getRoleDescriptors(QName typeOrName)

Gets all the role descriptors for this entity descriptor that match the supplied QName parameter.

パラメータ:

typeOrName - the name of the role

戻り値:

the role descriptors for this entity descriptor

getRoleDescriptors

List<RoleDescriptor> getRoleDescriptors(QName typeOrName,
                                      String supportedProtocol)

Gets all the role descriptors for this entity that support the given protocol.

パラメータ:

typeOrName - the name of the role

supportedProtocol - the supported protocol

戻り値:

the list of role descriptors that support the given protocol

getIDPSSODescriptor

IDPSSODescriptor getIDPSSODescriptor(String supportedProtocol)

Gets the first IDPSSODescriptor role descriptor for this entity that supports the given protocol.

戻り値:

the IDPSSODescriptor role descriptor

getSPSSODescriptor

SPSSODescriptor getSPSSODescriptor(String supportedProtocol)

Gets the first SPSSODescriptor role descriptor for this entity that supports the given protocol.

戻り値:

the SPSSODescriptor role descriptor

getAuthnAuthorityDescriptor

AuthnAuthorityDescriptor getAuthnAuthorityDescriptor(String supportedProtocol)

Gets the first AuthnAuthorityDescriptor role descriptor for this entity that supports the given protocol.

戻り値:

the AuthnAuthorityDescriptor role descriptor

getAttributeAuthorityDescriptor

AttributeAuthorityDescriptor getAttributeAuthorityDescriptor(String supportedProtocol)

Gets the first AttributeAuthorityDescriptor role descriptor for this entity that supports the given protocol.

戻り値:

the AttributeAuthorityDescriptor role descriptor

getPDPDescriptor

PDPDescriptor getPDPDescriptor(String supportedProtocol)

Gets the first PDPDescriptor role descriptor for this entity that supports the given protocol.

戻り値:

the PDPDescriptor role descriptor

getAffiliationDescriptor

AffiliationDescriptor getAffiliationDescriptor()

Gets the affiliation descriptor for this entity.

戻り値:

the affiliation descriptor for this entity

setAffiliationDescriptor

void setAffiliationDescriptor(AffiliationDescriptor descriptor)
                              throws IllegalArgumentException

Sets the affiliation descriptor for this entity.

パラメータ:

descriptor - the affiliation descriptor for this entity

例外:

IllegalArgumentException - thrown if the descriptor is owned by another entity or if this entity already has one or more role descriptors associated with it

getOrganization

Organization getOrganization()

Gets the organization for this entity.

戻り値:

the organization for this entity

setOrganization

void setOrganization(Organization organization)
                     throws IllegalArgumentException

Sets the organization for this entity.

パラメータ:

organization - the organization for this entity

例外:

IllegalArgumentException - thrown if this organization belongs to another entity

getContactPersons

List<ContactPerson> getContactPersons()

Get the contact people for this entity.

戻り値:

the contact people for this entity

getAdditionalMetadataLocations

List<AdditionalMetadataLocation> getAdditionalMetadataLocations()

Gets the additional metadata locations for this entity.

戻り値:

the additional metadata locations for this entity