Class RoleDescriptorImpl
java.lang.Object
org.opensaml.core.xml.AbstractXMLObject
org.opensaml.xmlsec.signature.AbstractSignableXMLObject
org.opensaml.saml.common.AbstractSignableSAMLObject
org.opensaml.saml.saml2.metadata.impl.RoleDescriptorImpl
- All Implemented Interfaces:
AttributeExtensibleXMLObject
,XMLObject
,SAMLObject
,SignableSAMLObject
,CacheableSAMLObject
,TimeBoundSAMLObject
,RoleDescriptor
,SignableXMLObject
- Direct Known Subclasses:
AttributeAuthorityDescriptorImpl
,AuthnAuthorityDescriptorImpl
,PDPDescriptorImpl
,QueryDescriptorTypeImpl
,SSODescriptorImpl
public abstract class RoleDescriptorImpl
extends AbstractSignableSAMLObject
implements RoleDescriptor
Concrete implementation of
RoleDescriptor
.-
Field Summary
Modifier and TypeFieldDescriptionprivate Duration
cacheDurection attribute.private final XMLObjectChildrenList<ContactPerson>
Contact persons for this role.private String
Error URL.private Extensions
Extensions child.private String
ID attribute.private final XMLObjectChildrenList<KeyDescriptor>
Key descriptors for this role.private Organization
Organization administering this role.Set of supported protocols.private final AttributeMap
"anyAttribute" attributes.private Instant
validUntil attribute.Fields inherited from interface org.opensaml.saml.saml2.common.CacheableSAMLObject
CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME
Fields inherited from interface org.opensaml.saml.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.saml.saml2.common.TimeBoundSAMLObject
VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME
-
Constructor Summary
ModifierConstructorDescriptionprotected
RoleDescriptorImpl
(String namespaceURI, String elementLocalName, String namespacePrefix) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSupportedProtocol
(String protocol) Adds a protocol to the list of supported protocols for this role.Gets the maximum time that this descriptor should be cached.Gets list ofContactPerson
s for this role.Gets the URI users should be sent to in the event of an error.Gets the Extensions child of this object.getID()
Gets the ID of this role descriptor.Gets the key descriptors for this role.Gets an unmodifiable list of child elements in the order that they will appear in the DOM.Gets the organization responsible for this role.Gets the value of the ID attribute for this SAML object which will be used as its signature reference.Gets an immutable list of protocol URIs supported by this role.Gets a mutable map of the attributes.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
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
(Duration duration) Sets the maximum time that this descriptor should be cached.void
setErrorURL
(String url) Sets the URI users should be sent to in the event of an error.void
setExtensions
(Extensions ext) Sets the Extensions child of this object.void
Sets the ID of this role descriptor.void
Sets the organization responsible for this role.void
setValidUntil
(Instant dt) Sets the date until which this descriptor is valid.Methods inherited from class org.opensaml.saml.common.AbstractSignableSAMLObject
equals, hashCode, setSignature
Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject
getSignature, isSigned
Methods inherited from class org.opensaml.core.xml.AbstractXMLObject
detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.opensaml.saml.saml2.metadata.RoleDescriptor
getEndpoints, getEndpoints
Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject
getSignature, isSigned, setSignature
Methods inherited from interface org.opensaml.core.xml.XMLObject
detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
-
Field Details
-
id
ID attribute. -
validUntil
validUntil attribute. -
cacheDuration
cacheDurection attribute. -
supportedProtocols
Set of supported protocols. -
errorURL
Error URL. -
extensions
Extensions child. -
organization
Organization administering this role. -
unknownAttributes
"anyAttribute" attributes. -
contactPersons
Contact persons for this role. -
keyDescriptors
Key descriptors for this role.
-
-
Constructor Details
-
RoleDescriptorImpl
protected RoleDescriptorImpl(@Nullable String namespaceURI, @Nonnull String elementLocalName, @Nullable String namespacePrefix) Constructor.- Parameters:
namespaceURI
- the namespace the element is inelementLocalName
- the local name of the XML element this Object representsnamespacePrefix
- the prefix for the given namespace
-
-
Method Details
-
getID
Gets the ID of this role descriptor.- Specified by:
getID
in interfaceRoleDescriptor
- Returns:
- the ID of this role descriptor
-
setID
Sets the ID of this role descriptor.- Specified by:
setID
in interfaceRoleDescriptor
- Parameters:
newID
- the ID of this role descriptor
-
isValid
public boolean isValid()Checks to see if the current time is past the validUntil time.- Specified by:
isValid
in interfaceTimeBoundSAMLObject
- Returns:
- true of this descriptor is still valid otherwise false
-
getValidUntil
Gets the date until which this descriptor is valid.- Specified by:
getValidUntil
in interfaceTimeBoundSAMLObject
- Returns:
- the date until which this descriptor is valid
-
setValidUntil
Sets the date until which this descriptor is valid.- Specified by:
setValidUntil
in interfaceTimeBoundSAMLObject
- Parameters:
dt
- the date until which this descriptor is valid
-
getCacheDuration
Gets the maximum time that this descriptor should be cached.- Specified by:
getCacheDuration
in interfaceCacheableSAMLObject
- Returns:
- the maximum time that this descriptor should be cached
-
setCacheDuration
Sets the maximum time that this descriptor should be cached.- Specified by:
setCacheDuration
in interfaceCacheableSAMLObject
- Parameters:
duration
- the maximum time that this descriptor should be cached
-
getSupportedProtocols
Gets an immutable list of protocol URIs supported by this role.- Specified by:
getSupportedProtocols
in interfaceRoleDescriptor
- Returns:
- list of protocol URIs supported by this role
-
isSupportedProtocol
Chckes to see if the given protocol is supported by this role.- Specified by:
isSupportedProtocol
in interfaceRoleDescriptor
- Parameters:
protocol
- the protocol- Returns:
- true if the protocol is supported, false if not
-
addSupportedProtocol
Adds a protocol to the list of supported protocols for this role.- Specified by:
addSupportedProtocol
in interfaceRoleDescriptor
- Parameters:
protocol
- the protocol
-
removeSupportedProtocol
Removes a protocol to the list of supported protocols for this role.- Specified by:
removeSupportedProtocol
in interfaceRoleDescriptor
- Parameters:
protocol
- the protocol
-
removeSupportedProtocols
Removes a list of protocols to the list of supported protocols for this role.- Specified by:
removeSupportedProtocols
in interfaceRoleDescriptor
- Parameters:
protocols
- the protocol
-
removeAllSupportedProtocols
public void removeAllSupportedProtocols()Removes all the supported protocols from this role.- Specified by:
removeAllSupportedProtocols
in interfaceRoleDescriptor
-
getErrorURL
Gets the URI users should be sent to in the event of an error.- Specified by:
getErrorURL
in interfaceRoleDescriptor
- Returns:
- the URI users should be sent to in the event of an error
-
setErrorURL
Sets the URI users should be sent to in the event of an error.- Specified by:
setErrorURL
in interfaceRoleDescriptor
- Parameters:
url
- the URI users should be sent to in the event of an error
-
getExtensions
Gets the Extensions child of this object.- Specified by:
getExtensions
in interfaceRoleDescriptor
- Returns:
- the Extensions child of this object
-
setExtensions
Sets the Extensions child of this object.- Specified by:
setExtensions
in interfaceRoleDescriptor
- Parameters:
ext
- the Extensions child of this object
-
getOrganization
Gets the organization responsible for this role.- Specified by:
getOrganization
in interfaceRoleDescriptor
- Returns:
- the organization responsible for this role
-
setOrganization
Sets the organization responsible for this role.- Specified by:
setOrganization
in interfaceRoleDescriptor
- Parameters:
org
- the organization responsible for this role
-
getContactPersons
Gets list ofContactPerson
s for this role.- Specified by:
getContactPersons
in interfaceRoleDescriptor
- Returns:
- list of
ContactPerson
s for this role
-
getKeyDescriptors
Gets the key descriptors for this role.- Specified by:
getKeyDescriptors
in interfaceRoleDescriptor
- Returns:
- the key descriptors for this role
-
getUnknownAttributes
Gets a mutable map of the attributes. The map key is the namespace qualified name of the attribute, the map value is the value of the attribute.- Specified by:
getUnknownAttributes
in interfaceAttributeExtensibleXMLObject
- Returns:
- a map of the attributes
-
getSignatureReferenceID
Gets the value of the ID attribute for this SAML object which will be used as its signature reference.- Specified by:
getSignatureReferenceID
in interfaceSignableSAMLObject
- Returns:
- the value of this SAMLObject ID attribute
-
getOrderedChildren
Gets an unmodifiable list of child elements in the order that they will appear in the DOM.- Specified by:
getOrderedChildren
in interfaceXMLObject
- Returns:
- ordered list of child elements
-