io.aeron.security

Interface CredentialsSupplier

All Known Implementing Classes:

NullCredentialsSupplier

public interface CredentialsSupplier

Supplier of credentials for authentication with a system. Implement this interface to supply credentials for clients. If no credentials are required then the NullCredentialsSupplier can be used.

Method Summary

Modifier and Type	Method and Description
byte[]	encodedCredentials() Provide encoded credentials to be included in Session Connect message a system.
byte[]	onChallenge(byte[] encodedChallenge) Given some encoded challenge, provide the credentials to be included in a Challenge Response as part of authentication with a system.

Method Detail

encodedCredentials

byte[] encodedCredentials()

Provide encoded credentials to be included in Session Connect message a system.

Returns:

encoded credentials to be included in the Session Connect message to a system.

onChallenge

byte[] onChallenge(byte[] encodedChallenge)

Given some encoded challenge, provide the credentials to be included in a Challenge Response as part of authentication with a system.

Parameters:

encodedChallenge - from the cluster to use in providing a credential.

Returns:

encoded credentials to be included in the Challenge Response to the system.