org.opensaml.saml2.metadata.impl
Class SPSSODescriptorImpl

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
                      extended by org.opensaml.saml2.metadata.impl.SSODescriptorImpl
                          extended by org.opensaml.saml2.metadata.impl.SPSSODescriptorImpl
All Implemented Interfaces:
SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, RoleDescriptor, SPSSODescriptor, SSODescriptor, AttributeExtensibleXMLObject, SignableXMLObject, ValidatingXMLObject, XMLObject

public class SPSSODescriptorImpl
extends SSODescriptorImpl
implements SPSSODescriptor

Concrete implementation of SPSSODescriptor.


Field Summary
private  XMLObjectChildrenList<AssertionConsumerService> assertionConsumerServices
          AssertionConsumerService children.
private  XSBooleanValue assertionSigned
          value for the want assertion signed attribute.
private  XMLObjectChildrenList<AttributeConsumingService> attributeConsumingServices
          AttributeConsumingService children.
private  XSBooleanValue authnRequestSigned
          value for isAuthnRequestSigned attribute.
 
Fields inherited from interface org.opensaml.saml2.metadata.SPSSODescriptor
AUTH_REQUESTS_SIGNED_ATTRIB_NAME, DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, TYPE_LOCAL_NAME, TYPE_NAME, WANT_ASSERTIONS_SIGNED_ATTRIB_NAME
 
Fields inherited from interface org.opensaml.saml2.metadata.RoleDescriptor
ERROR_URL_ATTRIB_NAME, ID_ATTRIB_NAME, PROTOCOL_ENUMERATION_ATTRIB_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 SPSSODescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)
          Constructor.
 
Method Summary
 List<AssertionConsumerService> getAssertionConsumerServices()
          Gets an list of assertion consumer service Endpoints for this service.
 List<AttributeConsumingService> getAttributeConsumingServices()
          Gets an list of attribute consuming service descriptors for this service.
 AssertionConsumerService getDefaultAssertionConsumerService()
          Gets the default assertion consumer service.
 AttributeConsumingService getDefaultAttributeConsumingService()
          Gets the default attribute consuming service.
 List<Endpoint> getEndpoints()
          Gets a read-only list of endpoints for this role.
 List<Endpoint> getEndpoints(QName type)
          Gets a read-only list of endpoints for this role for the given type.
 List<XMLObject> getOrderedChildren()
          
 Boolean getWantAssertionsSigned()
          Gets whether this service wants assertions signed.
 XSBooleanValue getWantAssertionsSignedXSBoolean()
          Gets whether this service wants assertions signed.
 Boolean isAuthnRequestsSigned()
          Gets whether this service signs AuthN requests.
 XSBooleanValue isAuthnRequestsSignedXSBoolean()
          Gets whether this service signs AuthN requests.
 void setAuthnRequestsSigned(Boolean newIsSigned)
          Sets whether this service signs AuthN requests.
 void setAuthnRequestsSigned(XSBooleanValue isSigned)
          Sets whether this service signs AuthN requests.
 void setWantAssertionsSigned(Boolean wantAssestionSigned)
          Sets whether this service wants assertions signed.
 void setWantAssertionsSigned(XSBooleanValue wantAssestionSigned)
          Sets whether this service wants assertions signed.
 
Methods inherited from class org.opensaml.saml2.metadata.impl.SSODescriptorImpl
getArtifactResolutionServices, getDefaultArtifactResolutionService, getDefaultArtificateResolutionService, getManageNameIDServices, getNameIDFormats, getSingleLogoutServices
 
Methods inherited from class org.opensaml.saml2.metadata.impl.RoleDescriptorImpl
addSupportedProtocol, getCacheDuration, getContactPersons, getErrorURL, getExtensions, getID, getKeyDescriptors, getOrganization, getSignatureReferenceID, getSupportedProtocols, getUnknownAttributes, getValidUntil, isSupportedProtocol, isValid, removeAllSupportedProtocols, removeSupportedProtocol, removeSupportedProtocols, setCacheDuration, setErrorURL, setExtensions, setID, setOrganization, setValidUntil
 
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, 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
 
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.SSODescriptor
getArtifactResolutionServices, getDefaultArtifactResolutionService, getDefaultArtificateResolutionService, getManageNameIDServices, getNameIDFormats, getSingleLogoutServices
 
Methods inherited from interface org.opensaml.saml2.metadata.RoleDescriptor
addSupportedProtocol, getContactPersons, getErrorURL, getExtensions, getID, getKeyDescriptors, getOrganization, getSupportedProtocols, isSupportedProtocol, removeAllSupportedProtocols, removeSupportedProtocol, removeSupportedProtocols, setErrorURL, setExtensions, setID, setOrganization
 
Methods inherited from interface org.opensaml.common.SignableSAMLObject
getSignatureReferenceID
 
Methods inherited from interface org.opensaml.xml.signature.SignableXMLObject
getSignature, isSigned, setSignature
 
Methods inherited from interface org.opensaml.saml2.common.TimeBoundSAMLObject
getValidUntil, isValid, setValidUntil
 
Methods inherited from interface org.opensaml.saml2.common.CacheableSAMLObject
getCacheDuration, setCacheDuration
 
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, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
 
Methods inherited from interface org.opensaml.xml.AttributeExtensibleXMLObject
getUnknownAttributes
 

