org.opensaml.saml2.metadata.impl
Class RoleDescriptorImpl

java.lang.Object
  extended by org.opensaml.xml.AbstractXMLObject
      extended by org.opensaml.xml.signature.AbstractSignableXMLObject
          extended by org.opensaml.xml.AbstractValidatingSignableXMLObject
              extended by org.opensaml.common.impl.AbstractSignableSAMLObject
                  extended by org.opensaml.saml2.metadata.impl.RoleDescriptorImpl
All Implemented Interfaces:
SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, RoleDescriptor, org.opensaml.xml.AttributeExtensibleXMLObject, org.opensaml.xml.signature.SignableXMLObject, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject
Direct Known Subclasses:
AttributeAuthorityDescriptorImpl, AuthnAuthorityDescriptorImpl, PDPDescriptorImpl, QueryDescriptorTypeImpl, SSODescriptorImpl

public abstract class RoleDescriptorImpl
extends AbstractSignableSAMLObject
implements RoleDescriptor

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 ContactPersons 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

RoleDescriptorImpl

protected RoleDescriptorImpl(java.lang.String namespaceURI,
                             java.lang.String elementLocalName,
                             java.lang.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 java.lang.String getID()
Gets the ID of this role descriptor.

Specified by:
getID in interface RoleDescriptor
Returns:
the ID of this role descriptor

setID

public void setID(java.lang.String newID)
Sets the ID of this role descriptor.

Specified by:
setID in interface RoleDescriptor
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 interface TimeBoundSAMLObject
Returns:
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.

Specified by:
getValidUntil in interface TimeBoundSAMLObject
Returns:
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.

Specified by:
setValidUntil in interface TimeBoundSAMLObject
Parameters:
validUntil - the date until which this descriptor is valid

getCacheDuration

public java.lang.Long getCacheDuration()
Gets the maximum time, in milliseconds, that this descriptor should be cached.

Specified by:
getCacheDuration in interface CacheableSAMLObject
Returns:
the maximum time that this descriptor should be cached

setCacheDuration

public void setCacheDuration(java.lang.Long duration)
Sets the maximum time, in milliseconds, that this descriptor should be cached.

Specified by:
setCacheDuration in interface CacheableSAMLObject
Parameters:
duration - the maximum time that this descriptor should be cached

getSupportedProtocols

public java.util.List<java.lang.String> getSupportedProtocols()
Gets an immutable list of protocol URIs supported by this role.

Specified by:
getSupportedProtocols in interface RoleDescriptor
Returns:
list of protocol URIs supported by this role

isSupportedProtocol

public boolean isSupportedProtocol(java.lang.String protocol)
Chckes to see if the given protocol is supported by this role.

Specified by:
isSupportedProtocol in interface RoleDescriptor
Parameters:
protocol - the protocol
Returns:
true if the protocol is supported, false if not

addSupportedProtocol

public void addSupportedProtocol(java.lang.String protocol)
Adds a protocol to the list of supported protocols for this role.

Specified by:
addSupportedProtocol in interface RoleDescriptor
Parameters:
protocol - the protocol

removeSupportedProtocol

public void removeSupportedProtocol(java.lang.String protocol)
Removes a protocol to the list of supported protocols for this role.

Specified by:
removeSupportedProtocol in interface RoleDescriptor
Parameters:
protocol - the protocol

removeSupportedProtocols

public void removeSupportedProtocols(java.util.Collection<java.lang.String> protocols)
Removes a list of protocols to the list of supported protocols for this role.

Specified by:
removeSupportedProtocols in interface RoleDescriptor
Parameters:
protocols - the protocol

removeAllSupportedProtocols

public void removeAllSupportedProtocols()
Removes all the supported protocols from this role.

Specified by:
removeAllSupportedProtocols in interface RoleDescriptor

getErrorURL

public java.lang.String getErrorURL()
Gets the URI users should be sent to in the event of an error.

Specified by:
getErrorURL in interface RoleDescriptor
Returns:
the URI users should be sent to in the event of an error

setErrorURL

public void setErrorURL(java.lang.String errorURL)
Sets the URI users should be sent to in the event of an error.

Specified by:
setErrorURL in interface RoleDescriptor
Parameters:
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.

Specified by:
getExtensions in interface RoleDescriptor
Returns:
the Extensions child of this object

setExtensions

public void setExtensions(Extensions extensions)
                   throws java.lang.IllegalArgumentException
Sets the Extensions child of this object.

Specified by:
setExtensions in interface RoleDescriptor
Parameters:
extensions - the Extensions child of this object
Throws:
java.lang.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.

Specified by:
getOrganization in interface RoleDescriptor
Returns:
the organization responsible for this role

setOrganization

public void setOrganization(Organization organization)
                     throws java.lang.IllegalArgumentException
Sets the organization responsible for this role.

Specified by:
setOrganization in interface RoleDescriptor
Parameters:
organization - the organization responsible for this role
Throws:
java.lang.IllegalArgumentException - thrown if the given organization is owned by another element

getContactPersons

public java.util.List<ContactPerson> getContactPersons()
Gets an immutable list of ContactPersons for this role.

Specified by:
getContactPersons in interface RoleDescriptor
Returns:
list of ContactPersons for this role

getKeyDescriptors

public java.util.List<KeyDescriptor> getKeyDescriptors()
Gets the key descriptors for this role.

Specified by:
getKeyDescriptors in interface RoleDescriptor
Returns:
the key descriptors for this role

getUnknownAttributes

public org.opensaml.xml.util.AttributeMap getUnknownAttributes()

Specified by:
getUnknownAttributes in interface org.opensaml.xml.AttributeExtensibleXMLObject

getSignatureReferenceID

public java.lang.String getSignatureReferenceID()
Gets the value of the ID attribute for this SAML object which will be used as its signature reference.

Specified by:
getSignatureReferenceID in interface SignableSAMLObject
Returns:
the value of this SAMLObject ID attribute

getOrderedChildren

public java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()

Specified by:
getOrderedChildren in interface org.opensaml.xml.XMLObject


Copyright © 2006-2012 Internet2. All Rights Reserved.