se.litsec.eidas.opensaml.metadata

Interface MetadataLocation

All Superinterfaces:

AttributeExtensibleXMLObject, SAMLObject, XMLObject

All Known Implementing Classes:

MetadataLocationImpl

public interface MetadataLocation
extends SAMLObject, AttributeExtensibleXMLObject

Definition of the MetadataLocation type. The following schema fragment defines the MetadataLocationType complex type:

 
  <xs:complexType name="MetadataLocationType">
    <xs:sequence>
      <xs:element name="Endpoint" type="ser:MsEndpointType" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>
            A list of eIDAS endpoints (nodes) for the current location.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="ds:KeyInfo" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
            Key material (usually a certificate) that should be used to verify the signature
            of the downloaded metadata for this metadata location.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="Location" type="xs:anyURI" use="required">
      <xs:annotation>
        <xs:documentation>
          The URL from where the metadata for the endpoint(s) can be obtained.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:anyAttribute namespace="##any" processContents="lax" />
  </xs:complexType>
 

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ELEMENT_LOCAL_NAME Name of the element.
static QName	DEFAULT_ELEMENT_NAME Default element name.
static String	LOCATION_ATTR_NAME Attribute label for the Location attribute.
static String	TYPE_LOCAL_NAME Local name of the XSI type.
static QName	TYPE_NAME QName of the XSI type.

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.
boolean	getSuspend() For the Swedish eIDAS configuration, a flag, Suspend is used to indicate whether an endpoint has been suspended.
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 setKeyInfo(KeyInfo).

Methods inherited from interface org.opensaml.core.xml.AttributeExtensibleXMLObject

getUnknownAttributes

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Name of the element.

See Also:

Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

LOCATION_ATTR_NAME

static final String LOCATION_ATTR_NAME

Attribute label for the Location attribute.

See Also:

Constant Field Values

Method Detail

getEndpoints

List<Endpoint> getEndpoints()

Returns the list of endpoints.

Returns:

endpoint list

getKeyInfo

KeyInfo getKeyInfo()

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

Returns:

key info element, or null

setKeyInfo

void setKeyInfo(KeyInfo keyInfo)

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

Parameters:

keyInfo - key info element

See Also:

setX509Certificate(X509Certificate)

setX509Certificate

void setX509Certificate(X509Certificate certificate)

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

Parameters:

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

getLocation

String getLocation()

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

Returns:

URL

setLocation

void setLocation(String location)

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

Parameters:

location - URL

getSuspend

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().

Returns:

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

setSuspend

void setSuspend(boolean suspendFlag)

Assigns the Suspend flag. See getSuspend().

Parameters:

suspendFlag - the suspend flag