Field Detail

authnRequestSigned

private XSBooleanValue authnRequestSigned
value for isAuthnRequestSigned attribute.


assertionSigned

private XSBooleanValue assertionSigned
value for the want assertion signed attribute.


assertionConsumerServices

private final XMLObjectChildrenList<AssertionConsumerService> assertionConsumerServices
AssertionConsumerService children.


attributeConsumingServices

private final XMLObjectChildrenList<AttributeConsumingService> attributeConsumingServices
AttributeConsumingService children.

Constructor Detail

SPSSODescriptorImpl

protected SPSSODescriptorImpl(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

isAuthnRequestsSigned

public Boolean isAuthnRequestsSigned()
Gets whether this service signs AuthN requests.

Specified by:
isAuthnRequestsSigned in interface SPSSODescriptor
Returns:
true of this service signs requests, false if not

isAuthnRequestsSignedXSBoolean

public XSBooleanValue isAuthnRequestsSignedXSBoolean()
Gets whether this service signs AuthN requests.

Specified by:
isAuthnRequestsSignedXSBoolean in interface SPSSODescriptor
Returns:
true of this service signs requests, false if not

setAuthnRequestsSigned

public void setAuthnRequestsSigned(Boolean newIsSigned)
Sets whether this service signs AuthN requests. Boolean values will be marshalled to either "true" or "false".

Specified by:
setAuthnRequestsSigned in interface SPSSODescriptor
Parameters:
newIsSigned - true of this service signs requests, false if not

setAuthnRequestsSigned

public void setAuthnRequestsSigned(XSBooleanValue isSigned)
Sets whether this service signs AuthN requests.

Specified by:
setAuthnRequestsSigned in interface SPSSODescriptor
Parameters:
isSigned - true of this service signs requests, false if not

getWantAssertionsSigned

public Boolean getWantAssertionsSigned()
Gets whether this service wants assertions signed.

Specified by:
getWantAssertionsSigned in interface SPSSODescriptor
Returns:
true if this service wants assertions signed, false if not

getWantAssertionsSignedXSBoolean

public XSBooleanValue getWantAssertionsSignedXSBoolean()
Gets whether this service wants assertions signed.

Specified by:
getWantAssertionsSignedXSBoolean in interface SPSSODescriptor
Returns:
true if this service wants assertions signed, false if not

setWantAssertionsSigned

public void setWantAssertionsSigned(Boolean wantAssestionSigned)
Sets whether this service wants assertions signed. Boolean values will be marshalled to either "true" or "false".

Specified by:
setWantAssertionsSigned in interface SPSSODescriptor
Parameters:
wantAssestionSigned - true if this service wants assertions signed, false if not

setWantAssertionsSigned

public void setWantAssertionsSigned(XSBooleanValue wantAssestionSigned)
Sets whether this service wants assertions signed.

Specified by:
setWantAssertionsSigned in interface SPSSODescriptor
Parameters:
wantAssestionSigned - true if this service wants assertions signed, false if not

getAssertionConsumerServices

public List<AssertionConsumerService> getAssertionConsumerServices()
Gets an list of assertion consumer service Endpoints for this service.

Specified by:
getAssertionConsumerServices in interface SPSSODescriptor
Returns:
list of assertion consumer service Endpoints for this service

getDefaultAssertionConsumerService

public AssertionConsumerService getDefaultAssertionConsumerService()
Gets the default assertion consumer service.

The selection algorithm used is:

  1. Select the first service with an explicit isDefault=true
  2. Select the first service with no explicit isDefault
  3. Select the first service

Specified by:
getDefaultAssertionConsumerService in interface SPSSODescriptor
Returns:
default assertion consumer service (or null if there are no assertion consumer services defined)

getAttributeConsumingServices

public List<AttributeConsumingService> getAttributeConsumingServices()
Gets an list of attribute consuming service descriptors for this service.

Specified by:
getAttributeConsumingServices in interface SPSSODescriptor
Returns:
list of attribute consuming service descriptors for this service

getDefaultAttributeConsumingService

public AttributeConsumingService getDefaultAttributeConsumingService()
Gets the default attribute consuming service.

The selection algorithm used is:

  1. Select the first service with an explicit isDefault=true
  2. Select the first service with no explicit isDefault
  3. Select the first service

Specified by:
getDefaultAttributeConsumingService in interface SPSSODescriptor
Returns:
default attribute consuming service (or null if there are no attribute consuming services defined)

getEndpoints

public List<Endpoint> getEndpoints()
Gets a read-only list of endpoints for this role.

Specified by:
getEndpoints in interface RoleDescriptor
Overrides:
getEndpoints in class SSODescriptorImpl
Returns:
immutable list of endpoints for this role

getEndpoints

public List<Endpoint> getEndpoints(QName type)
Gets a read-only list of endpoints for this role for the given type.

Specified by:
getEndpoints in interface RoleDescriptor
Overrides:
getEndpoints in class SSODescriptorImpl
Parameters:
type - the type of endpoints to retrieve
Returns:
immutable list of endpoints for this role

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Specified by:
getOrderedChildren in interface XMLObject
Overrides:
getOrderedChildren in class SSODescriptorImpl


Copyright © 1999-2013. All Rights Reserved.