Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.ibm.wps.portlets.struts
Class WpsStrutsFilteredViewCommand

    java.lang.Object
      com.ibm.wps.portlets.struts.WpsStrutsViewCommand
          com.ibm.wps.portlets.struts.WpsStrutsFilteredViewCommand

All Implemented Interfaces:
  IViewCommand, java.io.Serializable

Direct Known Subclasses:
  WpsStrutsViewStaticCommand, WpsStrutsViewXmlCommand

    public abstract class WpsStrutsFilteredViewCommand

extends WpsStrutsViewCommand

Filter the command with various Transcoding functions.

Since:
  5.1
See Also:
  Serialized Form

Field Summary
`protected static MessageResources` | `messages` The message resources for the Struts Portlet Framework.
`protected java.lang.Class` | `wpsStrutsTranscodingRequestWrapper` The transcoding request wrapper.

Fields inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand
`LAST_MODIFIED, PREFIX`

Constructor Summary
`WpsStrutsFilteredViewCommand(HttpServletRequest request)` Constructor for the WpsStrutsFilteredViewCommand object

Method Summary
`void` | `execute(PortletRequest request, PortletResponse response, ViewCommandExecutionContext executionContext)` The execute method for filtered view commands
`protected abstract void` | `executeCommand(PortletRequest request, PortletResponse response, ViewCommandExecutionContext executionContext)` The execute command method that subclasses must implement
`boolean` | `inStrutsPortletFilterContext(PortletRequest request)` Find out whether a Struts Portlet Filter (for legacy environments) is configured for this scenario.
`protected boolean` | `isDebugOn()` Returns true if debug is enabled
`protected boolean` | `isWarnOn()` Returns true if warning is enabled
`protected void` | `trace(java.lang.String method, java.lang.String message)` Trace the message.

Methods inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand
`addAttribute, addAttributeNameToSave, addAttributeTypeToSave, addParameterNameToSave, execute, getLastModified, getPrefix, getRemoveOnModeChange, getSavedAttributes, getSavedCommand, removeAttribute, removeAttributeNameToSave, removeAttributeTypeToSave, removeParameterNameToSave, repopulateRequest, saveAsAttribute, saveAsParameter, saveAttribute, saveAttributes, saveAttributes, saveCommand, saveCommand, saveParameter, saveParameters, setLastModified, setPrefix, setRemoveOnModeChange, setSavedAttributes`

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

Field Detail

### messages

    protected static MessageResources messages

  The message resources for the Struts Portlet Framework.

### wpsStrutsTranscodingRequestWrapper

    protected java.lang.Class wpsStrutsTranscodingRequestWrapper

  The transcoding request wrapper.

Constructor Detail

### WpsStrutsFilteredViewCommand

    public WpsStrutsFilteredViewCommand(HttpServletRequest request)

  Constructor for the WpsStrutsFilteredViewCommand object

  Parameters:
    `request` - the http servlet request

Method Detail

### execute

    public void execute(PortletRequest request,
                        PortletResponse response,
                        ViewCommandExecutionContext executionContext)

  The execute method for filtered view commands

  Specified by:
    `execute` in interface `IViewCommand`
  Overrides:
    `execute` in class `WpsStrutsViewCommand`
  Parameters:
    `request` - The request object
    `request` - The response object
    `executionContext` - the execution context object
    `response` - The response object

### inStrutsPortletFilterContext

    public boolean inStrutsPortletFilterContext(PortletRequest request)

  Find out whether a Struts Portlet Filter (for legacy environments) is configured for this scenario.

  Parameters:
    `request` - the request object
  Returns:
    true if we are, and should pass through the contents instead of transcoding it ourselves.

### isWarnOn

    protected boolean isWarnOn()

  Returns true if warning is enabled

  Returns:
    true if warn is on

### trace

    protected void trace(java.lang.String method,
                         java.lang.String message)

  Trace the message. Does not check to see if tracing is enabled.

  Parameters:
    `method` - the method name
    `message` - the message

### isDebugOn

    protected boolean isDebugOn()

  Returns true if debug is enabled

  Returns:
    true if debug is on

### executeCommand

    protected abstract void executeCommand(PortletRequest request,
                                           PortletResponse response,
                                           ViewCommandExecutionContext executionContext)

  The execute command method that subclasses must implement

  Parameters:
    `request` - The request object
    `request` - The response object
    `executionContext` - the execution context object

Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD