|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityDescriptor
SAML 2.0 Metadata EntityDescriptor
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 |
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 |
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<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. |
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 |
---|
static final String DEFAULT_ELEMENT_LOCAL_NAME
static final QName DEFAULT_ELEMENT_NAME
static final String TYPE_LOCAL_NAME
static final QName TYPE_NAME
static final QName ELEMENT_QNAME
static final String ID_ATTRIB_NAME
static final String ENTITY_ID_ATTRIB_NAME
Method Detail |
---|
String getEntityID()
void setEntityID(String id)
id
- the entity ID for this entity descriptorString getID()
void setID(String newID)
newID
- the ID for this entity descriptorExtensions getExtensions()
void setExtensions(Extensions extensions) throws IllegalArgumentException
extensions
- the Extensions child of this object
IllegalArgumentException
- thrown if the given extensions Object is already a child of another SAMLObjectList<RoleDescriptor> getRoleDescriptors()
List<RoleDescriptor> getRoleDescriptors(QName typeOrName)
typeOrName
- the name of the role
List<RoleDescriptor> getRoleDescriptors(QName typeOrName, String supportedProtocol)
typeOrName
- the name of the rolesupportedProtocol
- the supported protocol
IDPSSODescriptor getIDPSSODescriptor(String supportedProtocol)
IDPSSODescriptor
role descriptor for this entity that supports the given protocol.
IDPSSODescriptor
role descriptorSPSSODescriptor getSPSSODescriptor(String supportedProtocol)
SPSSODescriptor
role descriptor for this entity that supports the given protocol.
SPSSODescriptor
role descriptorAuthnAuthorityDescriptor getAuthnAuthorityDescriptor(String supportedProtocol)
AuthnAuthorityDescriptor
role descriptor for this entity that supports the given protocol.
AuthnAuthorityDescriptor
role descriptorAttributeAuthorityDescriptor getAttributeAuthorityDescriptor(String supportedProtocol)
AttributeAuthorityDescriptor
role descriptor for this entity that supports the given protocol.
AttributeAuthorityDescriptor
role descriptorPDPDescriptor getPDPDescriptor(String supportedProtocol)
PDPDescriptor
role descriptor for this entity that supports the given protocol.
PDPDescriptor
role descriptorAffiliationDescriptor getAffiliationDescriptor()
void setAffiliationDescriptor(AffiliationDescriptor descriptor) throws IllegalArgumentException
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 itOrganization getOrganization()
void setOrganization(Organization organization) throws IllegalArgumentException
organization
- the organization for this entity
IllegalArgumentException
- thrown if this organization belongs to another entityList<ContactPerson> getContactPersons()
List<AdditionalMetadataLocation> getAdditionalMetadataLocations()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |