Package com.arangodb.springframework.core.template

Class DefaultUserOperation

java.lang.Object

com.arangodb.springframework.core.template.DefaultUserOperation

All Implemented Interfaces:

UserOperations

public class DefaultUserOperation
extends Object
implements UserOperations

Author:

Mark Vollmary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultUserOperation.CollectionCallback

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultUserOperation(com.arangodb.ArangoDatabase db, String username, PersistenceExceptionTranslator exceptionTranslator, DefaultUserOperation.CollectionCallback collectionCallback)

Method Summary

Modifier and Type	Method	Description
com.arangodb.entity.UserEntity	create(String passwd, com.arangodb.model.UserCreateOptions options)	Create a new user.
void	delete()	Removes an existing user, identified by user.
com.arangodb.entity.UserEntity	get()	Fetches data about the specified user.
com.arangodb.entity.Permissions	getCollectionPermissions(Class<?> type)	Get the collection access level
com.arangodb.entity.Permissions	getCollectionPermissions(String name)	Get the collection access level
com.arangodb.entity.Permissions	getDatabasePermissions()	Get specific database access level
void	grantCollectionAccess(Class<?> type, com.arangodb.entity.Permissions permissions)	Grants or revoke access to the collection for user.
void	grantCollectionAccess(String name, com.arangodb.entity.Permissions permissions)	Grants or revoke access to the collection for user.
void	grantDatabaseAccess(com.arangodb.entity.Permissions permissions)	Grants or revoke access to the database for the user.
void	grantDefaultCollectionAccess(com.arangodb.entity.Permissions permissions)	Sets the default access level for collections for the user.
void	grantDefaultDatabaseAccess(com.arangodb.entity.Permissions permissions)	Sets the default access level for databases for the user.
com.arangodb.entity.UserEntity	replace(com.arangodb.model.UserUpdateOptions options)	Replaces the data of an existing user.
void	resetCollectionAccess(Class<?> type)	Clear the collection access level, revert back to the default access level.
void	resetCollectionAccess(String name)	Clear the collection access level, revert back to the default access level.
void	resetDatabaseAccess()	Clear the database access level, revert back to the default access level.
com.arangodb.entity.UserEntity	update(com.arangodb.model.UserUpdateOptions options)	Partially updates the data of an existing user.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultUserOperation

protected DefaultUserOperation(com.arangodb.ArangoDatabase db,
 String username,
 PersistenceExceptionTranslator exceptionTranslator,
 DefaultUserOperation.CollectionCallback collectionCallback)

Method Details

get

public com.arangodb.entity.UserEntity get()
                                   throws DataAccessException

Description copied from interface: UserOperations

Fetches data about the specified user. You can fetch information about yourself or you need permission to the _system database in order to execute this call.

Specified by:

get in interface UserOperations

Returns:

information about the user

Throws:

DataAccessException

create

public com.arangodb.entity.UserEntity create(String passwd,
 com.arangodb.model.UserCreateOptions options)
                                      throws DataAccessException

Description copied from interface: UserOperations

Create a new user. This user will not have access to any database. You need permission to the _system database in order to execute this call.

Specified by:

create in interface UserOperations

Parameters:

passwd - The user password

options - Additional options, can be null

Returns:

information about the user

Throws:

DataAccessException

update

public com.arangodb.entity.UserEntity update(com.arangodb.model.UserUpdateOptions options)
                                      throws DataAccessException

Description copied from interface: UserOperations

Partially updates the data of an existing user. You can only change the password of your self. You need access to the _system database to change the active flag.

Specified by:

update in interface UserOperations

Parameters:

options - Properties of the user to be changed

Returns:

information about the user

Throws:

DataAccessException

replace

public com.arangodb.entity.UserEntity replace(com.arangodb.model.UserUpdateOptions options)
                                       throws DataAccessException

Description copied from interface: UserOperations

Replaces the data of an existing user. You can only change the password of your self. You need access to the _system database to change the active flag.

Specified by:

replace in interface UserOperations

Parameters:

options - Additional properties of the user, can be null

Returns:

information about the user

Throws:

DataAccessException

delete

public void delete()
            throws DataAccessException

