org.openspaces.core.space.filter

Class MethodFilterFactoryBean

java.lang.Object

org.openspaces.core.space.filter.AbstractFilterProviderFactoryBean

org.openspaces.core.space.filter.AbstractFilterProviderAdapterFactoryBean

org.openspaces.core.space.filter.MethodFilterFactoryBean

All Implemented Interfaces:

FilterProviderFactory, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class MethodFilterFactoryBean
extends AbstractFilterProviderAdapterFactoryBean

A FilterProvider factory that accepts a Pojo filter with different operation callbacks that are marked using this factory. For each available operation there is a setter that accepts the method name to be invoked if the operation happened. Not setting a callback means that this filter will not listen to the mentioned operation. For example, if the filter (AbstractFilterProviderFactoryBean.setFilter(Object)) has a method called doSomethingBeforeWrite, the setBeforeWrite(String) will need to be set with doSomethingBeforeWrite.

The operation callback methods can different arguments. Please see FilterOperationDelegateInvoker for all the different possibilities.

For a Pojo adapter that uses annotation please see AnnotationFilterFactoryBean.

Author:

kimchy

See Also:

FilterOperationDelegate, FilterProvider, ISpaceFilter, FilterOperationCodes

Constructor Summary

Constructors

Constructor and Description
MethodFilterFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected Method	doGetCloseMethod() Returns the filter lifecycle method set with setFilterClose(String).
protected Method	doGetInitMethod() Returns the filter lifecycle method set with setFilterInit(String).
protected Map<Integer,org.openspaces.core.space.filter.FilterOperationDelegateInvoker>	doGetInvokerLookup() Creates an operation code to filter invoker map based on the AbstractFilterProviderFactoryBean.getFilter() delegate and the callbacks set on this factory.
void	setAfterAllNotifyTrigger(String afterAllNotifyTrigger) Filter callback after all notify trigger.
void	setAfterChange(String afterChange) Filter callback after change operation.
void	setAfterExecute(String afterExecute) Filter callback after execute operation.
void	setAfterNotifyTrigger(String afterNotifyTrigger) Filter callback after notify trigger.
void	setAfterRead(String afterRead) Filter callback after read operation.
void	setAfterReadMultiple(String afterReadMultiple) Filter callback after read multiple operation.
void	setAfterRemoveByLease(String afterRemoveByLease) Filter callback after an entry was removed due to lease expression or lease cancel.
void	setAfterTake(String afterTake) Filter callback after take operation.
void	setAfterTakeMultiple(String afterTakeMultiple) Filter callback after take multiple operation.
void	setAfterUpdate(String afterUpdate) Filter callback after update operation.
void	setAfterWrite(String afterWrite) Filter callback after write operation.
void	setBeforeAllNotifyTrigger(String beforeAllNotifyTrigger) Filter callback before all notify trigger.
void	setBeforeAuthentication(String beforeAuthentication) Filter callback before authentication operation.
void	setBeforeChange(String beforeChange) Filter callback before change operation.
void	setBeforeCleanSpace(String beforeCleanSpace) Filter callback after clean space operation.
void	setBeforeExecute(String beforeExecute) Filter callback before execute operation.
void	setBeforeNotify(String beforeNotify) Filter callback before notify operation.
void	setBeforeNotifyTrigger(String beforeNotifyTrigger) Filter callback before notify trigger.
void	setBeforeRead(String beforeRead) Filter callback before read operation.
void	setBeforeReadMultiple(String beforeReadMultiple) Filter callback before read multiple operation.
void	setBeforeRemoveByLease(String beforeRemoveByLease) Filter callback before an entry was removed due to lease expression or lease cancel.
void	setBeforeTake(String beforeTake) Filter callback before take operation.
void	setBeforeTakeMultiple(String beforeTakeMultiple) Filter callback before take multiple operation.
void	setBeforeUpdate(String beforeUpdate) Filter callback before update operation.
void	setBeforeWrite(String beforeWrite) Filter callback before write operation.
void	setFilterClose(String filterClose) Method name for filter lifecycle close callback.
void	setFilterInit(String filterInit) Method name for filter lifecycle init callback.

Methods inherited from class org.openspaces.core.space.filter.AbstractFilterProviderAdapterFactoryBean

addInvoker, doGetFilterProvider

Methods inherited from class org.openspaces.core.space.filter.AbstractFilterProviderFactoryBean

afterPropertiesSet, getBeanName, getFilter, getFilterProvider, setActiveWhenBackup, setBeanName, setEnabled, setFilter, setPriority, setSecurityFilter, setShutdownSpaceOnInitFailure

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodFilterFactoryBean

public MethodFilterFactoryBean()

Method Detail

doGetInvokerLookup

protected Map<Integer,org.openspaces.core.space.filter.FilterOperationDelegateInvoker> doGetInvokerLookup()

Creates an operation code to filter invoker map based on the AbstractFilterProviderFactoryBean.getFilter() delegate and the callbacks set on this factory.

Specified by:

doGetInvokerLookup in class AbstractFilterProviderAdapterFactoryBean

doGetInitMethod

protected Method doGetInitMethod()

Returns the filter lifecycle method set with setFilterInit(String).

Specified by:

doGetInitMethod in class AbstractFilterProviderAdapterFactoryBean

doGetCloseMethod

protected Method doGetCloseMethod()

Returns the filter lifecycle method set with setFilterClose(String).

