org.opensaml.common.binding
Class AbstractEndpointSelector

java.lang.Object
  org.opensaml.common.binding.AbstractEndpointSelector

Direct Known Subclasses:

BasicEndpointSelector

public abstract class AbstractEndpointSelector
extends Object

Endpoint selectors choose the endpoint that should be used to contact a peer.

Field Summary

private QName	endpointType Type of endpoint needed.
private EntityDescriptor	entityMetadata Metadata of party to select endpoing for.
private RoleDescriptor	entityRoleMetadata Role metadata of party to select endpoing for.
private MetadataProvider	metadataProvider Provider of metadata for the relying party.
private SAMLObject	samlRequest SAML request within the message flow.
private SAMLObject	samlResponse SAML response within the message flow.
private List<String>	supportedIssuerBindings Bindings supported by the issuer.

Constructor Summary

AbstractEndpointSelector()
Constructor.

Method Summary

QName	getEndpointType() Gets type of endpoint needed.
EntityDescriptor	getEntityMetadata() Gets the metadata of the entity.
RoleDescriptor	getEntityRoleMetadata() Gets the role of the entity.
MetadataProvider	getMetadataProvider() Gets the metadata provider used to look up entity information.
SAMLObject	getSamlRequest() Gets the SAML request made.
SAMLObject	getSamlResponse() Gets the response to the SAML request.
List<String>	getSupportedIssuerBindings() Gets the list of bindings supported by the message issuer.
abstract Endpoint	selectEndpoint() Selects the endpoint to which messages should be sent.
void	setEndpointType(QName type) Sets the type of endpoint needed.
void	setEntityMetadata(EntityDescriptor entity) Sets the metadata of the entity.
void	setEntityRoleMetadata(RoleDescriptor role) Sets the role of the entity.
void	setMetadataProvider(MetadataProvider provider) Sets the metadata provider used to look up entity information.
void	setSamlRequest(SAMLObject request) Sets the SAML request made.
void	setSamlResponse(SAMLObject response) Sets the response to the SAML request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

supportedIssuerBindings

private List<String> supportedIssuerBindings

Bindings supported by the issuer.

samlRequest

private SAMLObject samlRequest

SAML request within the message flow.

samlResponse

private SAMLObject samlResponse

SAML response within the message flow.

metadataProvider

private MetadataProvider metadataProvider

Provider of metadata for the relying party.

entityMetadata

private EntityDescriptor entityMetadata

Metadata of party to select endpoing for.

entityRoleMetadata

private RoleDescriptor entityRoleMetadata

Role metadata of party to select endpoing for.

endpointType

private QName endpointType

Type of endpoint needed.

Constructor Detail

AbstractEndpointSelector

public AbstractEndpointSelector()

Constructor.

Method Detail

getEndpointType

public QName getEndpointType()

Gets type of endpoint needed.

Returns:

type of endpoint needed

setEndpointType

public void setEndpointType(QName type)

Sets the type of endpoint needed.

Parameters:

type - type of endpoint needed

getMetadataProvider

public MetadataProvider getMetadataProvider()

Gets the metadata provider used to look up entity information.

Returns:

metadata provider used to look up entity information

setMetadataProvider

public void setMetadataProvider(MetadataProvider provider)

Sets the metadata provider used to look up entity information.

Parameters:

provider - metadata provider used to look up entity information

getEntityMetadata

public EntityDescriptor getEntityMetadata()

Gets the metadata of the entity.

Returns:

metadata of the entity

setEntityMetadata

public void setEntityMetadata(EntityDescriptor entity)

Sets the metadata of the entity.

Parameters:

entity - metadata of the entity

getEntityRoleMetadata

public RoleDescriptor getEntityRoleMetadata()

Gets the role of the entity.

Returns:

role of the entity

setEntityRoleMetadata

public void setEntityRoleMetadata(RoleDescriptor role)

Sets the role of the entity.

Parameters:

role - role of the entity

getSamlRequest

public SAMLObject getSamlRequest()

Gets the SAML request made.

Returns:

SAML request made

setSamlRequest

public void setSamlRequest(SAMLObject request)

Sets the SAML request made.

Parameters:

request - SAML request made

getSamlResponse

public SAMLObject getSamlResponse()

Gets the response to the SAML request.

Returns:

response to the SAML request

setSamlResponse

public void setSamlResponse(SAMLObject response)

Sets the response to the SAML request.

Parameters:

response - response to the SAML request

getSupportedIssuerBindings

public List<String> getSupportedIssuerBindings()

Gets the list of bindings supported by the message issuer.

Returns:

list of bindings supported by the message issuer

selectEndpoint

public abstract Endpoint selectEndpoint()

Selects the endpoint to which messages should be sent.

Returns:

endpoint to which messages should be sent, or null if no suitable endpoint can be determined