ome.security

Class SecurityFilterHolder

java.lang.Object

ome.security.SecurityFilterHolder

All Implemented Interfaces:

SecurityFilter

public class SecurityFilterHolder
extends Object
implements SecurityFilter

Security dispatcher holding each currently active SecurityFilter instance and allowing dispatching between them.

Since:

4.4

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

SecurityFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected AllGroupsSecurityFilter	allgroups
protected CurrentDetails	cd
protected ThreadLocal<SecurityFilter>	current
protected OneGroupSecurityFilter	onegroup

Fields inherited from interface ome.security.SecurityFilter

current_user, is_adminorpi, is_nonprivate, is_share

Constructor Summary

Constructors

Constructor and Description
SecurityFilterHolder(CurrentDetails cd, OneGroupSecurityFilter onegroup, AllGroupsSecurityFilter allgroups)

Method Summary

Methods

Modifier and Type	Method and Description
SecurityFilter	choose()
void	disable(org.hibernate.Session sess) Reverts the call to SecurityFilter.enable(Session, EventContext).
void	enable(org.hibernate.Session sess, EventContext ec) Enables this filter with the settings from this filter.
String	getDefaultCondition() Return the string to be used as the condition.
String	getName() Name of this security filter.
Map<String,String>	getParameterTypes() Return a mapping of the hibernate types for each of the parameters that the condition takes.
boolean	passesFilter(org.hibernate.Session s, ome.model.internal.Details d, EventContext c) tests that the Details argument passes the security test that this filter defines.

Methods inherited from class java.lang.Object

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

Field Detail

allgroups

protected final AllGroupsSecurityFilter allgroups

onegroup

protected final OneGroupSecurityFilter onegroup

cd

protected final CurrentDetails cd

current

protected ThreadLocal<SecurityFilter> current

Constructor Detail

SecurityFilterHolder

public SecurityFilterHolder(CurrentDetails cd,
                    OneGroupSecurityFilter onegroup,
                    AllGroupsSecurityFilter allgroups)

Method Detail

choose

public SecurityFilter choose()

getName

public String getName()

Description copied from interface: SecurityFilter

Name of this security filter. By default this will likely return the simple class name for the instance. This value will be used to activate the filter on the Hibernate session.

Specified by:

getName in interface SecurityFilter

getDefaultCondition

public String getDefaultCondition()

Description copied from interface: SecurityFilter

Return the string to be used as the condition.

Specified by:

getDefaultCondition in interface SecurityFilter

getParameterTypes

public Map<String,String> getParameterTypes()

Description copied from interface: SecurityFilter

Return a mapping of the hibernate types for each of the parameters that the condition takes.

Specified by:

getParameterTypes in interface SecurityFilter

enable

public void enable(org.hibernate.Session sess,
          EventContext ec)

Description copied from interface: SecurityFilter

Enables this filter with the settings from this filter. The intent is that after this call, no Hibernate queries will return any objects that would fail a call to #passesFilter(Details, Long, Long, boolean, boolean, boolean, List).

Specified by:

enable in interface SecurityFilter

Parameters:

sess - Non-null.

ec - Non-null.

disable

public void disable(org.hibernate.Session sess)

Description copied from interface: SecurityFilter

Reverts the call to SecurityFilter.enable(Session, EventContext).

Specified by:

disable in interface SecurityFilter

passesFilter

public boolean passesFilter(org.hibernate.Session s,
                   ome.model.internal.Details d,
                   EventContext c)

Description copied from interface: SecurityFilter

tests that the Details argument passes the security test that this filter defines. The two must be kept in sync. This will be used mostly by the OmeroInterceptor.onLoad(Object, java.io.Serializable, Object[], String[], org.hibernate.type.Type[]) method.

Specified by:

passesFilter in interface SecurityFilter

d - Details instance. If null (or if its Permissions are null all rights will be assumed.

Returns:

true if the object to which this