ome.security

Interface SecurityFilter

All Known Implementing Classes:

AbstractSecurityFilter, AllGroupsSecurityFilter, OneGroupSecurityFilter, SecurityFilterHolder

public interface SecurityFilter

Base filter interface ...

Since:

4.4

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

ticket117, ticket1154, ticket3529

Field Summary

Fields

Modifier and Type	Field and Description
static String	current_user
static String	is_adminorpi
static String	is_nonprivate
static String	is_share

Method Summary

Methods

Modifier and Type	Method and Description
void	disable(org.hibernate.Session sess) Reverts the call to 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 session, Details d, EventContext c) tests that the Details argument passes the security test that this filter defines.

Field Detail

is_share

static final String is_share

See Also:

Constant Field Values

is_adminorpi

static final String is_adminorpi

See Also:

Constant Field Values

is_nonprivate

static final String is_nonprivate

See Also:

Constant Field Values

current_user

static final String current_user

See Also:

Constant Field Values

Method Detail

getName

String getName()

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.

getParameterTypes

Map<String,String> getParameterTypes()

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

getDefaultCondition

String getDefaultCondition()

Return the string to be used as the condition.

passesFilter

boolean passesFilter(org.hibernate.Session session,
                   Details d,
                   EventContext c)

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.

Parameters:

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

Returns:

true if the object to which this

enable

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

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).

Parameters:

sess - Non-null.

ec - Non-null.

disable

void disable(org.hibernate.Session sess)

Reverts the call to enable(Session, EventContext).