FilterProvider (GigaSpaces XAP 15.2.0 API)

java.lang.Object
- com.j_spaces.core.filters.FilterProvider

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NotifyAcknowledgeFilter
```
public class FilterProvider
extends Object
implements Serializable
```
A filter provider acts as a wrapper around an ISpaceFilter allowing to provide a an already instantiated filter using SpaceFinder with custom Properties.

Author:

kimchy

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`FilterProvider()`
`FilterProvider(ISpaceFilter filter)`
`FilterProvider(String filterName, ISpaceFilter filter)` Constructs a new filter provider using the provided filter and the filter name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ISpaceFilter`	`getFilter()` Returns the filter object.
`String`	`getFilterParam()`
`String`	`getName()` Returns the name of the filter.
`int[]`	`getOpCodes()` Returns the list of operation codes to be filtered.
`int`	`getPriority()` Returns the priority of the filter.
`boolean`	`isActiveWhenBackup()` Returns `true` if the filter should be active when the space is in backup mode.
`boolean`	`isEnabled()` Returns `true` if the filter is enabled.
`boolean`	`isPassFilterEntry()`
`boolean`	`isSecurityFilter()` Returns `true` if the filter is a security filter.
`boolean`	`isShutdownSpaceOnInitFailure()` Returns `true` if the space should shutdown on filter init failure.
`void`	`setActiveWhenBackup(boolean activeWhenBackup)` `true` if the filter should be active when the space is in backup mode.
`void`	`setEnabled(boolean enabled)` `true` if the filter is enabled.
`void`	`setFilterParam(String filterParam)`
`void`	`setName(String name)`
`void`	`setOpCodes(int... opCodes)` Sets the list of operation codes to be filtered.
`void`	`setPassFilterEntry(boolean passFilterEntry)`
`void`	`setPriority(int priority)` Sets the priority of the filter.
`void`	`setSecurityFilter(boolean securityFilter)` `true` if the filter is a security filter.
`void`	`setShutdownSpaceOnInitFailure(boolean shutdownSpaceOnInitFailure)` `true` if the space should shutdown on filter init failure.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FilterProvider
```
public FilterProvider()
```
  - FilterProvider
```
public FilterProvider(ISpaceFilter filter)
```
  - FilterProvider
```
public FilterProvider(String filterName,
                      ISpaceFilter filter)
```
    Constructs a new filter provider using the provided filter and the filter name.
    
    Parameters:
    
    filterName - The filter name
    
    filter - The filter
- Method Detail
  - getName
```
public String getName()
```
    Returns the name of the filter.
  - setName
```
public void setName(String name)
```
  - getFilter
```
public ISpaceFilter getFilter()
```
    Returns the filter object.
  - isActiveWhenBackup
```
public boolean isActiveWhenBackup()
```
    Returns true if the filter should be active when the space is in backup mode. Default to true.
  - setActiveWhenBackup
```
public void setActiveWhenBackup(boolean activeWhenBackup)
```
    true if the filter should be active when the space is in backup mode. Default to true.
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if the filter is enabled. Defaults to true.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    true if the filter is enabled. Defaults to true.
  - isSecurityFilter
```
public boolean isSecurityFilter()
```
    Returns true if the filter is a security filter. Defaults to false.
  - setSecurityFilter
```
public void setSecurityFilter(boolean securityFilter)
```
    true if the filter is a security filter. Defaults to false.
  - isShutdownSpaceOnInitFailure
```
public boolean isShutdownSpaceOnInitFailure()
```
    Returns true if the space should shutdown on filter init failure. Defaults to false.
  - setShutdownSpaceOnInitFailure
```
public void setShutdownSpaceOnInitFailure(boolean shutdownSpaceOnInitFailure)
```
    true if the space should shutdown on filter init failure. Defaults to false.
  - getOpCodes
```
public int[] getOpCodes()
```
    Returns the list of operation codes to be filtered.
    
    See Also:
    
    FilterOperationCodes
  - setOpCodes
```
public void setOpCodes(int... opCodes)
```
    Sets the list of operation codes to be filtered.
    
    See Also:
    
    FilterOperationCodes
  - getPriority
```
public int getPriority()
```
    Returns the priority of the filter. Defaults to 0.
  - setPriority
```
public void setPriority(int priority)
```
    Sets the priority of the filter. Defaults to 0.
  - getFilterParam
```
public String getFilterParam()
```
  - setFilterParam
```
public void setFilterParam(String filterParam)
```
  - setPassFilterEntry
```
public void setPassFilterEntry(boolean passFilterEntry)
```
  - isPassFilterEntry
```
public boolean isPassFilterEntry()
```

Class FilterProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterProvider

FilterProvider

FilterProvider

Method Detail

getName

setName

getFilter

isActiveWhenBackup

setActiveWhenBackup

isEnabled

setEnabled

isSecurityFilter

setSecurityFilter

isShutdownSpaceOnInitFailure

setShutdownSpaceOnInitFailure

getOpCodes

setOpCodes

getPriority

setPriority

getFilterParam

setFilterParam

setPassFilterEntry

isPassFilterEntry