com.sun.portal.providers.context
Class ClientPropertiesFilter

java.lang.Object
  extended bycom.sun.portal.providers.context.PropertiesFilter
      extended bycom.sun.portal.providers.context.ClientPropertiesFilter

public class ClientPropertiesFilter
extends PropertiesFilter

This class implements the "client" filter.


Constructor Summary
ClientPropertiesFilter()
          Constructor.
 
Method Summary
static List getClientFilters(ProviderContext context, boolean required)
          A convenience method for getting a list of ClientPropertiesFilters for the client based on the given context.
static List getClientFilters(ProviderContext context, String clientType, boolean required)
          A convenience method for getting a list of ClientPropertiesFilters for the given client.
static Set getClientParents(ProviderContext context)
          Gets the set of parents for the client based on the context.
static Set getClientParents(ProviderContext context, String clientType)
          Gets the set of parents for the specified client.
 String getCondition()
          Return "client"
 boolean match(String condition, String value)
          Does the given condition and value match this client filter? This match method is based on a case-sensitive string comparison.
 
Methods inherited from class com.sun.portal.providers.context.PropertiesFilter
getValue, init, isRequired, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClientPropertiesFilter

public ClientPropertiesFilter()
Constructor. Do not call this directly. Instead use PropertiesFilterFactory.get(CLIENT_PROPERTIESFILTER_CLASSNAME, ...).

See Also:
PropertiesFilterFactory.get(String, String, boolean)
Method Detail

getCondition

public String getCondition()
Return "client"

Specified by:
getCondition in class PropertiesFilter
Returns:
"client"

match

public boolean match(String condition,
                     String value)
Does the given condition and value match this client filter? This match method is based on a case-sensitive string comparison. In other words, the condition should be "client" and value should exactly match the value that was used to instantiate this filter.

Specified by:
match in class PropertiesFilter
Parameters:
condition - filter condition. i.e. "client"
value - client type
Returns:
boolean value indicating whether match has succeeded or not.

getClientFilters

public static List getClientFilters(ProviderContext context,
                                    String clientType,
                                    boolean required)
                             throws PropertiesFilterException
A convenience method for getting a list of ClientPropertiesFilters for the given client.

Parameters:
context - provider context
clientType - client type string
required - boolean value that determines whether the filters are required or optional
Returns:
List of ClientPropertiesFilters
Throws:
PropertiesFilterException

getClientFilters

public static List getClientFilters(ProviderContext context,
                                    boolean required)
                             throws PropertiesFilterException
A convenience method for getting a list of ClientPropertiesFilters for the client based on the given context.

Parameters:
context - provider context
required - boolean value that determines whether the filters are required or optional
Returns:
List of ClientPropertiesFilters
Throws:
PropertiesFilterException

getClientParents

public static Set getClientParents(ProviderContext context,
                                   String clientType)
Gets the set of parents for the specified client.

Parameters:
context - provider context
clientType - client type string
Returns:
Set of parent strings for the client

getClientParents

public static Set getClientParents(ProviderContext context)
Gets the set of parents for the client based on the context.

Parameters:
context - provider context
Returns:
Set of parent strings for the client