ome.tools.hibernate

Class ProxyCleanupFilter

java.lang.Object

ome.util.ContextFilter

ome.tools.hibernate.ProxyCleanupFilter

All Implemented Interfaces:

Filter

public class ProxyCleanupFilter
extends ContextFilter

removes all proxies from a return graph to prevent ClassCastExceptions and Session Closed exceptions. You need to be careful with printing. Calling toString() on an unitialized object will break before filtering is complete. Note: we aren't setting the filtered collections here because it's "either null/unloaded or filtered". We will definitiely filter here, so it would just increase bandwidth. As of 4.4.0, this class is also responsible for various security-based modifications to returned Details objects.

Since:

1.0

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

Trac ticket #8277

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProxyCleanupFilter.Interceptor wraps a filter for each invocation

Field Summary

Fields

Modifier and Type	Field and Description
protected ACLVoter	acl
protected CurrentDetails	current
protected Map	unloadedObjectCache

Fields inherited from class ome.util.ContextFilter

_cache, _context

Constructor Summary

Constructors

Constructor and Description
ProxyCleanupFilter() Passes nulls to ProxyCleanupFilter(ACLVoter, CurrentDetails) such that all restricted objects will be unloaded.
ProxyCleanupFilter(ACLVoter acl, CurrentDetails current) Construct a proxy cleanup filter that checks the security restrictions on certain objects.

Method Summary

Modifier and Type	Method and Description
protected void	doFilter(String arg0, Object arg1)
Collection	filter(String fieldId, Collection c) iterates over the contents of the collection and filters each.
Filterable	filter(String fieldId, Filterable f)
Map	filter(String fieldId, Map m) filters both the key and value sets of the map.

Methods inherited from class ome.util.ContextFilter

addSeen, afterFilter, beforeFilter, currentContext, doFilter, doFilter, enter, exit, filter, filter, hasntSeen, pop, previousContext, push

Methods inherited from class java.lang.Object

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

Field Detail

unloadedObjectCache

protected Map unloadedObjectCache

acl

protected final ACLVoter acl

current

protected final CurrentDetails current

Constructor Detail

ProxyCleanupFilter

public ProxyCleanupFilter()

Passes nulls to ProxyCleanupFilter(ACLVoter, CurrentDetails) such that all restricted objects will be unloaded.

ProxyCleanupFilter

public ProxyCleanupFilter(ACLVoter acl,
                          CurrentDetails current)

Construct a proxy cleanup filter that checks the security restrictions on certain objects.

Parameters:

acl - the ACL voter

current - the current thread's security context

Method Detail

filter

public Filterable filter(String fieldId,
                         Filterable f)

Specified by:

filter in interface Filter

Overrides:

filter in class ContextFilter

filter

public Collection filter(String fieldId,
                         Collection c)

Description copied from class: ContextFilter

iterates over the contents of the collection and filters each. Adds itself to the context. This is somewhat dangerous.

Specified by:

filter in interface Filter

Overrides:

filter in class ContextFilter

filter

public Map filter(String fieldId,
                  Map m)

Description copied from class: ContextFilter

filters both the key and value sets of the map. Adds itself to the context. Somewhat dangerous.

Specified by:

filter in interface Filter

Overrides:

filter in class ContextFilter

doFilter

protected void doFilter(String arg0,
                        Object arg1)

Overrides:

doFilter in class ContextFilter