ome.security.sharing

Class SharingACLVoter

java.lang.Object

ome.security.sharing.SharingACLVoter

All Implemented Interfaces:

ACLVoter

public class SharingACLVoter
extends java.lang.Object
implements ACLVoter

Since:

3.0-Beta4

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

IShare

Constructor Summary

Constructors

Constructor and Description
SharingACLVoter(CurrentDetails cd, SystemTypes sysTypes, ShareStore store, TokenHolder tokenHolder)

Method Summary

Modifier and Type	Method and Description
boolean	allowAnnotate(IObject iObject, Details trustedDetails) test whether the given object should be annotatable given the trusted details.
boolean	allowChmod(IObject iObject) test whether the given object can have its Permissions changed within the current security context.
boolean	allowCreation(IObject iObject) test whether the given object should be insertable into the DB.
boolean	allowDelete(IObject iObject, Details trustedDetails) test whether the given object should be deleteable given the trusted details.
boolean	allowLoad(org.hibernate.Session session, java.lang.Class<? extends IObject> klass, Details d, long id) test whether the object of the given Class with the given Details should be loadable in the current security context.
boolean	allowUpdate(IObject iObject, Details trustedDetails) test whether the given object should be updateable given the trusted details.
void	postProcess(IObject object) Gives the ACLVoter instance a chance to act on the IObject after the transaction but before finishing the AOP stack.
java.util.Set<java.lang.String>	restrictions(IObject object) Provide the active restrictions for this IObject.
void	setPermittedClasses(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Class<? extends IObject>>> objectClassesPermitted) Specify object classes based on restriction constants in Permissions that do not always have those restrictions.
void	throwCreationViolation(IObject iObject) throws a SecurityViolation based on the given IObject and the context of the current user.
void	throwDeleteViolation(IObject iObject) throws a SecurityViolation based on the given IObject and the context of the current user.
protected void	throwDisabled(java.lang.String action)
void	throwLoadViolation(IObject iObject) throws a SecurityViolation based on the given IObject and the context of the current user.
void	throwUpdateViolation(IObject iObject) throws a SecurityViolation based on the given IObject and the context of the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharingACLVoter

public SharingACLVoter(CurrentDetails cd,
                       SystemTypes sysTypes,
                       ShareStore store,
                       TokenHolder tokenHolder)

Method Detail

allowChmod

public boolean allowChmod(IObject iObject)

Description copied from interface: ACLVoter

test whether the given object can have its Permissions changed within the current security context.

Specified by:

allowChmod in interface ACLVoter

Parameters:

iObject - a model object

Returns:

if the object's permissions may be changed

allowLoad

public boolean allowLoad(org.hibernate.Session session,
                         java.lang.Class<? extends IObject> klass,
                         Details d,
                         long id)

Description copied from interface: ACLVoter

test whether the object of the given Class with the given Details should be loadable in the current security context. This method does not take an actual object because that will not be generated until after loading is permitted. The SecuritySystem implementors will usually call ACLVoter.throwLoadViolation(IObject) if this method returns false.

Specified by:

allowLoad in interface ACLVoter

Parameters:

session - the Hibernate session to use for the query

klass - a non-null class to test for loading

d - the non-null trusted details (usually from the db) for this instance

id - the id of the object which will be loaded. As opposed to the rest of the object, this must be known.

Returns:

true if loading of this object can proceed

See Also:

ACLEventListener.onPostLoad(org.hibernate.event.PostLoadEvent)

throwLoadViolation

public void throwLoadViolation(IObject iObject)
                        throws SecurityViolation

Description copied from interface: ACLVoter

throws a SecurityViolation based on the given IObject and the context of the current user.

Specified by:

throwLoadViolation in interface ACLVoter

Parameters:

iObject - Non-null object which caused this violation

Throws:

SecurityViolation

See Also:

ACLEventListener.onPostLoad(org.hibernate.event.PostLoadEvent)

allowCreation

public boolean allowCreation(IObject iObject)

Description copied from interface: ACLVoter

test whether the given object should be insertable into the DB. No trusted details is passed to this method, since for transient entities there are no trusted values. The SecuritySystem implementors will usually call ACLVoter.throwCreationViolation(IObject) if this method returns false.

Specified by:

allowCreation in interface ACLVoter

Parameters:

iObject - a non-null entity to test for creation.

