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

Interface EndpointInstance

All Known Subinterfaces:

WebAppEndpointInstance

All Known Implementing Classes:

AbstractEndpoint, AbstractWebEndpoint

public interface EndpointInstance

Generic endpoint instance. Implementations must persist/load only the custom settings using the JsonSerializable interface; authenticators, id, and description are always set via initialize method. Lifecycle:

1. initialize (once)
2. operation....
3. destroy (once)

Destroy might be called also before initialize if there was server deployment error.

Author:

K. Benedyczak

Method Summary

Modifier and Type	Method	Description
void	destroy()	Stops the endpoint.
List<AuthenticationFlow>	getAuthenticationFlows()
ResolvedEndpoint	getEndpointDescription()
String	getSerializedConfiguration()
void	initialize(ResolvedEndpoint endpointDescription, List<AuthenticationFlow> authenticatonOptions, String serializedConfiguration)
void	start()	Starts the endpoint.
void	updateAuthenticationFlows(List<AuthenticationFlow> authenticationFlows)	Runtime update of the authenticators being used by this endpoint.

Method Details

initialize

void initialize(ResolvedEndpoint endpointDescription,
 List<AuthenticationFlow> authenticatonOptions,
 String serializedConfiguration)

Parameters:

endpointDescription - most of the endpoint's settings

authenticatonOptions - authenticator instances for the endpoint.

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

getEndpointDescription

ResolvedEndpoint getEndpointDescription()

getAuthenticationFlows

List<AuthenticationFlow> getAuthenticationFlows()

Returns:

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

getSerializedConfiguration

String getSerializedConfiguration()

Returns:

serialized representation of the endpoint configuration/state

start

void start()
    throws EngineException

Starts the endpoint. After this method returns the endpoint should be made available for usage.

Throws:

EngineException

destroy

void destroy()
      throws EngineException

Stops the endpoint.

Throws:

EngineException

updateAuthenticationFlows

void updateAuthenticationFlows(List<AuthenticationFlow> authenticationFlows)
                        throws UnsupportedOperationException

Runtime update of the authenticators being used by this endpoint.

Parameters:

handler -

authenticationFlows -

Throws:

UnsupportedOperationException - if the operation is unsupported and the endpoint must be re-created instead.