com.orientechnologies.orient.core.metadata.security

Class OUser

java.lang.Object

com.orientechnologies.orient.core.type.ODocumentWrapper

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

com.orientechnologies.orient.core.metadata.security.OUser

All Implemented Interfaces:

OSecurityUser, Serializable

Direct Known Subclasses:

OSystemUser

public class OUser
extends OIdentity
implements OSecurityUser

Contains the user settings about security and permissions. Each user has one or more roles associated. Roles contains the permission rules that define what the user can access and what he cannot.

Author:

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

See Also:

ORole, Serialized Form

Nested Class Summary

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

OSecurityUser.STATUSES

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN
static String	CLASS_NAME
static String	PASSWORD_FIELD
protected Set<ORole>	roles

Fields inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

document

Constructor Summary

Constructors

Constructor and Description
OUser() Constructor used in unmarshalling.
OUser(ODocument iSource) Create the user by reading the source document.
OUser(String iName)
OUser(String iUserName, String iUserPassword)

Method Summary

Modifier and Type	Method and Description
OUser	addRole(OSecurityRole iRole)
OUser	addRole(String iRole)
ORole	allow(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation) Checks if the user has the permission to access to the requested resource for the requested operation.
OSecurityRole	allow(String iResource, int iOperation) Deprecated.
ORole	checkIfAllowed(ORule.ResourceGeneric resourceGeneric, String resourceSpecific, int iOperation) Checks if the user has the permission to access to the requested resource for the requested operation.
OSecurityRole	checkIfAllowed(String iResource, int iOperation) Deprecated.
boolean	checkPassword(String iPassword)
protected ORole	createRole(ODocument roleDoc) Derived classes can override createRole() to return an extended ORole implementation or null if the role should not be added.
static boolean	encodePassword(ODocument iDocument)
static String	encryptPassword(String iPassword)
void	fromStream(ODocument iSource)
OSecurityUser.STATUSES	getAccountStatus()
OIdentifiable	getIdentity()
String	getName()
String	getPassword()
Set<ORole>	getRoles()
String	getUserType()
boolean	hasRole(String iRoleName, boolean iIncludeInherited)
boolean	isRuleDefined(ORule.ResourceGeneric resourceGeneric, String resourceSpecific) Checks if a rule was defined for the user.
boolean	isRuleDefined(String iResource) Deprecated.
boolean	removeRole(String iRoleName)
OUser	save()
void	setAccountStatus(OSecurityUser.STATUSES accountStatus)
OUser	setName(String iName)
OUser	setPassword(String iPassword)
String	toString()

Methods inherited from class com.orientechnologies.orient.core.type.ODocumentWrapper

equals, getDocument, hashCode, load, reload, reload, reload, save, toStream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.metadata.security.OSecurityUser

getDocument

Field Detail

ADMIN

public static final String ADMIN

See Also:

Constant Field Values

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

PASSWORD_FIELD

public static final String PASSWORD_FIELD

See Also:

Constant Field Values

roles

protected Set<ORole> roles

Constructor Detail

OUser

public OUser()

Constructor used in unmarshalling.

OUser

public OUser(String iName)

OUser

public OUser(String iUserName,
             String iUserPassword)

OUser

public OUser(ODocument iSource)

Create the user by reading the source document.

Method Detail

encryptPassword

public static final String encryptPassword(String iPassword)

encodePassword

public static boolean encodePassword(ODocument iDocument)

fromStream

public void fromStream(ODocument iSource)

Overrides:

fromStream in class ODocumentWrapper

createRole

protected ORole createRole(ODocument roleDoc)

Derived classes can override createRole() to return an extended ORole implementation or null if the role should not be added.

allow

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

Checks if the user has the permission to access to the requested resource for the requested operation.

Specified by:

allow in interface OSecurityUser

Parameters:

iOperation - Requested operation

Returns:

The role that has granted the permission if any, otherwise a OSecurityAccessException exception is raised

Throws:

OSecurityAccessException

checkIfAllowed

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

Checks if the user has the permission to access to the requested resource for the requested operation.

Specified by:

checkIfAllowed in interface OSecurityUser

Parameters:

iOperation - Requested operation

Returns:

The role that has granted the permission if any, otherwise null

allow

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

Deprecated.

Specified by:

allow in interface OSecurityUser

checkIfAllowed

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

Deprecated.

Specified by:

checkIfAllowed in interface OSecurityUser

isRuleDefined

@Deprecated
public boolean isRuleDefined(String iResource)

Deprecated.

Specified by:

isRuleDefined in interface OSecurityUser

isRuleDefined

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

Checks if a rule was defined for the user.

Specified by:

isRuleDefined in interface OSecurityUser

Returns:

True is a rule is defined, otherwise false

checkPassword

public boolean checkPassword(String iPassword)

Specified by:

checkPassword in interface OSecurityUser

getName

public String getName()

Specified by:

getName in interface OSecurityUser

setName

public OUser setName(String iName)

Specified by:

setName in interface OSecurityUser

getPassword

public String getPassword()

Specified by:

getPassword in interface OSecurityUser

setPassword

public OUser setPassword(String iPassword)

Specified by:

setPassword in interface OSecurityUser

getAccountStatus

public OSecurityUser.STATUSES getAccountStatus()

Specified by:

getAccountStatus in interface OSecurityUser

setAccountStatus

public void setAccountStatus(OSecurityUser.STATUSES accountStatus)

Specified by:

setAccountStatus in interface OSecurityUser

getRoles

public Set<ORole> getRoles()

Specified by:

getRoles in interface OSecurityUser

addRole

public OUser addRole(String iRole)

Specified by:

addRole in interface OSecurityUser

addRole

public OUser addRole(OSecurityRole iRole)

Specified by:

addRole in interface OSecurityUser

removeRole

public boolean removeRole(String iRoleName)

Specified by:

removeRole in interface OSecurityUser

hasRole

public boolean hasRole(String iRoleName,
                       boolean iIncludeInherited)

Specified by:

hasRole in interface OSecurityUser

save

public OUser save()

Overrides:

save in class ODocumentWrapper

toString

public String toString()

Overrides:

toString in class ODocumentWrapper

getIdentity

public OIdentifiable getIdentity()

Specified by:

getIdentity in interface OSecurityUser

getUserType

public String getUserType()

Specified by:

getUserType in interface OSecurityUser