se.litsec.eidas.opensaml.metadata.impl

Class MetadataLocationImpl

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.saml.common.AbstractSAMLObject

se.litsec.eidas.opensaml.metadata.impl.MetadataLocationImpl

All Implemented Interfaces:

AttributeExtensibleXMLObject, XMLObject, SAMLObject, MetadataLocation

public class MetadataLocationImpl
extends AbstractSAMLObject
implements MetadataLocation

Implementation class for MetadataLocation.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Field Summary

Fields inherited from interface se.litsec.eidas.opensaml.metadata.MetadataLocation

DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, LOCATION_ATTR_NAME, TYPE_LOCAL_NAME, TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
MetadataLocationImpl(String namespaceURI, String elementLocalName, String namespacePrefix) Constructor.

Method Summary

Modifier and Type	Method and Description
List<Endpoint>	getEndpoints() Returns the list of endpoints.
KeyInfo	getKeyInfo() Returns the key info element to be used when verifying downloaded metadata.
String	getLocation() Returns the location attribute, i.e., the URL from where the metadata endpoint(s) can be obtained.
List<XMLObject>	getOrderedChildren()
boolean	getSuspend() For the Swedish eIDAS configuration, a flag, Suspend is used to indicate whether an endpoint has been suspended.
AttributeMap	getUnknownAttributes()
void	setKeyInfo(KeyInfo keyInfo) Assigns the key info element to be used when verifying downloaded metadata.
void	setLocation(String location) Assigns the location attribute, i.e., the URL from where the metadata endpoint(s) can be obtained.
void	setSuspend(boolean suspendFlag) Assigns the Suspend flag.
void	setX509Certificate(X509Certificate certificate) Utility method that creates a KeyInfo object and assigns the supplied certificate to it before invoking MetadataLocation.setKeyInfo(KeyInfo).

Methods inherited from class org.opensaml.saml.common.AbstractSAMLObject

equals, hashCode, prepareForAssignment

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

Constructor Detail

MetadataLocationImpl

public MetadataLocationImpl(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

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject

getEndpoints

public List<Endpoint> getEndpoints()

Returns the list of endpoints.

Specified by:

getEndpoints in interface MetadataLocation

Returns:

endpoint list

getKeyInfo

public KeyInfo getKeyInfo()

Returns the key info element to be used when verifying downloaded metadata.

Specified by:

getKeyInfo in interface MetadataLocation

Returns:

key info element, or null

setKeyInfo

public void setKeyInfo(KeyInfo keyInfo)

Assigns the key info element to be used when verifying downloaded metadata.

Specified by:

setKeyInfo in interface MetadataLocation

Parameters:

keyInfo - key info element

See Also:

MetadataLocation.setX509Certificate(X509Certificate)

setX509Certificate

public void setX509Certificate(X509Certificate certificate)

Utility method that creates a KeyInfo object and assigns the supplied certificate to it before invoking MetadataLocation.setKeyInfo(KeyInfo).

Specified by:

setX509Certificate in interface MetadataLocation

Parameters:

certificate - the X.509 certificate to assign to a key info

getLocation

public String getLocation()

Returns the location attribute, i.e., the URL from where the metadata endpoint(s) can be obtained.

Specified by:

getLocation in interface MetadataLocation

Returns:

URL

setLocation

public void setLocation(String location)

Assigns the location attribute, i.e., the URL from where the metadata endpoint(s) can be obtained.

Specified by:

setLocation in interface MetadataLocation

Parameters:

location - URL

getSuspend

public boolean getSuspend()

For the Swedish eIDAS configuration, a flag, Suspend is used to indicate whether an endpoint has been suspended. This method is just a short cut instead of using AttributeExtensibleXMLObject.getUnknownAttributes().

Specified by:

getSuspend in interface MetadataLocation

Returns:

if the Suspend flag has been set to true this method returns true, otherwise false

setSuspend

public void setSuspend(boolean suspendFlag)

Assigns the Suspend flag. See MetadataLocation.getSuspend().

Specified by:

setSuspend in interface MetadataLocation

Parameters:

suspendFlag - the suspend flag

getUnknownAttributes

public AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject