org.opensaml.saml2.metadata.impl
public abstract class RoleDescriptorImpl extends AbstractSignableSAMLObject implements RoleDescriptor
RoleDescriptor
.Modifier and Type | Field and Description |
---|---|
private Long |
cacheDuration
cacheDurection attribute.
|
private XMLObjectChildrenList<ContactPerson> |
contactPersons
Contact persons for this role.
|
private String |
errorURL
Error URL.
|
private Extensions |
extensions
Extensions child.
|
private String |
id
ID attribute.
|
private XMLObjectChildrenList<KeyDescriptor> |
keyDescriptors
Key descriptors for this role.
|
private Organization |
organization
Organization administering this role.
|
private List<String> |
supportedProtocols
Set of supported protocols.
|
private AttributeMap |
unknownAttributes
"anyAttribute" attributes.
|
private org.joda.time.DateTime |
validUntil
validUntil attribute.
|
DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ERROR_URL_ATTRIB_NAME, ID_ATTRIB_NAME, PROTOCOL_ENUMERATION_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME
VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME
CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME
Modifier | Constructor and Description |
---|---|
protected |
RoleDescriptorImpl(String namespaceURI,
String elementLocalName,
String namespacePrefix)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addSupportedProtocol(String protocol)
Adds a protocol to the list of supported protocols for this role.
|
Long |
getCacheDuration()
Gets the maximum time, in milliseconds, that this descriptor should be cached.
|
List<ContactPerson> |
getContactPersons()
Gets an immutable list of
ContactPerson s for this role. |
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.
|
String |
getID()
Gets the ID of this role descriptor.
|
List<KeyDescriptor> |
getKeyDescriptors()
Gets the key descriptors for this role.
|
List<XMLObject> |
getOrderedChildren() |
Organization |
getOrganization()
Gets the organization responsible for this role.
|
String |
getSignatureReferenceID()
Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
|
List<String> |
getSupportedProtocols()
Gets an immutable list of protocol URIs supported by this role.
|
AttributeMap |
getUnknownAttributes() |
org.joda.time.DateTime |
getValidUntil()
Gets the date until which this descriptor is valid.
|
boolean |
isSupportedProtocol(String protocol)
Chckes to see if the given protocol is supported by this role.
|
boolean |
isValid()
Checks to see if the current time is past the validUntil time.
|
void |
removeAllSupportedProtocols()
Removes all the supported protocols from this role.
|
void |
removeSupportedProtocol(String protocol)
Removes a protocol to the list of supported protocols for this role.
|
void |
removeSupportedProtocols(Collection<String> protocols)
Removes a list of protocols to the list of supported protocols for this role.
|
void |
setCacheDuration(Long duration)
Sets the maximum time, in milliseconds, that this descriptor should be cached.
|
void |
setErrorURL(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(String newID)
Sets the ID of this role descriptor.
|
void |
setOrganization(Organization organization)
Sets the organization responsible for this role.
|
void |
setValidUntil(org.joda.time.DateTime validUntil)
Sets the date until which this descriptor is valid.
|
equals, prepareForAssignment, setSignature
deregisterValidator, getValidators, registerValidator, validate, validateChildren
getSignature, isSigned
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoints, getEndpoints
getSignature, isSigned, setSignature
deregisterValidator, getValidators, registerValidator, validate
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
private String id
private org.joda.time.DateTime validUntil
private Long cacheDuration
private String errorURL
private Extensions extensions
private Organization organization
private final AttributeMap unknownAttributes
private final XMLObjectChildrenList<ContactPerson> contactPersons
private final XMLObjectChildrenList<KeyDescriptor> keyDescriptors
protected RoleDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)
namespaceURI
- the namespace the element is inelementLocalName
- the local name of the XML element this Object representsnamespacePrefix
- the prefix for the given namespacepublic String getID()
getID
in interface RoleDescriptor
public void setID(String newID)
setID
in interface RoleDescriptor
newID
- the ID of this role descriptorpublic boolean isValid()
isValid
in interface TimeBoundSAMLObject
public org.joda.time.DateTime getValidUntil()
getValidUntil
in interface TimeBoundSAMLObject
public void setValidUntil(org.joda.time.DateTime validUntil)
setValidUntil
in interface TimeBoundSAMLObject
validUntil
- the date until which this descriptor is validpublic Long getCacheDuration()
getCacheDuration
in interface CacheableSAMLObject
public void setCacheDuration(Long duration)
setCacheDuration
in interface CacheableSAMLObject
duration
- the maximum time that this descriptor should be cachedpublic List<String> getSupportedProtocols()
getSupportedProtocols
in interface RoleDescriptor
public boolean isSupportedProtocol(String protocol)
isSupportedProtocol
in interface RoleDescriptor
protocol
- the protocolpublic void addSupportedProtocol(String protocol)
addSupportedProtocol
in interface RoleDescriptor
protocol
- the protocolpublic void removeSupportedProtocol(String protocol)
removeSupportedProtocol
in interface RoleDescriptor
protocol
- the protocolpublic void removeSupportedProtocols(Collection<String> protocols)
removeSupportedProtocols
in interface RoleDescriptor
protocols
- the protocolpublic void removeAllSupportedProtocols()
removeAllSupportedProtocols
in interface RoleDescriptor
public String getErrorURL()
getErrorURL
in interface RoleDescriptor
public void setErrorURL(String errorURL)
setErrorURL
in interface RoleDescriptor
errorURL
- the URI users should be sent to in the event of an errorpublic Extensions getExtensions()
getExtensions
in interface RoleDescriptor
public void setExtensions(Extensions extensions) throws IllegalArgumentException
setExtensions
in interface RoleDescriptor
extensions
- the Extensions child of this objectIllegalArgumentException
- thrown if the given extensions Object is already a child of another SAMLObjectpublic Organization getOrganization()
getOrganization
in interface RoleDescriptor
public void setOrganization(Organization organization) throws IllegalArgumentException
setOrganization
in interface RoleDescriptor
organization
- the organization responsible for this roleIllegalArgumentException
- thrown if the given organization is owned by another elementpublic List<ContactPerson> getContactPersons()
ContactPerson
s for this role.getContactPersons
in interface RoleDescriptor
ContactPerson
s for this rolepublic List<KeyDescriptor> getKeyDescriptors()
getKeyDescriptors
in interface RoleDescriptor
public AttributeMap getUnknownAttributes()
getUnknownAttributes
in interface AttributeExtensibleXMLObject
public String getSignatureReferenceID()
getSignatureReferenceID
in interface SignableSAMLObject
public List<XMLObject> getOrderedChildren()
getOrderedChildren
in interface XMLObject
Copyright © 1999-2013 JBoss by Red Hat. All Rights Reserved.