Package com.orientechnologies.orient.core.metadata.security

Class ORole

java.lang.Object

com.orientechnologies.orient.core.metadata.security.OIdentity

com.orientechnologies.orient.core.metadata.security.ORole

All Implemented Interfaces:

OSecurityRole, Serializable

Direct Known Subclasses:

OSystemRole

public class ORole
extends OIdentity
implements OSecurityRole

Contains the user settings about security and permissions roles.
Allowed operation are the classic CRUD, namely:

• CREATE
• READ
• UPDATE
• DELETE

Mode = ALLOW (allow all but) or DENY (deny all but)

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.metadata.security.OSecurityRole

OSecurityRole.ALLOW_MODES

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN
static final String	CLASS_NAME
protected ODocument	document
protected OSecurityRole.ALLOW_MODES	mode
protected ORole	parentRole
static final int	PERMISSION_ALL
static final int	PERMISSION_CREATE
static final int	PERMISSION_DELETE
static final int	PERMISSION_EXECUTE
static final int	PERMISSION_NONE
static final int	PERMISSION_READ
static final int	PERMISSION_UPDATE
protected static final byte	STREAM_ALLOW
protected static final byte	STREAM_DENY

Constructor Summary

Constructors

Constructor	Description
ORole()	Constructor used in unmarshalling.
ORole(ODocument iSource)	Create the role by reading the source document.
ORole(String iName, ORole iParent, OSecurityRole.ALLOW_MODES iAllowMode)
ORole(String iName, ORole iParent, OSecurityRole.ALLOW_MODES iAllowMode, Map<String,OSecurityPolicy> policies)

Method Summary

Modifier and Type	Method	Description
ORole	addRule(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation)
OSecurityRole	addRule(String iResource, int iOperation)	Deprecated.
boolean	allow(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iCRUDOperation)
boolean	allow(String iResource, int iCRUDOperation)	Deprecated.
void	fromStream(ODocument iSource)
OIdentifiable	getIdentity()
OSecurityRole.ALLOW_MODES	getMode()	Deprecated.
String	getName()
ORole	getParentRole()
Map<String,OSecurityPolicy>	getPolicies()
OSecurityPolicy	getPolicy(String resource)
Map<String,Byte>	getRules()	Deprecated.
Set<ORule>	getRuleSet()
ORole	grant(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation)	Grant a permission to the resource.
OSecurityRole	grant(String iResource, int iOperation)	Deprecated.
boolean	hasRule(ORule.ResourceGeneric resourceGeneric, String resourceSpecific)
boolean	hasRule(String iResource)	Deprecated.
static String	permissionToString(int iPermission)	Convert the permission code to a readable string.
static int	registerPermissionBit(int iBitNo, String iName)
void	reload()
ORole	revoke(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation)	Revoke a permission to the resource.
OSecurityRole	revoke(String iResource, int iOperation)	Deprecated.
ORole	save()	Deprecated.
ORole	save(ODatabaseSession database)
ORole	setMode(OSecurityRole.ALLOW_MODES iMode)	Deprecated.
ORole	setParentRole(OSecurityRole iParent)
ODocument	toStream()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ADMIN

public static final String ADMIN

See Also:

• Constant Field Values

CLASS_NAME

public static final String CLASS_NAME

See Also:

• Constant Field Values

PERMISSION_NONE

public static final int PERMISSION_NONE

See Also:

• Constant Field Values

PERMISSION_CREATE

public static final int PERMISSION_CREATE

PERMISSION_READ

public static final int PERMISSION_READ

PERMISSION_UPDATE

public static final int PERMISSION_UPDATE

PERMISSION_DELETE

public static final int PERMISSION_DELETE

PERMISSION_EXECUTE

public static final int PERMISSION_EXECUTE

PERMISSION_ALL

public static final int PERMISSION_ALL

STREAM_DENY

protected static final byte STREAM_DENY

See Also:

• Constant Field Values

STREAM_ALLOW

protected static final byte STREAM_ALLOW

See Also:

• Constant Field Values

mode

