Java Portlet API V3.0 3.0.1 · javax.portlet.filter.FilterConfig

Method Summary

Modifier and Type	Method and Description
public String	Returns: the filter name getFilterName() Returns the filter-name of this filter as defined in the portlet deployment descriptor.
public String	Returns: initialization parameter, or `null` if the parameter does not exist. getInitParameter(String the name of the initialization parameter to return name) Returns a String containing the value of the named initialization parameter, or `null` if the parameter does not exist.
public Enumeration<String>	Returns: the names of the filter's initialization parameters, or an empty Enumeration if the filter has no initialization parameters. getInitParameterNames() Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters.
public PortletContext	Returns: the portlet context getPortletContext() Returns a reference to the `PortletContext` in which the caller is executing.

Method Detail

getFilterName	back to summary
public String getFilterName() Returns the filter-name of this filter as defined in the portlet deployment descriptor. Returns:String the filter name

getFilterName

back to summary

public String getFilterName()

Returns the filter-name of this filter as defined in the portlet deployment descriptor.

Returns:String: the filter name

getInitParameter back to summary

getInitParameter	back to summary
public String getInitParameter(String name) Returns a String containing the value of the named initialization parameter, or `null` if the parameter does not exist. Initialization parameters are defined in the portlet deployment descriptor. Parameters name:String the name of the initialization parameter to return Returns:String initialization parameter, or `null` if the parameter does not exist.

public String getInitParameter(String name)

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

Initialization parameters are defined in the portlet deployment descriptor.

Parameters

name:String: the name of the initialization parameter to return

Returns:String

initialization parameter, or null if the parameter does not exist.

getInitParameterNames	back to summary
public Enumeration<String> getInitParameterNames() Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters. Initialization parameters are defined in the portlet deployment descriptor. Returns:Enumeration<String> the names of the filter's initialization parameters, or an empty Enumeration if the filter has no initialization parameters.

getInitParameterNames

back to summary

public Enumeration<String> getInitParameterNames()

Returns the names of the filter's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the filter has no initialization parameters.

Initialization parameters are defined in the portlet deployment descriptor.

Returns:Enumeration<String>: the names of the filter's initialization parameters, or an empty Enumeration if the filter has no initialization parameters.

getPortletContext back to summary

getPortletContext	back to summary
public PortletContext getPortletContext() Returns a reference to the `PortletContext` in which the caller is executing. Returns:PortletContext the portlet context

public PortletContext getPortletContext()

Returns a reference to the PortletContext in which the caller is executing.

Returns:PortletContext: the portlet context

public Interface FilterConfig

Method Summary

Method Detail