Specified by:

doGetCloseMethod in class AbstractFilterProviderAdapterFactoryBean

setFilterInit

public void setFilterInit(String filterInit)

Method name for filter lifecycle init callback. Can either have no arguments or a single argument that accepts IJSpace.

setFilterClose

public void setFilterClose(String filterClose)

Method name for filter lifecycle close callback. Should have no arguments.

setBeforeWrite

public void setBeforeWrite(String beforeWrite)

Filter callback before write operation.

See Also:

FilterOperationCodes.BEFORE_WRITE

setBeforeAuthentication

public void setBeforeAuthentication(String beforeAuthentication)

Filter callback before authentication operation. Note, the method must have a single parameter of type SpaceContext.

See Also:

FilterOperationCodes.BEFORE_AUTHENTICATION

setAfterWrite

public void setAfterWrite(String afterWrite)

Filter callback after write operation.

See Also:

FilterOperationCodes.AFTER_WRITE

setBeforeRead

public void setBeforeRead(String beforeRead)

Filter callback before read operation.

See Also:

FilterOperationCodes.BEFORE_READ

setAfterRead

public void setAfterRead(String afterRead)

Filter callback after read operation.

See Also:

FilterOperationCodes.AFTER_READ

setBeforeTake

public void setBeforeTake(String beforeTake)

Filter callback before take operation.

See Also:

FilterOperationCodes.BEFORE_TAKE

setAfterTake

public void setAfterTake(String afterTake)

Filter callback after take operation.

See Also:

FilterOperationCodes.AFTER_TAKE

setBeforeNotify

public void setBeforeNotify(String beforeNotify)

Filter callback before notify operation.

See Also:

FilterOperationCodes.BEFORE_NOTIFY

setBeforeCleanSpace

public void setBeforeCleanSpace(String beforeCleanSpace)

Filter callback after clean space operation.

See Also:

FilterOperationCodes.BEFORE_CLEAN_SPACE

setBeforeUpdate

public void setBeforeUpdate(String beforeUpdate)

Filter callback before update operation.

See Also:

FilterOperationCodes.BEFORE_UPDATE

setAfterUpdate

public void setAfterUpdate(String afterUpdate)

Filter callback after update operation.

See Also:

FilterOperationCodes.AFTER_UPDATE

setBeforeReadMultiple

public void setBeforeReadMultiple(String beforeReadMultiple)

Filter callback before read multiple operation.

See Also:

FilterOperationCodes.BEFORE_READ_MULTIPLE

setAfterReadMultiple

public void setAfterReadMultiple(String afterReadMultiple)

Filter callback after read multiple operation.

See Also:

FilterOperationCodes.AFTER_READ_MULTIPLE

setBeforeTakeMultiple

public void setBeforeTakeMultiple(String beforeTakeMultiple)

Filter callback before take multiple operation.

See Also:

FilterOperationCodes.BEFORE_TAKE_MULTIPLE

setAfterTakeMultiple

public void setAfterTakeMultiple(String afterTakeMultiple)

Filter callback after take multiple operation.

See Also:

FilterOperationCodes.AFTER_TAKE_MULTIPLE

setBeforeNotifyTrigger

public void setBeforeNotifyTrigger(String beforeNotifyTrigger)

Filter callback before notify trigger. Indicates that a matched notify template was found to the current entry event.

See Also:

FilterOperationCodes.BEFORE_NOTIFY_TRIGGER

setAfterNotifyTrigger

public void setAfterNotifyTrigger(String afterNotifyTrigger)

Filter callback after notify trigger. Indicates that a notify trigger was successful.

See Also:

FilterOperationCodes.AFTER_NOTIFY_TRIGGER

setBeforeAllNotifyTrigger

public void setBeforeAllNotifyTrigger(String beforeAllNotifyTrigger)

Filter callback before all notify trigger. Indicates that at least one notify template is matched to the current entry event.

See Also:

FilterOperationCodes.BEFORE_ALL_NOTIFY_TRIGGER

setAfterAllNotifyTrigger

public void setAfterAllNotifyTrigger(String afterAllNotifyTrigger)

Filter callback after all notify trigger. Indicates that all notify templates that are matched to the current entry event were triggered and returned or failed.

See Also:

FilterOperationCodes.AFTER_ALL_NOTIFY_TRIGGER

setBeforeRemoveByLease

public void setBeforeRemoveByLease(String beforeRemoveByLease)

Filter callback before an entry was removed due to lease expression or lease cancel.

See Also:

FilterOperationCodes.BEFORE_REMOVE

setAfterRemoveByLease

public void setAfterRemoveByLease(String afterRemoveByLease)

Filter callback after an entry was removed due to lease expression or lease cancel.

See Also:

FilterOperationCodes.AFTER_REMOVE

setBeforeExecute

public void setBeforeExecute(String beforeExecute)

Filter callback before execute operation.

See Also:

FilterOperationCodes.BEFORE_EXECUTE

setAfterExecute

public void setAfterExecute(String afterExecute)

Filter callback after execute operation.

See Also:

FilterOperationCodes.AFTER_EXECUTE

setBeforeChange

public void setBeforeChange(String beforeChange)

Filter callback before change operation.

See Also:

FilterOperationCodes.BEFORE_CHANGE

setAfterChange

public void setAfterChange(String afterChange)

Filter callback after change operation.

See Also:

FilterOperationCodes.AFTER_CHANGE