protected OSecurityRole.ALLOW_MODES mode

parentRole

protected ORole parentRole

document

@ODocumentInstance
protected ODocument document

Constructor Details

ORole

public ORole()

Constructor used in unmarshalling.

ORole

public ORole(String iName,
 ORole iParent,
 OSecurityRole.ALLOW_MODES iAllowMode)

ORole

public ORole(String iName,
 ORole iParent,
 OSecurityRole.ALLOW_MODES iAllowMode,
 Map<String,OSecurityPolicy> policies)

ORole

public ORole(ODocument iSource)

Create the role by reading the source document.

Method Details

permissionToString

public static String permissionToString(int iPermission)

Convert the permission code to a readable string.

Parameters:

iPermission - Permission to convert

Returns:

String representation of the permission

registerPermissionBit

public static int registerPermissionBit(int iBitNo,
 String iName)

fromStream

public void fromStream(ODocument iSource)

allow

public boolean allow(ORule.ResourceGeneric resourceGeneric,
 String resourceSpecific,
 int iCRUDOperation)

Specified by:

allow in interface OSecurityRole

hasRule

public boolean hasRule(ORule.ResourceGeneric resourceGeneric,
 String resourceSpecific)

Specified by:

hasRule in interface OSecurityRole

addRule

public ORole addRule(ORule.ResourceGeneric resourceGeneric,
 String resourceSpecific,
 int iOperation)

Specified by:

addRule in interface OSecurityRole

allow

@Deprecated
public boolean allow(String iResource,
 int iCRUDOperation)

Deprecated.

Specified by:

allow in interface OSecurityRole

hasRule

@Deprecated
public boolean hasRule(String iResource)

Deprecated.

Specified by:

hasRule in interface OSecurityRole

addRule

@Deprecated
public OSecurityRole addRule(String iResource,
 int iOperation)

Deprecated.

Specified by:

addRule in interface OSecurityRole

grant

@Deprecated
public OSecurityRole grant(String iResource,
 int iOperation)

Deprecated.

Specified by:

grant in interface OSecurityRole

revoke

@Deprecated
public OSecurityRole revoke(String iResource,
 int iOperation)

Deprecated.

Specified by:

revoke in interface OSecurityRole

grant

public ORole grant(ORule.ResourceGeneric resourceGeneric,
 String resourceSpecific,
 int iOperation)

Grant a permission to the resource.

Specified by:

grant in interface OSecurityRole

Returns:

revoke

public ORole revoke(ORule.ResourceGeneric resourceGeneric,
 String resourceSpecific,
 int iOperation)

Revoke a permission to the resource.

Specified by:

revoke in interface OSecurityRole

getName

public String getName()

Specified by:

getName in interface OSecurityRole

getMode

@Deprecated
public OSecurityRole.ALLOW_MODES getMode()

Deprecated.

Specified by:

getMode in interface OSecurityRole

setMode

@Deprecated
public ORole setMode(OSecurityRole.ALLOW_MODES iMode)

Deprecated.

Specified by:

setMode in interface OSecurityRole

getParentRole

public ORole getParentRole()

Specified by:

getParentRole in interface OSecurityRole

setParentRole

public ORole setParentRole(OSecurityRole iParent)

Specified by:

setParentRole in interface OSecurityRole

save

@Deprecated
public ORole save()

Deprecated.

save

public ORole save(ODatabaseSession database)

getRuleSet

public Set<ORule> getRuleSet()

Specified by:

getRuleSet in interface OSecurityRole

getRules

@Deprecated
public Map<String,Byte> getRules()

Deprecated.

toString

public String toString()

Overrides:

toString in class Object

getIdentity

public OIdentifiable getIdentity()

Specified by:

getIdentity in interface OSecurityRole

getPolicies

public Map<String,OSecurityPolicy> getPolicies()

Specified by:

getPolicies in interface OSecurityRole

getPolicy

public OSecurityPolicy getPolicy(String resource)

Specified by:

getPolicy in interface OSecurityRole

toStream

public ODocument toStream()

reload

public void reload()