io.aeron.security

Interface SessionProxy

public interface SessionProxy

Representation for a session which is going through the authentication process.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(byte[] encodedPrincipal) Inform the system that the session has met authentication requirements.
boolean	challenge(byte[] encodedChallenge) Inform the system that the session requires a challenge and to send the provided encoded challenge.
void	reject() Inform the system that the session has NOT met authentication requirements and should be rejected.
long	sessionId() The session Id of the potential session assigned by the system.

Method Detail

sessionId

long sessionId()

The session Id of the potential session assigned by the system.

Returns:

session id for the potential session

challenge

boolean challenge(byte[] encodedChallenge)

Inform the system that the session requires a challenge and to send the provided encoded challenge.

Parameters:

encodedChallenge - to send to the client.

Returns:

true if challenge was sent or false if challenge could not be sent.

authenticate

boolean authenticate(byte[] encodedPrincipal)

Inform the system that the session has met authentication requirements.

Parameters:

encodedPrincipal - that has passed authentication.

Returns:

true if success event was sent or false if success event could not be sent.

reject

void reject()

Inform the system that the session has NOT met authentication requirements and should be rejected.