com.stellent.cis.client.api.scs.internal.filter
Interface ISCSServerFilterInfo

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

public interface ISCSServerFilterInfo
extends ISCSObject

Allows sending of parameter information to the request filters through the ISCSServerBinder objects.

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

static java.lang.String	REQUEST_FILTER_CACHE
static java.lang.String	REQUEST_FILTER_OPTIMIZED_FILE_STREAM
static java.lang.String	REQUEST_FILTER_URL_REWRITE

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getFilterProperty(java.lang.String cisFilterName, java.lang.String property) Set a property for a given filter.
boolean	isRequestFilterDisabled(java.lang.String cisFilterName) Determine if a particular filter is disabled for this request.
boolean	isRequestFiltersDiabled()
void	setFilterProperty(java.lang.String cisFilterName, java.lang.String propertyName, java.lang.String propertyValue) Set a specific filter property.
void	setRequestFilterDisabled(java.lang.String cisFilterName, boolean disabled) Enable or disable a particular request filter.
void	setRequestFiltersDisabled(boolean disabled) Disable all the request filters

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Field Detail

REQUEST_FILTER_CACHE

static final java.lang.String REQUEST_FILTER_CACHE

See Also:

Constant Field Values

REQUEST_FILTER_URL_REWRITE

static final java.lang.String REQUEST_FILTER_URL_REWRITE

See Also:

Constant Field Values

REQUEST_FILTER_OPTIMIZED_FILE_STREAM

static final java.lang.String REQUEST_FILTER_OPTIMIZED_FILE_STREAM

See Also:

Constant Field Values

Method Detail

isRequestFiltersDiabled

boolean isRequestFiltersDiabled()

Returns:

true to disable

setRequestFiltersDisabled

void setRequestFiltersDisabled(boolean disabled)

Disable all the request filters

Parameters:

disabled - true to disable all the request filters, false to allow per-filter control

isRequestFilterDisabled

boolean isRequestFilterDisabled(java.lang.String cisFilterName)

Determine if a particular filter is disabled for this request. The filters control aspects of how a given request is handled through the CIS request processor. These filters are particular to the CIS server and have no relationship to content server filters.

Parameters:

cisFilterName - the name of the filter

Returns:

true if the filter is enabled

setRequestFilterDisabled

void setRequestFilterDisabled(java.lang.String cisFilterName,
                              boolean disabled)

Enable or disable a particular request filter.

Parameters:

cisFilterName - the filter name

disabled - true to disable, false to use the filter default

See Also:

isRequestFilterDisabled(String)

getFilterProperty

java.lang.String getFilterProperty(java.lang.String cisFilterName,
                                   java.lang.String property)

Set a property for a given filter. The property will be appropriately name-spaced into the current active object.

Parameters:

cisFilterName - the name of the filter to which this property applies

property - the property name

Returns:

the property value or null if no property is found

setFilterProperty

void setFilterProperty(java.lang.String cisFilterName,
                       java.lang.String propertyName,
                       java.lang.String propertyValue)

Set a specific filter property.

Parameters:

cisFilterName - the filter name

propertyName - the property name

propertyValue - the property value

See Also:

getFilterProperty(String, String)