io.aeron.security

Class SimpleAuthenticator

java.lang.Object

io.aeron.security.SimpleAuthenticator

All Implemented Interfaces:

Authenticator

public final class SimpleAuthenticator
extends Object
implements Authenticator

An authenticator that works off a simple principal/credential pair constructed by a builder. It only supports simple authentication, but not challenge/response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleAuthenticator.Builder Builder to create instances of SimpleAuthenticator

Method Summary

Modifier and Type	Method and Description
void	onChallengedSession(SessionProxy sessionProxy, long nowMs) Called when a challenged client should be able to accept a response from the authenticator.
void	onChallengeResponse(long sessionId, byte[] encodedCredentials, long nowMs) Called upon reception of a Challenge Response from an unauthenticated client.
void	onConnectedSession(SessionProxy sessionProxy, long nowMs) Called when a client's response channel has been connected.
void	onConnectRequest(long sessionId, byte[] encodedCredentials, long nowMs) Called upon reception of a Connect Request and will be followed up by multiple calls to Authenticator.onConnectedSession(SessionProxy, long) once the response channel is connected.

Methods inherited from class java.lang.Object

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

Method Detail

onConnectRequest

public void onConnectRequest(long sessionId,
                             byte[] encodedCredentials,
                             long nowMs)

Called upon reception of a Connect Request and will be followed up by multiple calls to Authenticator.onConnectedSession(SessionProxy, long) once the response channel is connected.

Specified by:

onConnectRequest in interface Authenticator

Parameters:

sessionId - to identify the client session connecting.

encodedCredentials - from the Connect Request. Will not be null, but may be 0 length.

nowMs - current epoch time in milliseconds.

onChallengeResponse

public void onChallengeResponse(long sessionId,
                                byte[] encodedCredentials,
                                long nowMs)

Called upon reception of a Challenge Response from an unauthenticated client.

Specified by:

onChallengeResponse in interface Authenticator

Parameters:

sessionId - to identify the client session connecting.

encodedCredentials - from the Challenge Response. Will not be null, but may be 0 length.

nowMs - current epoch time in milliseconds.

onConnectedSession

public void onConnectedSession(SessionProxy sessionProxy,
                               long nowMs)

Called when a client's response channel has been connected. This method may be called multiple times until the session timeouts, is challenged, authenticated, or rejected.

Specified by:

onConnectedSession in interface Authenticator

Parameters:

sessionProxy - to use to update authentication status. Proxy is only valid for the duration of the call.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy

onChallengedSession

public void onChallengedSession(SessionProxy sessionProxy,
                                long nowMs)

Called when a challenged client should be able to accept a response from the authenticator.

When this is called, there is no assumption that a Challenge Response has been received, plus this method may be called multiple times.

It is up to the concrete class to provide any timeout management.

Specified by:

onChallengedSession in interface Authenticator

Parameters:

sessionProxy - to use to update authentication status. Proxy is only valid for the duration of the call.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy