io.aeron.security

Interface SessionProxy

public interface SessionProxy

Representation of a session during the authentication process from the perspective of an Authenticator.

See Also:

Authenticator

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 by sending the provided encoded challenge.
void	reject() Inform the system that the session should be rejected.
long	sessionId() The identity of the potential session assigned by the system.

Method Detail

sessionId

long sessionId()

The identity of the potential session assigned by the system.

Returns:

identity for the potential session.

challenge

boolean challenge(byte[] encodedChallenge)

Inform the system that the session requires a challenge by sending the provided encoded challenge.

Parameters:

encodedChallenge - to be sent to the client.

Returns:

true if challenge was accepted to be sent at present time or false if it will be retried later.

authenticate

boolean authenticate(byte[] encodedPrincipal)

Inform the system that the session has met authentication requirements.

Parameters:

encodedPrincipal - that has passed authentication.

Returns:

true if authentication was accepted at present time or false if it will be retried later.

reject

void reject()

Inform the system that the session should be rejected.