io.aeron.samples.archive

Class SampleAuthenticator

java.lang.Object

io.aeron.samples.archive.SampleAuthenticator

All Implemented Interfaces:

Authenticator

public final class SampleAuthenticator
extends Object
implements Authenticator

A sample Authenticator to demonstrate usage based on some hardcoded credentials.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRINCIPAL

Constructor Summary

Constructors

Constructor and Description
SampleAuthenticator()

Method Summary

Modifier and Type	Method and Description
byte[]	encodedPrincipal() Byte array encoded representation of the sample principal.
void	onChallengedSession(SessionProxy sessionProxy, long nowMs) The client has been challenged and is awaiting a response.
void	onChallengeResponse(long sessionId, byte[] encodedCredentials, long nowMs) Client has returned a response to a challenge.
void	onConnectedSession(SessionProxy sessionProxy, long nowMs) Client session is now connected so a response can be sent.
void	onConnectRequest(long sessionId, byte[] encodedCredentials, long nowMs) Client is attempting to connect.

Methods inherited from class java.lang.Object

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

Field Detail

PRINCIPAL

public static final String PRINCIPAL

See Also:

Constant Field Values

Constructor Detail

SampleAuthenticator

public SampleAuthenticator()

Method Detail

encodedPrincipal

public byte[] encodedPrincipal()

Byte array encoded representation of the sample principal.

Returns:

byte array representation of PRINCIPAL

See Also:

PRINCIPAL

onConnectRequest

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

Client is attempting to connect.

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)

Client has returned a response to a challenge.

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)

Client session is now connected so a response can be sent.

Specified by:

onConnectedSession in interface Authenticator

Parameters:

sessionProxy - to use to inform client of status.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy

onChallengedSession

public void onChallengedSession(SessionProxy sessionProxy,
                                long nowMs)

The client has been challenged and is awaiting a response.

Specified by:

onChallengedSession in interface Authenticator

Parameters:

sessionProxy - to use to inform client of status.

nowMs - current epoch time in milliseconds.

See Also:

SessionProxy