Description copied from interface: UserOperations

Removes an existing user, identified by user. You need access to the _system database.

Specified by:

delete in interface UserOperations

Throws:

DataAccessException

grantDefaultDatabaseAccess

public void grantDefaultDatabaseAccess(com.arangodb.entity.Permissions permissions)
                                throws DataAccessException

Description copied from interface: UserOperations

Sets the default access level for databases for the user. You need permission to the _system database in order to execute this call.

Specified by:

grantDefaultDatabaseAccess in interface UserOperations

Parameters:

permissions - The permissions the user grant

Throws:

DataAccessException

grantDatabaseAccess

public void grantDatabaseAccess(com.arangodb.entity.Permissions permissions)
                         throws DataAccessException

Description copied from interface: UserOperations

Grants or revoke access to the database for the user. You need permission to the _system database in order to execute this call.

Specified by:

grantDatabaseAccess in interface UserOperations

Parameters:

permissions - The permissions the user grant

Throws:

DataAccessException

resetDatabaseAccess

public void resetDatabaseAccess()
                         throws DataAccessException

Description copied from interface: UserOperations

Clear the database access level, revert back to the default access level.

Specified by:

resetDatabaseAccess in interface UserOperations

Throws:

DataAccessException

grantDefaultCollectionAccess

public void grantDefaultCollectionAccess(com.arangodb.entity.Permissions permissions)
                                  throws DataAccessException

Description copied from interface: UserOperations

Sets the default access level for collections for the user. You need permission to the _system database in order to execute this call.

Specified by:

grantDefaultCollectionAccess in interface UserOperations

Parameters:

permissions - The permissions the user grant

Throws:

DataAccessException

grantCollectionAccess

public void grantCollectionAccess(Class<?> type,
 com.arangodb.entity.Permissions permissions)
                           throws DataAccessException

Description copied from interface: UserOperations

Grants or revoke access to the collection for user. You need permission to the _system database in order to execute this call.

Specified by:

grantCollectionAccess in interface UserOperations

Parameters:

type - The entity type representing the collection

permissions - The permissions the user grant

Throws:

DataAccessException

grantCollectionAccess

public void grantCollectionAccess(String name,
 com.arangodb.entity.Permissions permissions)
                           throws DataAccessException

Description copied from interface: UserOperations

Grants or revoke access to the collection for user. You need permission to the _system database in order to execute this call.

Specified by:

grantCollectionAccess in interface UserOperations

Parameters:

name - The name of the collection

permissions - The permissions the user grant

Throws:

DataAccessException

resetCollectionAccess

public void resetCollectionAccess(Class<?> type)
                           throws DataAccessException

Description copied from interface: UserOperations

Clear the collection access level, revert back to the default access level.

Specified by:

resetCollectionAccess in interface UserOperations

Parameters:

type - The entity type representing the collection

Throws:

DataAccessException

resetCollectionAccess

public void resetCollectionAccess(String name)
                           throws DataAccessException

Description copied from interface: UserOperations

Clear the collection access level, revert back to the default access level.

Specified by:

resetCollectionAccess in interface UserOperations

Parameters:

name - The name of the collection

Throws:

DataAccessException

getDatabasePermissions

public com.arangodb.entity.Permissions getDatabasePermissions()
                                                       throws DataAccessException

Description copied from interface: UserOperations

Get specific database access level

Specified by:

getDatabasePermissions in interface UserOperations

Returns:

permissions of the user

Throws:

DataAccessException

getCollectionPermissions

public com.arangodb.entity.Permissions getCollectionPermissions(Class<?> type)
                                                         throws DataAccessException

Description copied from interface: UserOperations

Get the collection access level

Specified by:

getCollectionPermissions in interface UserOperations

Parameters:

type - The entity type representing the collection

Returns:

permissions of the user

Throws:

DataAccessException

getCollectionPermissions

public com.arangodb.entity.Permissions getCollectionPermissions(String name)
                                                         throws DataAccessException

Description copied from interface: UserOperations

Get the collection access level

Specified by:

getCollectionPermissions in interface UserOperations

Parameters:

name - The name of the collection

Returns:

permissions of the user

Throws:

DataAccessException