Package pl.edu.icm.unity.engine.api.endpoint

Class AbstractEndpoint

java.lang.Object

pl.edu.icm.unity.engine.api.endpoint.AbstractEndpoint

All Implemented Interfaces:

EndpointInstance

Direct Known Subclasses:

AbstractWebEndpoint

public abstract class AbstractEndpoint
extends Object
implements EndpointInstance

Typical boilerplate for all endpoints.

Author:

K. Benedyczak

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AuthenticationFlow>	authenticationFlows
protected ResolvedEndpoint	description
protected Properties	properties

Constructor Summary

Constructors

Constructor	Description
AbstractEndpoint()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Stops the endpoint.
List<AuthenticationFlow>	getAuthenticationFlows()
ResolvedEndpoint	getEndpointDescription()
String	getSerializedConfiguration()
void	initialize(ResolvedEndpoint description, List<AuthenticationFlow> authenticators, String serializedConfiguration)
protected void	setAuthenticators(List<AuthenticationFlow> authenticationFlows)
protected abstract void	setSerializedConfiguration(String serializedState)

Methods inherited from class java.lang.Object

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

Methods inherited from interface pl.edu.icm.unity.engine.api.endpoint.EndpointInstance

start, updateAuthenticationFlows

Field Details

description

protected ResolvedEndpoint description

authenticationFlows

protected List<AuthenticationFlow> authenticationFlows

properties

protected Properties properties

Constructor Details

AbstractEndpoint

public AbstractEndpoint()

Method Details

initialize

public void initialize(ResolvedEndpoint description,
 List<AuthenticationFlow> authenticators,
 String serializedConfiguration)

Specified by:

initialize in interface EndpointInstance

Parameters:

description - most of the endpoint's settings

authenticators - authenticator instances for the endpoint.

serializedConfiguration - endpoint specific configuration (as returned by EndpointInstance.getSerializedConfiguration().

getSerializedConfiguration

public String getSerializedConfiguration()

Specified by:

getSerializedConfiguration in interface EndpointInstance

Returns:

serialized representation of the endpoint configuration/state

setSerializedConfiguration

protected abstract void setSerializedConfiguration(String serializedState)

getEndpointDescription

public ResolvedEndpoint getEndpointDescription()

Specified by:

getEndpointDescription in interface EndpointInstance

destroy

public void destroy()
             throws EngineException

Description copied from interface: EndpointInstance

Stops the endpoint.

Specified by:

destroy in interface EndpointInstance

Throws:

EngineException

getAuthenticationFlows

public List<AuthenticationFlow> getAuthenticationFlows()

Specified by:

getAuthenticationFlows in interface EndpointInstance

Returns:

the current list of previously configured authentication flows (with initialize).

setAuthenticators

protected void setAuthenticators(List<AuthenticationFlow> authenticationFlows)