Package org.opensaml.saml.saml2.metadata.impl

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

Fields

Modifier and Type	Field	Description
private Duration	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 Instant	validUntil	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

Constructors

Modifier	Constructor	Description
protected	RoleDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addSupportedProtocol(String protocol)
Duration	getCacheDuration()
List<ContactPerson>	getContactPersons()
String	getErrorURL()
Extensions	getExtensions()
String	getID()
List<KeyDescriptor>	getKeyDescriptors()
List<XMLObject>	getOrderedChildren()
Organization	getOrganization()
String	getSignatureReferenceID()
List<String>	getSupportedProtocols()
AttributeMap	getUnknownAttributes()
Instant	getValidUntil()
boolean	isSupportedProtocol(String protocol)
boolean	isValid()
void	removeAllSupportedProtocols()
void	removeSupportedProtocol(String protocol)
void	removeSupportedProtocols(Collection<String> protocols)
void	setCacheDuration(Duration duration)
void	setErrorURL(String url)
void	setExtensions(Extensions ext)
void	setID(String newID)
void	setOrganization(Organization org)
void	setValidUntil(Instant dt)

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, 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, 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 Detail

id

private String id

ID attribute.

validUntil

private Instant validUntil

validUntil attribute.

cacheDuration

private Duration cacheDuration

cacheDurection attribute.

supportedProtocols

private final List<String> supportedProtocols

Set of supported protocols.

errorURL

private String errorURL

Error URL.

extensions

private Extensions extensions

Extensions child.

organization

private Organization organization

Organization administering this role.

unknownAttributes

private final AttributeMap unknownAttributes

"anyAttribute" attributes.

contactPersons

private final XMLObjectChildrenList<ContactPerson> contactPersons

Contact persons for this role.

keyDescriptors

private final XMLObjectChildrenList<KeyDescriptor> keyDescriptors

Key descriptors for this role.

Constructor Detail

RoleDescriptorImpl

protected RoleDescriptorImpl(String namespaceURI,
                             String elementLocalName,
                             String namespacePrefix)

Constructor.

Parameters:

namespaceURI - the namespace the element is in

elementLocalName - the local name of the XML element this Object represents

namespacePrefix - the prefix for the given namespace

Method Detail

getID

public String getID()

Specified by:

getID in interface RoleDescriptor

setID

public void setID(String newID)

Specified by:

setID in interface RoleDescriptor

isValid

public boolean isValid()

Specified by:

isValid in interface TimeBoundSAMLObject

getValidUntil

public Instant getValidUntil()

Specified by:

getValidUntil in interface TimeBoundSAMLObject

setValidUntil

public void setValidUntil(Instant dt)

Specified by:

setValidUntil in interface TimeBoundSAMLObject

getCacheDuration

public Duration getCacheDuration()

Specified by:

getCacheDuration in interface CacheableSAMLObject

setCacheDuration

public void setCacheDuration(Duration duration)

Specified by:

setCacheDuration in interface CacheableSAMLObject

getSupportedProtocols

public List<String> getSupportedProtocols()

Specified by:

getSupportedProtocols in interface RoleDescriptor

isSupportedProtocol

public boolean isSupportedProtocol(String protocol)

Specified by:

isSupportedProtocol in interface RoleDescriptor

addSupportedProtocol

public void addSupportedProtocol(String protocol)

Specified by:

addSupportedProtocol in interface RoleDescriptor

removeSupportedProtocol

public void removeSupportedProtocol(String protocol)

Specified by:

removeSupportedProtocol in interface RoleDescriptor

removeSupportedProtocols

public void removeSupportedProtocols(Collection<String> protocols)

Specified by:

removeSupportedProtocols in interface RoleDescriptor

removeAllSupportedProtocols

public void removeAllSupportedProtocols()

Specified by:

removeAllSupportedProtocols in interface RoleDescriptor

getErrorURL

public String getErrorURL()

Specified by:

getErrorURL in interface RoleDescriptor

setErrorURL

public void setErrorURL(String url)

Specified by:

setErrorURL in interface RoleDescriptor

getExtensions

public Extensions getExtensions()

Specified by:

getExtensions in interface RoleDescriptor

setExtensions

public void setExtensions(Extensions ext)

Specified by:

setExtensions in interface RoleDescriptor

getOrganization

public Organization getOrganization()

Specified by:

getOrganization in interface RoleDescriptor

setOrganization

public void setOrganization(Organization org)

Specified by:

setOrganization in interface RoleDescriptor

getContactPersons

public List<ContactPerson> getContactPersons()

Specified by:

getContactPersons in interface RoleDescriptor

getKeyDescriptors

public List<KeyDescriptor> getKeyDescriptors()

Specified by:

getKeyDescriptors in interface RoleDescriptor

getUnknownAttributes

public AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

getSignatureReferenceID

public String getSignatureReferenceID()

Specified by:

getSignatureReferenceID in interface SignableSAMLObject

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject