com.orientechnologies.orient.core.metadata.security

Class ORestrictedAccessHook

java.lang.Object

com.orientechnologies.orient.core.hook.ODocumentHookAbstract

com.orientechnologies.orient.core.metadata.security.ORestrictedAccessHook

All Implemented Interfaces:

ORecordHook, ORecordHook.Scoped

public class ORestrictedAccessHook
extends ODocumentHookAbstract
implements ORecordHook.Scoped

Checks the access against restricted resources. Restricted resources are those documents of classes that implement ORestricted abstract class.

Author:

Luca Garulli

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

ORecordHook.DISTRIBUTED_EXECUTION_MODE, ORecordHook.HOOK_POSITION, ORecordHook.RESULT, ORecordHook.SCOPE, ORecordHook.Scoped, ORecordHook.TYPE

Field Summary

Fields inherited from class com.orientechnologies.orient.core.hook.ODocumentHookAbstract

database

Constructor Summary

Constructors

Constructor and Description
ORestrictedAccessHook(ODatabaseDocument database)

Method Summary

Modifier and Type	Method and Description
ORecordHook.DISTRIBUTED_EXECUTION_MODE	getDistributedExecutionMode()
ORecordHook.SCOPE[]	getScopes() Returns the array of scopes this hook interested in.
static boolean	isAllowed(ODatabaseDocument database, ODocument iDocument, ORestrictedOperation iAllowOperation, boolean iReadOriginal)
protected boolean	isAllowed(ODocument iDocument, ORestrictedOperation iAllowOperation, boolean iReadOriginal)
ORecordHook.RESULT	onRecordBeforeCreate(ODocument iDocument) It's called just before to create the new document.
ORecordHook.RESULT	onRecordBeforeDelete(ODocument iDocument) It's called just before to delete the document.
ORecordHook.RESULT	onRecordBeforeRead(ODocument iDocument) It's called just before to read the document.
ORecordHook.RESULT	onRecordBeforeUpdate(ODocument iDocument) It's called just before to update the document.

Methods inherited from class com.orientechnologies.orient.core.hook.ODocumentHookAbstract

filterBySchemaClass, getExcludeClasses, getIncludeClasses, onRecordAfterCreate, onRecordAfterDelete, onRecordAfterRead, onRecordAfterUpdate, onRecordCreateFailed, onRecordCreateReplicated, onRecordDeleteFailed, onRecordDeleteReplicated, onRecordFinalizeCreation, onRecordFinalizeDeletion, onRecordFinalizeUpdate, onRecordReadFailed, onRecordReadReplicated, onRecordUpdateFailed, onRecordUpdateReplicated, onTrigger, onUnregister, setExcludeClasses, setIncludeClasses

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

onTrigger, onUnregister

Constructor Detail

ORestrictedAccessHook

public ORestrictedAccessHook(ODatabaseDocument database)

Method Detail

getScopes

public ORecordHook.SCOPE[] getScopes()

Description copied from interface: ORecordHook.Scoped

Returns the array of scopes this hook interested in. By default, all available scopes are returned, implement/override this method to limit the scopes this hook may participate to lower the number of useless invocations of this hook.

Limiting the hook to proper scopes may give huge performance boost, especially if the hook ORecordHook.onTrigger(TYPE, ORecord) dispatcher implementation is heavy. In extreme cases, you may override the ORecordHook.onTrigger(TYPE, ORecord) to act directly on event ORecordHook.TYPE and exit early, scopes are just a more handy alternative to this.

Specified by:

getScopes in interface ORecordHook.Scoped

Returns:

the scopes of this hook.

See Also:

ORecordHook.SCOPE

getDistributedExecutionMode

public ORecordHook.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Specified by:

getDistributedExecutionMode in interface ORecordHook

onRecordBeforeCreate

public ORecordHook.RESULT onRecordBeforeCreate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to create the new document.

Overrides:

onRecordBeforeCreate in class ODocumentHookAbstract

Parameters:

iDocument - The document to create

Returns:

True if the document has been modified and a new marshalling is required, otherwise false

onRecordBeforeRead

public ORecordHook.RESULT onRecordBeforeRead(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to read the document.

Overrides:

onRecordBeforeRead in class ODocumentHookAbstract

Parameters:

iDocument - The document to read

Returns:

True if the document has been modified and a new marshalling is required, otherwise false

onRecordBeforeUpdate

public ORecordHook.RESULT onRecordBeforeUpdate(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to update the document.

Overrides:

onRecordBeforeUpdate in class ODocumentHookAbstract

Parameters:

iDocument - The document to update

Returns:

True if the document has been modified and a new marshalling is required, otherwise false

onRecordBeforeDelete

public ORecordHook.RESULT onRecordBeforeDelete(ODocument iDocument)

Description copied from class: ODocumentHookAbstract

It's called just before to delete the document.

Overrides:

onRecordBeforeDelete in class ODocumentHookAbstract

Parameters:

iDocument - The document to delete

Returns:

True if the document has been modified and a new marshalling is required, otherwise false

isAllowed

protected boolean isAllowed(ODocument iDocument,
                            ORestrictedOperation iAllowOperation,
                            boolean iReadOriginal)

isAllowed

public static boolean isAllowed(ODatabaseDocument database,
                                ODocument iDocument,
                                ORestrictedOperation iAllowOperation,
                                boolean iReadOriginal)