|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.opensaml.xml.AbstractXMLObject org.opensaml.xml.signature.AbstractSignableXMLObject org.opensaml.xml.AbstractValidatingSignableXMLObject org.opensaml.common.impl.AbstractSignableSAMLObject org.opensaml.saml2.metadata.impl.RoleDescriptorImpl
public abstract class RoleDescriptorImpl
Concrete implementation of RoleDescriptor
.
Field Summary | |
---|---|
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. |
Fields inherited from interface org.opensaml.saml2.metadata.RoleDescriptor |
---|
DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ERROR_URL_ATTRIB_NAME, ID_ATTRIB_NAME, PROTOCOL_ENUMERATION_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME |
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 |
Constructor Summary | |
---|---|
protected |
RoleDescriptorImpl(String namespaceURI,
String elementLocalName,
String namespacePrefix)
Constructor. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.opensaml.common.impl.AbstractSignableSAMLObject |
---|
equals, prepareForAssignment, setSignature |
Methods inherited from class org.opensaml.xml.AbstractValidatingSignableXMLObject |
---|
deregisterValidator, getValidators, registerValidator, validate, validateChildren |
Methods inherited from class org.opensaml.xml.signature.AbstractSignableXMLObject |
---|
getSignature, isSigned |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opensaml.saml2.metadata.RoleDescriptor |
---|
getEndpoints, getEndpoints |
Methods inherited from interface org.opensaml.xml.signature.SignableXMLObject |
---|
getSignature, isSigned, setSignature |
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, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation |
Field Detail |
---|
private String id
private org.joda.time.DateTime validUntil
private Long cacheDuration
private final List<String> supportedProtocols
private String errorURL
private Extensions extensions
private Organization organization
private final AttributeMap unknownAttributes
private final XMLObjectChildrenList<ContactPerson> contactPersons
private final XMLObjectChildrenList<KeyDescriptor> keyDescriptors
Constructor Detail |
---|
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 namespaceMethod Detail |
---|
public 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 protocol
public 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 object
IllegalArgumentException
- 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 role
IllegalArgumentException
- 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |