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 final XMLObjectChildrenList<ContactPerson>	contactPersons	Contact persons for this role.
private String	errorURL	Error URL.
private Extensions	extensions	Extensions child.
private String	id	ID attribute.
private final XMLObjectChildrenList<KeyDescriptor>	keyDescriptors	Key descriptors for this role.
private Organization	organization	Organization administering this role.
private final List<String>	supportedProtocols	Set of supported protocols.
private final 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, 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

@Nullable
private String id

ID attribute.

validUntil

@Nullable
private Instant validUntil

validUntil attribute.

cacheDuration

@Nullable
private Duration cacheDuration

cacheDurection attribute.

supportedProtocols

@Nonnull
private final List<String> supportedProtocols

Set of supported protocols.

errorURL

@Nullable
private String errorURL

Error URL.

extensions

@Nullable
private Extensions extensions

Extensions child.

organization

@Nullable
private Organization organization

Organization administering this role.

unknownAttributes

@Nonnull
private final AttributeMap unknownAttributes

"anyAttribute" attributes.

contactPersons

@Nonnull
private final XMLObjectChildrenList<ContactPerson> contactPersons

Contact persons for this role.

keyDescriptors

@Nonnull
private final XMLObjectChildrenList<KeyDescriptor> 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 in

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

namespacePrefix - the prefix for the given namespace

Method Details

getID

@Nullable
public String getID()

Specified by:

getID in interface RoleDescriptor

setID

public void setID(@Nullable
 String newID)

Specified by:

setID in interface RoleDescriptor

isValid

public boolean isValid()

Specified by:

isValid in interface TimeBoundSAMLObject

getValidUntil

@Nullable
public Instant getValidUntil()

Specified by:

getValidUntil in interface TimeBoundSAMLObject

setValidUntil

public void setValidUntil(@Nullable
 Instant dt)

Specified by:

setValidUntil in interface TimeBoundSAMLObject

getCacheDuration

@Nullable
public Duration getCacheDuration()

Specified by:

getCacheDuration in interface CacheableSAMLObject

setCacheDuration

public void setCacheDuration(@Nullable
 Duration duration)

Specified by:

setCacheDuration in interface CacheableSAMLObject

getSupportedProtocols

@Nonnull
@NotLive
@Unmodifiable
public List<String> getSupportedProtocols()

Specified by:

getSupportedProtocols in interface RoleDescriptor

isSupportedProtocol

public boolean isSupportedProtocol(@Nonnull @NotEmpty
 String protocol)

Specified by:

isSupportedProtocol in interface RoleDescriptor

addSupportedProtocol

public void addSupportedProtocol(@Nonnull @NotEmpty
 String protocol)

Specified by:

addSupportedProtocol in interface RoleDescriptor

removeSupportedProtocol

public void removeSupportedProtocol(@Nonnull @NotEmpty
 String protocol)

Specified by:

removeSupportedProtocol in interface RoleDescriptor

removeSupportedProtocols

public void removeSupportedProtocols(@Nonnull
 Collection<String> protocols)

Specified by:

removeSupportedProtocols in interface RoleDescriptor

removeAllSupportedProtocols

public void removeAllSupportedProtocols()

Specified by:

removeAllSupportedProtocols in interface RoleDescriptor

getErrorURL

@Nullable
public String getErrorURL()

Specified by:

getErrorURL in interface RoleDescriptor

setErrorURL

public void setErrorURL(@Nullable
 String url)

Specified by:

setErrorURL in interface RoleDescriptor

getExtensions

@Nullable
public Extensions getExtensions()

Specified by:

getExtensions in interface RoleDescriptor

setExtensions

public void setExtensions(@Nullable
 Extensions ext)

Specified by:

setExtensions in interface RoleDescriptor

getOrganization

@Nullable
public Organization getOrganization()

Specified by:

getOrganization in interface RoleDescriptor

setOrganization

public void setOrganization(@Nullable
 Organization org)

Specified by:

setOrganization in interface RoleDescriptor

getContactPersons

@Nonnull
@Live
public List<ContactPerson> getContactPersons()

Specified by:

getContactPersons in interface RoleDescriptor

getKeyDescriptors

@Nonnull
@Live
public List<KeyDescriptor> getKeyDescriptors()

Specified by:

getKeyDescriptors in interface RoleDescriptor

getUnknownAttributes

@Nonnull
public AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

getSignatureReferenceID

@Nullable
public String getSignatureReferenceID()

Specified by:

getSignatureReferenceID in interface SignableSAMLObject

getOrderedChildren

@Nullable
@NotLive
@Unmodifiable
public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject