io.aeron.security

Class SimpleAuthenticator.Builder

java.lang.Object

io.aeron.security.SimpleAuthenticator.Builder

Enclosing class:

SimpleAuthenticator

public static class SimpleAuthenticator.Builder
extends Object

Builder to create instances of SimpleAuthenticator

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleAuthenticator	newInstance() Construct a new instance of the SimpleAuthenticator.
SimpleAuthenticator.Builder	principal(byte[] encodedPrincipal, byte[] encodedCredentials) Add a principal/credentials pair to the list supported by this authenticator.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

principal

public SimpleAuthenticator.Builder principal(byte[] encodedPrincipal,
                                             byte[] encodedCredentials)

Add a principal/credentials pair to the list supported by this authenticator. Note that the SimpleAuthenticator keys the principals by the credentials, so the encoded credentials should include the encoded principal. The associated CredentialsSupplier used on the client should handle encoding these credentials correctly as well. E.g.

 final SimpleAuthenticator simpleAuthenticator = new SimpleAuthenticator.Builder()
     .principal("user".getBytes(US_ASCII), "user:pass".getBytes(US_ASCII))
     .newInstance();
 

Parameters:

encodedPrincipal - principal encoded as a byte array.

encodedCredentials - credentials encoded as a byte array.

Returns:

this for a fluent API.

newInstance

public SimpleAuthenticator newInstance()

Construct a new instance of the SimpleAuthenticator.

Returns:

a new SimpleAuthenticator instance.