ome.security.policy

Class BasePolicy

java.lang.Object

ome.security.policy.BasePolicy

Type Parameters:

T -

All Implemented Interfaces:

Policy

Direct Known Subclasses:

BinaryAccessPolicy

public abstract class BasePolicy
extends Object
implements Policy

Simple base class for Policy implementations which always returns true for isRestricted(IObject) and always fails on checkRestriction(IObject).

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Class<ome.model.IObject>>	types

Constructor Summary

Constructors

Constructor and Description
BasePolicy(Set<Class<ome.model.IObject>> types)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkRestriction(ome.model.IObject obj) Like #isRestricted(Policy) but throws an appropriate SecurityViolation subclass if the restriction is active.
abstract String	getName() Unique name for a class of restrictions that this Policy will enforce.
Set<Class<ome.model.IObject>>	getTypes() Each Policy should tell the PolicyService which types of IObject instances it cares about.
boolean	isRestricted(ome.model.IObject obj) Checks whether or not this instance would throw a SecurityViolation if the same instance were passed to Policy.checkRestriction(IObject).

Methods inherited from class java.lang.Object

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

Field Detail

types

protected final Set<Class<ome.model.IObject>> types

Constructor Detail

BasePolicy

public BasePolicy(Set<Class<ome.model.IObject>> types)

Method Detail

getName

public abstract String getName()

Description copied from interface: Policy

Unique name for a class of restrictions that this Policy will enforce. This string will be sent to clients via Permissions.copyExtendedRestrictions() in order to prevent exceptions, and server-code will pass the same name to the check method to potentially have an exception thrown.

Specified by:

getName in interface Policy

getTypes

public Set<Class<ome.model.IObject>> getTypes()

Description copied from interface: Policy

Each Policy should tell the PolicyService which types of IObject instances it cares about. Only those which are of interest to some Policy need be considered.

Specified by:

getTypes in interface Policy

isRestricted

public boolean isRestricted(ome.model.IObject obj)

Description copied from interface: Policy

Checks whether or not this instance would throw a SecurityViolation if the same instance were passed to Policy.checkRestriction(IObject). This is likely determined by first testing the type of the IObject and then that the current user context has access to the given context.

Specified by:

isRestricted in interface Policy

Parameters:

obj - a non-null IObject instance.

Returns:

true if this Policy decides that a restriction should be placed on the passed context.

checkRestriction

public void checkRestriction(ome.model.IObject obj)

Description copied from interface: Policy

Like #isRestricted(Policy) but throws an appropriate SecurityViolation subclass if the restriction is active.

Specified by:

checkRestriction in interface Policy