org.opensaml.saml2.metadata.impl

クラス RoleDescriptorImpl

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

すべての実装されたインタフェース:

SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, RoleDescriptor, AttributeExtensibleXMLObject, SignableXMLObject, ValidatingXMLObject, XMLObject

直系の既知のサブクラス:

AttributeAuthorityDescriptorImpl, AuthnAuthorityDescriptorImpl, PDPDescriptorImpl, QueryDescriptorTypeImpl, SSODescriptorImpl

public abstract class RoleDescriptorImpl
extends AbstractSignableSAMLObject
implements RoleDescriptor

Concrete implementation of RoleDescriptor.

フィールドの概要

インタフェースから継承されたフィールド 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

インタフェースから継承されたフィールド org.opensaml.saml2.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

インタフェースから継承されたフィールド org.opensaml.saml2.common.CacheableSAMLObject

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

コンストラクタの概要

コンストラクタ

修飾子	コンストラクタと説明
protected	RoleDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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 ContactPersons 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() Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
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() Gets a mutable map of the attributes.
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.

クラスから継承されたメソッド org.opensaml.common.impl.AbstractSignableSAMLObject

equals, prepareForAssignment, setSignature

クラスから継承されたメソッド org.opensaml.xml.AbstractValidatingSignableXMLObject

deregisterValidator, getValidators, registerValidator, validate, validateChildren

クラスから継承されたメソッド org.opensaml.xml.signature.AbstractSignableXMLObject

getSignature, isSigned

クラスから継承されたメソッド org.opensaml.xml.AbstractXMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.opensaml.saml2.metadata.RoleDescriptor

getEndpoints, getEndpoints

インタフェースから継承されたメソッド org.opensaml.xml.signature.SignableXMLObject

getSignature, isSigned, setSignature

インタフェースから継承されたメソッド org.opensaml.xml.validation.ValidatingXMLObject

deregisterValidator, getValidators, registerValidator, validate

インタフェースから継承されたメソッド 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

コンストラクタの詳細

RoleDescriptorImpl

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

Constructor.

パラメータ:

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

メソッドの詳細

getID

public String getID()

Gets the ID of this role descriptor.

定義:

getID インタフェース内 RoleDescriptor

戻り値:

the ID of this role descriptor

setID

public void setID(String newID)

Sets the ID of this role descriptor.

定義:

setID インタフェース内 RoleDescriptor

パラメータ:

newID - the ID of this role descriptor

isValid

public boolean isValid()

Checks to see if the current time is past the validUntil time.

定義:

isValid インタフェース内 TimeBoundSAMLObject

戻り値:

true of this descriptor is still valid otherwise false

getValidUntil

public org.joda.time.DateTime getValidUntil()

Gets the date until which this descriptor is valid.

定義:

getValidUntil インタフェース内 TimeBoundSAMLObject

戻り値:

the date until which this descriptor is valid

setValidUntil

public void setValidUntil(org.joda.time.DateTime validUntil)

Sets the date until which this descriptor is valid.

定義:

setValidUntil インタフェース内 TimeBoundSAMLObject

パラメータ:

validUntil - the date until which this descriptor is valid

getCacheDuration

public Long getCacheDuration()

Gets the maximum time, in milliseconds, that this descriptor should be cached.

定義:

getCacheDuration インタフェース内 CacheableSAMLObject

戻り値:

the maximum time that this descriptor should be cached

setCacheDuration

public void setCacheDuration(Long duration)

Sets the maximum time, in milliseconds, that this descriptor should be cached.

定義:

setCacheDuration インタフェース内 CacheableSAMLObject

パラメータ:

duration - the maximum time that this descriptor should be cached

getSupportedProtocols

public List<String> getSupportedProtocols()

Gets an immutable list of protocol URIs supported by this role.

定義:

getSupportedProtocols インタフェース内 RoleDescriptor

戻り値:

list of protocol URIs supported by this role

isSupportedProtocol

public boolean isSupportedProtocol(String protocol)

Chckes to see if the given protocol is supported by this role.

定義:

isSupportedProtocol インタフェース内 RoleDescriptor

パラメータ:

protocol - the protocol

戻り値:

true if the protocol is supported, false if not

addSupportedProtocol

public void addSupportedProtocol(String protocol)

Adds a protocol to the list of supported protocols for this role.

定義:

addSupportedProtocol インタフェース内 RoleDescriptor

パラメータ:

protocol - the protocol

removeSupportedProtocol

public void removeSupportedProtocol(String protocol)

Removes a protocol to the list of supported protocols for this role.

定義:

removeSupportedProtocol インタフェース内 RoleDescriptor

パラメータ:

protocol - the protocol

removeSupportedProtocols

public void removeSupportedProtocols(Collection<String> protocols)

Removes a list of protocols to the list of supported protocols for this role.

定義:

removeSupportedProtocols インタフェース内 RoleDescriptor

パラメータ:

protocols - the protocol

removeAllSupportedProtocols

public void removeAllSupportedProtocols()

Removes all the supported protocols from this role.

定義:

removeAllSupportedProtocols インタフェース内 RoleDescriptor

getErrorURL

public String getErrorURL()

Gets the URI users should be sent to in the event of an error.

定義:

getErrorURL インタフェース内 RoleDescriptor

戻り値:

the URI users should be sent to in the event of an error

setErrorURL

public void setErrorURL(String errorURL)

Sets the URI users should be sent to in the event of an error.

定義:

setErrorURL インタフェース内 RoleDescriptor

パラメータ:

errorURL - the URI users should be sent to in the event of an error

getExtensions

public Extensions getExtensions()

Gets the Extensions child of this object.

定義:

getExtensions インタフェース内 RoleDescriptor

戻り値:

the Extensions child of this object

setExtensions

public void setExtensions(Extensions extensions)
                   throws IllegalArgumentException

Sets the Extensions child of this object.

定義:

setExtensions インタフェース内 RoleDescriptor

パラメータ:

extensions - the Extensions child of this object

例外:

IllegalArgumentException - thrown if the given extensions Object is already a child of another SAMLObject

getOrganization

public Organization getOrganization()

Gets the organization responsible for this role.

定義:

getOrganization インタフェース内 RoleDescriptor

戻り値:

the organization responsible for this role

setOrganization

public void setOrganization(Organization organization)
                     throws IllegalArgumentException

Sets the organization responsible for this role.

定義:

setOrganization インタフェース内 RoleDescriptor

パラメータ:

organization - the organization responsible for this role

例外:

IllegalArgumentException - thrown if the given organization is owned by another element

getContactPersons

public List<ContactPerson> getContactPersons()

Gets an immutable list of ContactPersons for this role.

定義:

getContactPersons インタフェース内 RoleDescriptor

戻り値:

list of ContactPersons for this role

getKeyDescriptors

public List<KeyDescriptor> getKeyDescriptors()

Gets the key descriptors for this role.

定義:

getKeyDescriptors インタフェース内 RoleDescriptor

戻り値:

the key descriptors for this role

getUnknownAttributes

public AttributeMap 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.

定義:

getUnknownAttributes インタフェース内 AttributeExtensibleXMLObject

戻り値:

a map of the attributes

getSignatureReferenceID

public String getSignatureReferenceID()

Gets the value of the ID attribute for this SAML object which will be used as its signature reference.

定義:

getSignatureReferenceID インタフェース内 SignableSAMLObject

戻り値:

the value of this SAMLObject ID attribute

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Gets an unmodifiable list of child elements in the order that they will appear in the DOM.

定義:

getOrderedChildren インタフェース内 XMLObject

戻り値:

ordered list of child elements