|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RoleDescriptor
SAML 2.0 Metadata RoleDescriptor.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ELEMENT_LOCAL_NAME
Element name, no namespace. |
static javax.xml.namespace.QName |
DEFAULT_ELEMENT_NAME
Default element name. |
static java.lang.String |
ERROR_URL_ATTRIB_NAME
"errorURL" attribute's local name. |
static java.lang.String |
ID_ATTRIB_NAME
"ID" attribute's local name. |
static java.lang.String |
PROTOCOL_ENUMERATION_ATTRIB_NAME
"protocolEnumeration" attribute's local name. |
static java.lang.String |
TYPE_LOCAL_NAME
Local name of the XSI type. |
static javax.xml.namespace.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 | |
---|---|
void |
addSupportedProtocol(java.lang.String protocol)
Adds a protocol to the list of supported protocols for this role. |
java.util.List<ContactPerson> |
getContactPersons()
Gets an immutable list of ContactPerson s for this role. |
java.util.List<Endpoint> |
getEndpoints()
Gets a read-only list of endpoints for this role. |
java.util.List<Endpoint> |
getEndpoints(javax.xml.namespace.QName type)
Gets a read-only list of endpoints for this role for the given type. |
java.lang.String |
getErrorURL()
Gets the URI users should be sent to in the event of an error. |
Extensions |
getExtensions()
Gets the Extensions child of this object. |
java.lang.String |
getID()
Gets the ID of this role descriptor. |
java.util.List<KeyDescriptor> |
getKeyDescriptors()
Gets the key descriptors for this role. |
Organization |
getOrganization()
Gets the organization responsible for this role. |
java.util.List<java.lang.String> |
getSupportedProtocols()
Gets an immutable list of protocol URIs supported by this role. |
boolean |
isSupportedProtocol(java.lang.String protocol)
Chckes to see if the given protocol is supported by this role. |
void |
removeAllSupportedProtocols()
Removes all the supported protocols from this role. |
void |
removeSupportedProtocol(java.lang.String protocol)
Removes a protocol to the list of supported protocols for this role. |
void |
removeSupportedProtocols(java.util.Collection<java.lang.String> protocols)
Removes a list of protocols to the list of supported protocols for this role. |
void |
setErrorURL(java.lang.String errorURL)
Sets the URI users should be sent to in the event of an error. |
void |
setExtensions(Extensions extensions)
Sets the Extensions child of this object. |
void |
setID(java.lang.String newID)
Sets the ID of this role descriptor. |
void |
setOrganization(Organization organization)
Sets the organization responsible for this role. |
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, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation |
Methods inherited from interface org.opensaml.xml.AttributeExtensibleXMLObject |
---|
getUnknownAttributes |
Field Detail |
---|
static final java.lang.String DEFAULT_ELEMENT_LOCAL_NAME
static final javax.xml.namespace.QName DEFAULT_ELEMENT_NAME
static final java.lang.String TYPE_LOCAL_NAME
static final javax.xml.namespace.QName TYPE_NAME
static final java.lang.String ID_ATTRIB_NAME
static final java.lang.String PROTOCOL_ENUMERATION_ATTRIB_NAME
static final java.lang.String ERROR_URL_ATTRIB_NAME
Method Detail |
---|
java.lang.String getID()
void setID(java.lang.String newID)
newID
- the ID of this role descriptorjava.util.List<java.lang.String> getSupportedProtocols()
boolean isSupportedProtocol(java.lang.String protocol)
protocol
- the protocol
void addSupportedProtocol(java.lang.String protocol)
protocol
- the protocolvoid removeSupportedProtocol(java.lang.String protocol)
protocol
- the protocolvoid removeSupportedProtocols(java.util.Collection<java.lang.String> protocols)
protocols
- the protocolvoid removeAllSupportedProtocols()
java.lang.String getErrorURL()
void setErrorURL(java.lang.String errorURL)
errorURL
- the URI users should be sent to in the event of an errorExtensions getExtensions()
void setExtensions(Extensions extensions) throws java.lang.IllegalArgumentException
extensions
- the Extensions child of this object
java.lang.IllegalArgumentException
- thrown if the given extensions Object is already a child of another SAMLObjectjava.util.List<KeyDescriptor> getKeyDescriptors()
Organization getOrganization()
void setOrganization(Organization organization) throws java.lang.IllegalArgumentException
organization
- the organization responsible for this role
java.lang.IllegalArgumentException
- thrown if the given organization is owned by another elementjava.util.List<ContactPerson> getContactPersons()
ContactPerson
s for this role.
ContactPerson
s for this rolejava.util.List<Endpoint> getEndpoints()
java.util.List<Endpoint> getEndpoints(javax.xml.namespace.QName type)
type
- the type of endpoints to retrieve
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |