|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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 |
---|
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(java.lang.String namespaceURI,
java.lang.String elementLocalName,
java.lang.String namespacePrefix)
Constructor. |
Method Summary | |
---|---|
void |
addSupportedProtocol(java.lang.String protocol)
Adds a protocol to the list of supported protocols for this role. |
java.lang.Long |
getCacheDuration()
Gets the maximum time, in milliseconds, that this descriptor should be cached. |
java.util.List<ContactPerson> |
getContactPersons()
Gets an immutable list of ContactPerson s for this role. |
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. |
java.util.List<org.opensaml.xml.XMLObject> |
getOrderedChildren()
|
Organization |
getOrganization()
Gets the organization responsible for this role. |
java.lang.String |
getSignatureReferenceID()
Gets the value of the ID attribute for this SAML object which will be used as its signature reference. |
java.util.List<java.lang.String> |
getSupportedProtocols()
Gets an immutable list of protocol URIs supported by this role. |
org.opensaml.xml.util.AttributeMap |
getUnknownAttributes()
|
org.joda.time.DateTime |
getValidUntil()
Gets the date until which this descriptor is valid. |
boolean |
isSupportedProtocol(java.lang.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(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 |
setCacheDuration(java.lang.Long duration)
Sets the maximum time, in milliseconds, that this descriptor should be cached. |
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. |
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 org.opensaml.xml.AbstractXMLObject |
---|
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType |
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, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation |
Constructor Detail |
---|
protected RoleDescriptorImpl(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.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 java.lang.String getID()
getID
in interface RoleDescriptor
public void setID(java.lang.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 java.lang.Long getCacheDuration()
getCacheDuration
in interface CacheableSAMLObject
public void setCacheDuration(java.lang.Long duration)
setCacheDuration
in interface CacheableSAMLObject
duration
- the maximum time that this descriptor should be cachedpublic java.util.List<java.lang.String> getSupportedProtocols()
getSupportedProtocols
in interface RoleDescriptor
public boolean isSupportedProtocol(java.lang.String protocol)
isSupportedProtocol
in interface RoleDescriptor
protocol
- the protocol
public void addSupportedProtocol(java.lang.String protocol)
addSupportedProtocol
in interface RoleDescriptor
protocol
- the protocolpublic void removeSupportedProtocol(java.lang.String protocol)
removeSupportedProtocol
in interface RoleDescriptor
protocol
- the protocolpublic void removeSupportedProtocols(java.util.Collection<java.lang.String> protocols)
removeSupportedProtocols
in interface RoleDescriptor
protocols
- the protocolpublic void removeAllSupportedProtocols()
removeAllSupportedProtocols
in interface RoleDescriptor
public java.lang.String getErrorURL()
getErrorURL
in interface RoleDescriptor
public void setErrorURL(java.lang.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 java.lang.IllegalArgumentException
setExtensions
in interface RoleDescriptor
extensions
- the Extensions child of this object
java.lang.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 java.lang.IllegalArgumentException
setOrganization
in interface RoleDescriptor
organization
- the organization responsible for this role
java.lang.IllegalArgumentException
- thrown if the given organization is owned by another elementpublic java.util.List<ContactPerson> getContactPersons()
ContactPerson
s for this role.
getContactPersons
in interface RoleDescriptor
ContactPerson
s for this rolepublic java.util.List<KeyDescriptor> getKeyDescriptors()
getKeyDescriptors
in interface RoleDescriptor
public org.opensaml.xml.util.AttributeMap getUnknownAttributes()
getUnknownAttributes
in interface org.opensaml.xml.AttributeExtensibleXMLObject
public java.lang.String getSignatureReferenceID()
getSignatureReferenceID
in interface SignableSAMLObject
public java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
getOrderedChildren
in interface org.opensaml.xml.XMLObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |