com.nitido.nimx.nuggets.iplanetset
Class Filter

java.lang.Object
  com.nitido.nimx.nuggets.iplanetset.Filter

public class Filter
extends java.lang.Object

The data object for message filter.

A message filter is composed of three major fields:

1. conditions
2. action
3. operator

The field "conditions" is a vector of FilterCondition objects. Each condition contains the test expression as indicated in the JavaDoc of the FilterCondition class

The field "action" is the FilterAction object that indicate what action to executed if the conditions are satisfied.

The field "operator" specifies how the server would evaluate the conditions. There are two valid operator "allof" and "anyof". This class has declared them as constants ALL and ANY respectively. The ALL operator indicates the filter action will be invoked only if all the condition are satisfied. The ANY operator tells the server to launch the action if one of the condition is true.

If the filters were first created through the iPlanet Delegated Administrator, they will also contain the components:

1. name
2. template
3. message
4. require

The field "name" specifies the name used by iPlanet Delegated Administrator to identify the filter.

The field "template" is the name of the template that the iPlanet Delegated Administrator used to create the filter.

The field "message" includes messages that is used by iPlanet Delegated Administrator to generate the interface messages.

The field "require" indicates what extension the rule requires.

Field Summary

static java.lang.String	ALL Constants of the message filter operator string "allof".
static java.lang.String	ANY Constants of the message filter operator string "anyof".

Constructor Summary

Filter(java.lang.String filterString)
Ldap string to filter constructor.

Filter(java.lang.String name, java.lang.String template, java.lang.String fullRule)
The ultmate advance constructor.

Filter(java.lang.String name, java.lang.String template, java.lang.String message, java.lang.String require, java.util.Vector conditions, java.lang.String operator, FilterAction action)
An advance constructor that allows the user to specify the name and iPlanet filter template name.

Filter(java.util.Vector conditions, java.lang.String operator, FilterAction action)
Default constructor for the application.

Method Summary

FilterAction	getAction()
java.util.Vector	getConditions()
java.lang.String	getFullRule()
java.lang.String	getMessage()
java.lang.String	getName()
java.lang.String	getOperator()
int	getOrder()
java.lang.String	getRequire()
java.lang.String	getTemplate()
void	setAction(FilterAction action)
void	setConditions(java.util.Vector conditions)
void	setFullRule(java.lang.String fullRule)
void	setMessage(java.lang.String message)
void	setName(java.lang.String name)
void	setOperator(java.lang.String operator)
void	setOrder(int order)
void	setRequire(java.lang.String require)
void	setTemplate(java.lang.String template)
java.lang.String	toLdapString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final java.lang.String ANY

Constants of the message filter operator string "anyof".

See Also:

Constant Field Values

ALL

public static final java.lang.String ALL

Constants of the message filter operator string "allof".

See Also:

Constant Field Values

Constructor Detail

Filter

public Filter(java.util.Vector conditions,
              java.lang.String operator,
              FilterAction action)

Default constructor for the application.

This is the constructor that you usually use.

Parameters:

conditions - A vector of FilterCondition objects.

operator - the constants ANY or ALL. (To indicate the action will be launched if all or one of the condition is satisfied).

action - The FilterAction object that describes the action.

Filter

public Filter(java.lang.String name,
              java.lang.String template,
              java.lang.String message,
              java.lang.String require,
              java.util.Vector conditions,
              java.lang.String operator,
              FilterAction action)

An advance constructor that allows the user to specify the name and iPlanet filter template name.

Parameters:

name - The name of the filter.

template - The template name as defined by iPlanet Delegated Administrator.

message - The UI format messages used by iPlanet Delegated Administrator.

require - The required extension.

conditions - A vector of FilterCondition objects.

operator - the constants ANY or ALL. (To indicate the action will be launched if all or one of the condition is satisfied).

action - The FilterAction object that describes the action.

Filter

public Filter(java.lang.String name,
              java.lang.String template,
              java.lang.String fullRule)

The ultmate advance constructor. This constructor allows the developer to fully specify the complete message filter rule according to the RFC 3028. If you have specified the fullRule, the nugget will ignore all the other fields such as message, require, conditions, operator and action.

Filter

public Filter(java.lang.String filterString)

Ldap string to filter constructor. This constructor will parse the string retrieved from the server and then populate the fields.

Parameters:

filterString - the string from the LDAP server.

Method Detail

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setTemplate

public void setTemplate(java.lang.String template)

getTemplate

public java.lang.String getTemplate()

setMessage

public void setMessage(java.lang.String message)

getMessage

public java.lang.String getMessage()

setRequire

public void setRequire(java.lang.String require)

getRequire

public java.lang.String getRequire()

setConditions

public void setConditions(java.util.Vector conditions)

getConditions

public java.util.Vector getConditions()

setOperator

public void setOperator(java.lang.String operator)

getOperator

public java.lang.String getOperator()

setAction

public void setAction(FilterAction action)

getAction

public FilterAction getAction()

setFullRule

public void setFullRule(java.lang.String fullRule)

getFullRule

public java.lang.String getFullRule()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toLdapString

public java.lang.String toLdapString()