com.orientechnologies.orient.core.metadata.security

Interface OSecurity

All Known Implementing Classes:

OSecurityProxy

public interface OSecurity

Manages users and roles.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_ALL_FIELD
static String	ALLOW_DELETE_FIELD
static String	ALLOW_READ_FIELD
static String	ALLOW_UPDATE_FIELD
static String	IDENTITY_CLASSNAME Deprecated.
static String	ONCREATE_FIELD
static String	ONCREATE_IDENTITY_TYPE
static String	RESTRICTED_CLASSNAME

Method Summary

Modifier and Type	Method and Description
OIdentifiable	allowRole(ODocument iDocument, ORestrictedOperation iOperationType, String iRoleName) Record level security: allows a role to access to a record.
OIdentifiable	allowUser(ODocument iDocument, ORestrictedOperation iOperationType, String iUserName) Record level security: allows a user to access to a record.
OUser	authenticate(OToken authToken)
OUser	authenticate(String iUsername, String iUserPassword)
ORole	createRole(String iRoleName, ORole iParent, OSecurityRole.ALLOW_MODES iAllowMode)
ORole	createRole(String iRoleName, OSecurityRole.ALLOW_MODES iAllowMode)
OUser	createUser(String iUserName, String iUserPassword, ORole... iRoles)
OUser	createUser(String iUserName, String iUserPassword, String... iRoles)
OIdentifiable	denyRole(ODocument iDocument, ORestrictedOperation iOperationType, String iRoleName) Record level security: deny a role to access to a record.
OIdentifiable	denyUser(ODocument iDocument, ORestrictedOperation iOperationType, String iUserName) Record level security: deny a user to access to a record.
boolean	dropRole(String iRoleName)
boolean	dropUser(String iUserName)
List<ODocument>	getAllRoles()
List<ODocument>	getAllUsers()
ORole	getRole(OIdentifiable role)
ORole	getRole(String iRoleName)
OUser	getUser(ORID iUserId)
OUser	getUser(String iUserName)
boolean	isAllowed(Set<OIdentifiable> iAllowAll, Set<OIdentifiable> iAllowOperation)

Field Detail

RESTRICTED_CLASSNAME

static final String RESTRICTED_CLASSNAME

See Also:

Constant Field Values

IDENTITY_CLASSNAME

@Deprecated
static final String IDENTITY_CLASSNAME

Deprecated.

See Also:

Constant Field Values

ALLOW_ALL_FIELD

static final String ALLOW_ALL_FIELD

See Also:

Constant Field Values

ALLOW_READ_FIELD

static final String ALLOW_READ_FIELD

See Also:

Constant Field Values

ALLOW_UPDATE_FIELD

static final String ALLOW_UPDATE_FIELD

See Also:

Constant Field Values

ALLOW_DELETE_FIELD

static final String ALLOW_DELETE_FIELD

See Also:

Constant Field Values

ONCREATE_IDENTITY_TYPE

static final String ONCREATE_IDENTITY_TYPE

See Also:

Constant Field Values

ONCREATE_FIELD

static final String ONCREATE_FIELD

See Also:

Constant Field Values

Method Detail

isAllowed

boolean isAllowed(Set<OIdentifiable> iAllowAll,
                  Set<OIdentifiable> iAllowOperation)

allowUser

OIdentifiable allowUser(ODocument iDocument,
                        ORestrictedOperation iOperationType,
                        String iUserName)

Record level security: allows a user to access to a record.

Parameters:

iDocument - ODocument instance to give access

iOperationType - Operation type to use based on the permission to allow:

• ALLOW_ALL, to provide full access (RUD)
• ALLOW_READ, to provide read access
• ALLOW_UPDATE, to provide update access
• ALLOW_DELETE, to provide delete access

iUserName - User name to provide the access

Returns:

The OIdentity instance allowed

allowRole

OIdentifiable allowRole(ODocument iDocument,
                        ORestrictedOperation iOperationType,
                        String iRoleName)

Record level security: allows a role to access to a record.

Parameters:

iDocument - ODocument instance to give access

iOperationType - Operation type to use based on the permission to allow:

• ALLOW_ALL, to provide full access (RUD)
• ALLOW_READ, to provide read access
• ALLOW_UPDATE, to provide update access
• ALLOW_DELETE, to provide delete access

iRoleName - Role name to provide the access

Returns:

The OIdentity instance allowed

denyUser

OIdentifiable denyUser(ODocument iDocument,
                       ORestrictedOperation iOperationType,
                       String iUserName)

Record level security: deny a user to access to a record.

Parameters:

iDocument - ODocument instance to give access

iOperationType - Operation type to use based on the permission to deny:

• ALLOW_ALL, to provide full access (RUD)
• ALLOW_READ, to provide read access
• ALLOW_UPDATE, to provide update access
• ALLOW_DELETE, to provide delete access

iUserName - User name to deny the access

Returns:

The OIdentity instance denied

denyRole

OIdentifiable denyRole(ODocument iDocument,
                       ORestrictedOperation iOperationType,
                       String iRoleName)

Record level security: deny a role to access to a record.

Parameters:

iDocument - ODocument instance to give access

iOperationType - Operation type to use based on the permission to deny:

• ALLOW_ALL, to provide full access (RUD)
• ALLOW_READ, to provide read access
• ALLOW_UPDATE, to provide update access
• ALLOW_DELETE, to provide delete access

iRoleName - Role name to deny the access

Returns:

The OIdentity instance denied

authenticate

OUser authenticate(String iUsername,
                   String iUserPassword)

authenticate

OUser authenticate(OToken authToken)

getUser

OUser getUser(String iUserName)

getUser

OUser getUser(ORID iUserId)

createUser

OUser createUser(String iUserName,
                 String iUserPassword,
                 String... iRoles)

createUser

OUser createUser(String iUserName,
                 String iUserPassword,
                 ORole... iRoles)

dropUser

boolean dropUser(String iUserName)

getRole

ORole getRole(String iRoleName)

getRole

ORole getRole(OIdentifiable role)

createRole

ORole createRole(String iRoleName,
                 OSecurityRole.ALLOW_MODES iAllowMode)

createRole

ORole createRole(String iRoleName,
                 ORole iParent,
                 OSecurityRole.ALLOW_MODES iAllowMode)

dropRole

boolean dropRole(String iRoleName)

getAllUsers

List<ODocument> getAllUsers()

getAllRoles

List<ODocument> getAllRoles()