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:
- initialize (once)
- operation....
- destroy (once)
- Author:
- K. Benedyczak
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Stops the endpoint.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 settingsauthenticatonOptions
- authenticator instances for the endpoint.serializedConfiguration
- endpoint specific configuration (as returned bygetSerializedConfiguration()
.
-
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
Starts the endpoint. After this method returns the endpoint should be made available for usage.- Throws:
EngineException
-
destroy
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.
-