io.stargate.auth

Interface AuthorizationService

public interface AuthorizationService

Method Summary

Modifier and Type	Method and Description
void	authorizeDataRead(String token, String keyspace, String table) Using the provided token will perform pre-authorization and if not successful throws an exception.
void	authorizeDataWrite(String token, String keyspace, String table, List<TypedKeyValue> typedKeyValues, Scope scope) Using the provided token will perform pre-authorization where possible.
void	authorizeDataWrite(String token, String keyspace, String table, Scope scope) Using the provided token will perform pre-authorization and if not successful throws an exception.
ResultSet	authorizedDataRead(Callable<ResultSet> action, String token, String keyspace, String table, List<TypedKeyValue> typedKeyValues) Using the provided token will perform pre-authorization where possible, executes the query provided, and then authorizes the response of the query.
void	authorizeSchemaRead(String token, List<String> keyspaceNames, List<String> tableNames) Using the provided token will perform pre-authorization of accessing the provided resources.
void	authorizeSchemaWrite(String token, String keyspace, String table, Scope scope) Using the provided token will perform pre-authorization where possible and if not successful throws an exception.

Method Detail

authorizedDataRead

ResultSet authorizedDataRead(Callable<ResultSet> action,
                             String token,
                             String keyspace,
                             String table,
                             List<TypedKeyValue> typedKeyValues)
                      throws Exception

Using the provided token will perform pre-authorization where possible, executes the query provided, and then authorizes the response of the query.

Parameters:

action - A QueryBuilder object to be executed and authorized against a token.

token - The authenticated token to use for authorization.

keyspace - The keyspace containing the table with data to be read.

table - The table within the provided keyspace containing the data to be read.

typedKeyValues - A list of TypedKeyValue that will be used in the query and should be authorized against the token.

Returns:

On success will return the result of the query and otherwise will return an exception relating to the failure to authorize.

Throws:

Exception - An exception relating to the failure to authorize.

authorizeDataRead

void authorizeDataRead(String token,
                       String keyspace,
                       String table)
                throws UnauthorizedException

Using the provided token will perform pre-authorization and if not successful throws an exception. Intended to be used when the keys for the query are not readily accessible or when a higher level of authorization is acceptable.

Parameters:

token - The authenticated token to use for authorization.

keyspace - The keyspace containing the table with data to be read.

table - The table within the provided keyspace containing the data to be read.

Throws:

UnauthorizedException - An exception relating to the failure to authorize.

authorizeDataWrite

void authorizeDataWrite(String token,
                        String keyspace,
                        String table,
                        Scope scope)
                 throws UnauthorizedException

Using the provided token will perform pre-authorization and if not successful throws an exception. Intended to be used when the keys for the query are not readily accessible or when a higher level of authorization is acceptable.

Parameters:

token - The authenticated token to use for authorization.

keyspace - Either the keyspace containing the resource to be modified or the actual resource being modified.

table - The table within the provided keyspace containing the data to be modified.

scope - The table within the provided keyspace that is being modified.

Throws:

UnauthorizedException - An exception relating to the failure to authorize.

authorizeDataWrite

void authorizeDataWrite(String token,
                        String keyspace,
                        String table,
                        List<TypedKeyValue> typedKeyValues,
                        Scope scope)
                 throws UnauthorizedException

Using the provided token will perform pre-authorization where possible.

Parameters:

token - The authenticated token to use for authorization.

typedKeyValues - A list of TypedKeyValue that will be used in the query and should be authorized against the token.

scope - The Scope of the action to be performed.

Throws:

UnauthorizedException - An exception relating to the failure to authorize.

authorizeSchemaRead

void authorizeSchemaRead(String token,
                         List<String> keyspaceNames,
                         List<String> tableNames)
                  throws UnauthorizedException

Using the provided token will perform pre-authorization of accessing the provided resources.

Parameters:

token - The authenticated token to use for authorization.

keyspaceNames - Either the keyspace(s) containing the resource(s) to be read or the actual resource being read.

tableNames - The table(s) within the provided keyspace(s) that is being read.

Throws:

UnauthorizedException - An exception relating to the failure to authorize.

authorizeSchemaWrite

void authorizeSchemaWrite(String token,
                          String keyspace,
                          String table,
                          Scope scope)
                   throws UnauthorizedException

Using the provided token will perform pre-authorization where possible and if not successful throws an exception.

Parameters:

token - The authenticated token to use for authorization.

keyspace - Either the keyspace containing the resource to be modified or the actual resource being modified.

table - The table within the provided keyspace that is being modified.

scope - The Scope of the action to be performed.

Throws:

UnauthorizedException - An exception relating to the failure to authorize.