Package org.apache.tinkerpop.gremlin.server.auth

Class SimpleAuthenticator

java.lang.Object
org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
All Implemented Interfaces:
Authenticator
public class SimpleAuthenticator extends Object implements Authenticator
A simple implementation of an Authenticator that uses a Graph instance as a credential store. Management of the credential store can be handled through the CredentialTraversalDsl DSL.
Author:
Stephen Mallette (http://stephen.genoprime.com)

  • Field Details

    • CONFIG_CREDENTIALS_DB

      public static final String CONFIG_CREDENTIALS_DB
      The location of the configuration file that contains the credentials database.
      See Also:

  • Constructor Details

    • SimpleAuthenticator

      public SimpleAuthenticator()

  • Method Details

    • requireAuthentication

      public boolean requireAuthentication()
      Description copied from interface: Authenticator
      Whether or not the authenticator requires explicit login. If false will instantiate user with AuthenticatedUser.ANONYMOUS_USER.
      Specified by:
      requireAuthentication in interface Authenticator

    • setup

      public void setup(Map<String,Object> config)
      Description copied from interface: Authenticator
      Setup is called once upon system startup to initialize the Authenticator.
      Specified by:
      setup in interface Authenticator

    • newSaslNegotiator

      public Authenticator.SaslNegotiator newSaslNegotiator(InetAddress remoteAddress)
      Description copied from interface: Authenticator
      Provide a SASL handler to perform authentication for an single connection. SASL is a stateful protocol, so a new instance must be used for each authentication attempt.
      Specified by:
      newSaslNegotiator in interface Authenticator
      Parameters:
      remoteAddress - the IP address of the client to authenticate to authenticate or null if an internal client (one not connected over the remote transport).

    • authenticate

      public AuthenticatedUser authenticate(Map<String,String> credentials) throws AuthenticationException
      Description copied from interface: Authenticator
      A "standard" authentication implementation that can be used more generically without SASL support. This implementation is used when a particular Channelizer doesn't support SASL directly (like basic HTTP authentication).
      Specified by:
      authenticate in interface Authenticator
      Throws:
      AuthenticationException