Returns:

true if creation of this object can proceed

See Also:

ACLEventListener.onPreInsert(org.hibernate.event.PreInsertEvent)

throwCreationViolation

public void throwCreationViolation(IObject iObject)
                            throws SecurityViolation

Description copied from interface: ACLVoter

throws a SecurityViolation based on the given IObject and the context of the current user.

Specified by:

throwCreationViolation in interface ACLVoter

Parameters:

iObject - Non-null object which caused this violation

Throws:

SecurityViolation

See Also:

ACLEventListener.onPreInsert(org.hibernate.event.PreInsertEvent)

allowAnnotate

public boolean allowAnnotate(IObject iObject,
                             Details trustedDetails)

Description copied from interface: ACLVoter

test whether the given object should be annotatable given the trusted details. The details will usually be retrieved from the current state array coming from the database.

Specified by:

allowAnnotate in interface ACLVoter

Parameters:

iObject - a non-null entity to test for update.

trustedDetails - a Details instance that is known to be valid.

Returns:

true if annotation of this object can proceed

allowUpdate

public boolean allowUpdate(IObject iObject,
                           Details trustedDetails)

Description copied from interface: ACLVoter

test whether the given object should be updateable given the trusted details. The details will usually be retrieved from the current state array coming from the database. The SecuritySystem implementors will usually call ACLVoter.throwUpdateViolation(IObject) if this method returns false.

Specified by:

allowUpdate in interface ACLVoter

Parameters:

iObject - a non-null entity to test for update.

trustedDetails - a Details instance that is known to be valid.

Returns:

true if update of this object can proceed

See Also:

ACLEventListener.onPreUpdate(org.hibernate.event.PreUpdateEvent)

throwUpdateViolation

public void throwUpdateViolation(IObject iObject)
                          throws SecurityViolation

Description copied from interface: ACLVoter

throws a SecurityViolation based on the given IObject and the context of the current user.

Specified by:

throwUpdateViolation in interface ACLVoter

Parameters:

iObject - Non-null object which caused this violation

Throws:

SecurityViolation

See Also:

ACLEventListener.onPreUpdate(org.hibernate.event.PreUpdateEvent)

allowDelete

public boolean allowDelete(IObject iObject,
                           Details trustedDetails)

Description copied from interface: ACLVoter

test whether the given object should be deleteable given the trusted details. The details will usually be retrieved from the current state array coming from the database. The SecuritySystem implementors will usually call ACLVoter.throwDeleteViolation(IObject) if this method returns false.

Specified by:

allowDelete in interface ACLVoter

Parameters:

iObject - a non-null entity to test for deletion.

trustedDetails - a Details instance that is known to be valid.

Returns:

true if deletion of this object can proceed

See Also:

ACLEventListener.onPreDelete(org.hibernate.event.PreDeleteEvent)

throwDeleteViolation

public void throwDeleteViolation(IObject iObject)
                          throws SecurityViolation

Description copied from interface: ACLVoter

throws a SecurityViolation based on the given IObject and the context of the current user.

Specified by:

throwDeleteViolation in interface ACLVoter

Parameters:

iObject - Non-null object which caused this violation

Throws:

SecurityViolation

See Also:

ACLEventListener.onPreDelete(org.hibernate.event.PreDeleteEvent)

restrictions

public java.util.Set<java.lang.String> restrictions(IObject object)

Description copied from interface: ACLVoter

Provide the active restrictions for this IObject. See PolicyService for further details.

Specified by:

restrictions in interface ACLVoter

Parameters:

object - a model object

Returns:

the restrictions applying for the object

setPermittedClasses

public void setPermittedClasses(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Class<? extends IObject>>> objectClassesPermitted)

Description copied from interface: ACLVoter

Specify object classes based on restriction constants in Permissions that do not always have those restrictions. Previously set classes may not be cleared by subsequent calls to this method.

Specified by:

setPermittedClasses in interface ACLVoter

Parameters:

objectClassesPermitted - the map from restriction constants to object classes that may not have those restrictions

postProcess

public void postProcess(IObject object)

Description copied from interface: ACLVoter

Gives the ACLVoter instance a chance to act on the IObject after the transaction but before finishing the AOP stack.

Specified by:

postProcess in interface ACLVoter

Parameters:

object - a model object

throwDisabled

protected void throwDisabled(java.lang.String action)