|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.wps.portlets.struts.WpsStrutsViewCommand com.ibm.wps.portlets.struts.WpsStrutsViewActionCommand
public class WpsStrutsViewActionCommand
The WpsStrutsViewActionCommand
class is a command pattern class used to
execute a render action. When the request processor detects a Struts action that
implements the IStrutsPrepareRender action, the ViewCommandFactory will create
this command object. When this command object is executed, the Struts action will be
executed.
Field Summary | |
---|---|
protected static Log |
log
The commons-logging instance for this class. |
protected static MessageResources |
messages
The message resources for the Struts Portlet Framework. |
protected static java.lang.String |
URI
Name of the request attribute for the URI string. |
Fields inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand |
---|
LAST_MODIFIED, PREFIX |
Constructor Summary | |
---|---|
WpsStrutsViewActionCommand()
Constructs the WspStrutsViewActionCommand object. |
|
WpsStrutsViewActionCommand(java.lang.String uri,
PortletRequest request)
Constructs the StrutsViewActionCommand object. |
Method Summary | |
---|---|
static void |
addAttributeNameToSave(java.lang.String attributeName)
Adds the name of an attribute from the object request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
static void |
addAttributeTypeToSave(java.lang.Class attributeType)
Adds the class type of an attribute from the request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
static void |
addParameterNameToSave(java.lang.String parameterName)
Adds the name of an parameter from the object request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
void |
execute(PortletRequest request,
PortletResponse response,
ViewCommandExecutionContext executionContext)
Executes the given command given the request and response objects. |
java.lang.String |
getUri(PortletRequest request)
Returns the URI. |
static void |
removeAttributeNameToSave(java.lang.String attributeName)
Removes the name of an attribute from the list of attribute names to save. |
static void |
removeAttributeTypeToSave(java.lang.Class attributeType)
Removes the class type of the request attribute from the list of attributes to save. |
static void |
removeParameterNameToSave(java.lang.String parameterName)
Removes the name of a parameter from the list of parameter names to save. |
void |
saveAttributes(HttpServletRequest request,
ViewCommandExecutionContext executionContext)
Saves the attributes specific to JSP rendering. |
void |
setUri(PortletRequest request,
java.lang.String uri)
Sets the URI for this command. |
Methods inherited from class com.ibm.wps.portlets.struts.WpsStrutsViewCommand |
---|
addAttribute, execute, getLastModified, getPrefix, getRemoveOnModeChange, getSavedAttributes, getSavedCommand, removeAttribute, repopulateRequest, saveAsAttribute, saveAsParameter, saveAttribute, 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 |
---|
protected static Log log
protected static final java.lang.String URI
protected static MessageResources messages
Constructor Detail |
---|
public WpsStrutsViewActionCommand()
public WpsStrutsViewActionCommand(java.lang.String uri, PortletRequest request)
uri
- the uri path to the JSPrequest
- The request object to save context information fromMethod Detail |
---|
public java.lang.String getUri(PortletRequest request)
request
- the portlet request object
public void setUri(PortletRequest request, java.lang.String uri)
request
- the portlet request objecturi
- the URI for the JSP.public void execute(PortletRequest request, PortletResponse response, ViewCommandExecutionContext executionContext) throws PortletException
execute
in interface IViewCommand
execute
in class WpsStrutsViewCommand
request
- The request objectresponse
- The response objectexecutionContext
- the execution context object
PortletException
- if the request cannot be fulfilledpublic void saveAttributes(HttpServletRequest request, ViewCommandExecutionContext executionContext)
saveAttributes
in class WpsStrutsViewCommand
request
- the request objectcontext
- the context objectpublic static void addAttributeNameToSave(java.lang.String attributeName)
attributeName
- the name of the attributepublic static void removeAttributeNameToSave(java.lang.String attributeName)
attributeName
- the name of the attributepublic static void addAttributeTypeToSave(java.lang.Class attributeType)
attributeType
- the attribute typepublic static void removeAttributeTypeToSave(java.lang.Class attributeType)
attributeType
- the attribute typepublic static void addParameterNameToSave(java.lang.String parameterName)
parameterName
- the name of the parameterpublic static void removeParameterNameToSave(java.lang.String parameterName)
parameterName
- the name of the parameter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |