Package org.apache.tinkerpop.gremlin.server.authz

Interface Authorizer

public interface Authorizer

Provides the interface for authorizing a user per request.

Author:

Marc de Lignie

Method Summary

Modifier and Type	Method	Description
default String	authorize(AuthenticatedUser user, String gremlin, Map<String,String> aliases)
void	authorize(AuthenticatedUser user, RequestMessage msg)	Checks whether a user is authorized to have a script request from a gremlin client answered and raises an AuthorizationException if this is not the case.
void	setup(Map<String,Object> config)	This method is called once upon system startup to initialize the Authorizer.

Method Details

setup

void setup(Map<String,Object> config)
    throws AuthorizationException

This method is called once upon system startup to initialize the Authorizer.

Throws:

AuthorizationException

authorize

default String authorize(AuthenticatedUser user,
 String gremlin,
 Map<String,String> aliases)
                  throws AuthorizationException

Throws:

AuthorizationException

authorize

void authorize(AuthenticatedUser user,
 RequestMessage msg)
        throws AuthorizationException

Checks whether a user is authorized to have a script request from a gremlin client answered and raises an AuthorizationException if this is not the case.

Parameters:

user - AuthenticatedUser that needs authorization.

msg - RequestMessage in which the Tokens.ARGS_GREMLIN argument can contain an arbitrary succession of script statements.

Throws:

AuthorizationException