Package se.swedenconnect.opensaml.eidas.metadata

Interface Endpoint

All Superinterfaces:

org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.XMLObject

All Known Implementing Classes:

EndpointImpl

public interface Endpoint
extends org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.AttributeExtensibleXMLObject

Definition of the MsEndpointType type.

The following schema fragment defines the MsEndpointType complex type:

 
 <xs:complexType name="MsEndpointType">
   <xs:annotation>
     <xs:documentation>
       Defines a member state "endpoint" (eIDAS node).
     </xs:documentation>
   </xs:annotation>
   <xs:attribute name="EndpointType" type="xs:anyURI" use="required">
     <xs:annotation>
       <xs:documentation>
         The type of endpoint. Currently defined URI:s are:
         http://eidas.europa.eu/metadata/ept/ProxyService for an eIDAS Proxy Service, and,
         http://eidas.europa.eu/metadata/ept/Connector for an eIDAS Connector.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
   <xs:attribute name="EntityID" type="xs:anyURI" use="required">
     <xs:annotation>
       <xs:documentation>
         The SAML entityID of the endpoint. For an eIDAS connector this is the entityID for
         the SP-part of the node, and for an eIDAS Proxy Service this is the entityID for the
         IdP-part of the node.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
   <xs:anyAttribute namespace="##any" processContents="lax" />
 </xs:complexType>
 

Author:

Martin Lindström

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTOR_ENDPOINT_TYPE	Identifier for a connector endpoint type.
static final String	DEFAULT_ELEMENT_LOCAL_NAME	Name of the element.
static final QName	DEFAULT_ELEMENT_NAME	Default element name.
static final String	ENDPOINT_TYPE_ATTR_NAME	Attribute label for the Location attribute.
static final String	ENTITY_ID_ATTR_NAME	Attribute label for the Location attribute.
static final String	PROXY_SERVICE_ENDPOINT_TYPE	Identifier for a proxy service endpoint type.
static final String	TYPE_LOCAL_NAME	Local name of the XSI type.
static final QName	TYPE_NAME	QName of the XSI type.

Method Summary

Modifier and Type	Method	Description
String	getEndpointType()	Returns the endpoint type URI.
String	getEntityID()	Returns the entityID for the endpoint.
boolean	getHideFromDiscovery()	For the Swedish eIDAS configuration, the HideFromDiscovery attribute is used to indicate whether the proxy service within an endpoint should be hidden from the connector "select country view".
boolean	getSuspend()	For the Swedish eIDAS configuration, the Suspend attribute is used to indicate whether an endpoint has been suspended.
void	setEndpointType(String endpointType)	Assigns the endpoint type URI.
void	setEntityID(String entityID)	Assigns the entityID for the endpoint.
void	setHideFromDiscovery(boolean hideFlag)	Assigns the HideFromDiscovery attribute.
void	setSuspend(boolean suspendFlag)	Assigns the Suspend attribute.

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

getUnknownAttributes

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

detach, ensureDOM, 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 Details

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.

ENDPOINT_TYPE_ATTR_NAME

static final String ENDPOINT_TYPE_ATTR_NAME

Attribute label for the Location attribute.

See Also:

• Constant Field Values

ENTITY_ID_ATTR_NAME

static final String ENTITY_ID_ATTR_NAME

Attribute label for the Location attribute.

See Also:

• Constant Field Values

PROXY_SERVICE_ENDPOINT_TYPE

static final String PROXY_SERVICE_ENDPOINT_TYPE

Identifier for a proxy service endpoint type.

See Also:

• Constant Field Values

CONNECTOR_ENDPOINT_TYPE

static final String CONNECTOR_ENDPOINT_TYPE

Identifier for a connector endpoint type.

See Also:

• Constant Field Values

Method Details

getEndpointType

String getEndpointType()

Returns the endpoint type URI.

Returns:

the endpoint type

setEndpointType

void setEndpointType(String endpointType)

Assigns the endpoint type URI.

Parameters:

endpointType - the endpoint type

getEntityID

String getEntityID()

Returns the entityID for the endpoint.

Returns:

the entityID

setEntityID

void setEntityID(String entityID)

Assigns the entityID for the endpoint.

Parameters:

entityID - the entityID

getSuspend

boolean getSuspend()

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

Returns:

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

setSuspend

void setSuspend(boolean suspendFlag)

Assigns the Suspend attribute. See getSuspend().

Parameters:

suspendFlag - the suspend flag

getHideFromDiscovery

boolean getHideFromDiscovery()

For the Swedish eIDAS configuration, the HideFromDiscovery attribute is used to indicate whether the proxy service within an endpoint should be hidden from the connector "select country view". This method is just a shortcut instead of using AttributeExtensibleXMLObject.getUnknownAttributes().

Returns:

if the HideFromDiscovery attribute has been set to true this method returns true, otherwise false

setHideFromDiscovery

void setHideFromDiscovery(boolean hideFlag)

Assigns the HideFromDiscovery attribute. See getHideFromDiscovery().

Parameters:

hideFlag - the "HideFromDiscovery" flag