|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.portal.struts.command.StrutsViewCommand com.ibm.portal.struts.command.StrutsViewJspCommand
public class StrutsViewJspCommand
Command pattern class which provides a mechanism to encapsulate the information needed to redisplay a view for dynamic content like JSPs.
Field Summary | |
---|---|
protected static java.lang.String |
QUERY
Name of the request attribute for the query string. |
protected static java.lang.String |
URI
Name of request attribute for the URI string. |
Fields inherited from class com.ibm.portal.struts.command.StrutsViewCommand |
---|
CONTENT_TYPE, messages, PREFIX |
Constructor Summary | |
---|---|
StrutsViewJspCommand()
Default construtor. |
|
StrutsViewJspCommand(java.lang.String uri,
PortletRequest request)
Constructs the view command. |
Method Summary | |
---|---|
static void |
addAttributeNameToSave(java.lang.String attributeName)
Adds the name of an attribute from the object request the 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 request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase. |
protected void |
addQueryParameters(java.lang.String query,
PortletRequest request)
Adds the query parameters to the request object. |
void |
execute(RenderRequest request,
RenderResponse response,
ViewCommandExecutionContext executionContext)
Executes the given command given the request and response objects. |
java.lang.String |
getQueryString(PortletRequest request)
Returns the query string. |
java.lang.String |
getUri(PortletRequest request)
Returns the URI. |
protected void |
includeURL(java.lang.String uri,
RenderRequest request,
RenderResponse response,
ViewCommandExecutionContext executionContext)
Includes the URL. |
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. |
void |
saveAttributes(PortletRequest request,
ViewCommandExecutionContext executionContext)
Saves the attributes specific to JSP rendering. |
void |
setQueryString(PortletRequest request,
java.lang.String query)
Sets the query string. |
void |
setUri(PortletRequest request,
java.lang.String uri)
Sets the URI. |
Methods inherited from class com.ibm.portal.struts.command.StrutsViewCommand |
---|
addAttribute, getContentType, getPrefix, getRemoveOnModeChange, getSavedAttributes, getSavedCommand, removeAttribute, repopulateRequest, saveAsAttribute, saveAttribute, saveAttributes, saveCommand, saveCommand, setContentType, setContentType, 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 final java.lang.String URI
protected static final java.lang.String QUERY
Constructor Detail |
---|
public StrutsViewJspCommand()
public StrutsViewJspCommand(java.lang.String uri, PortletRequest request)
ViewCommandFactory
will make the determination
that the URI is for a JSP file.
uri
- the uri path to the JSPrequest
- The request object to save context information fromMethod Detail |
---|
public void execute(RenderRequest request, RenderResponse response, ViewCommandExecutionContext executionContext) throws PortletException
execute
in interface IViewCommand
execute
in class StrutsViewCommand
request
- The request objectresponse
- The response objectexecutionContext
- the execution context object
PortletException
- if the request cannot be fulfilledprotected void includeURL(java.lang.String uri, RenderRequest request, RenderResponse response, ViewCommandExecutionContext executionContext) throws PortletException
uri
- the URI to includerequest
- the request objectresponse
- the reponse objectexecutionContext
- the execution context
PortletException
- if file can not be includedprotected void addQueryParameters(java.lang.String query, PortletRequest request)
query
- the query stringrequest
- the request objectpublic void saveAttributes(PortletRequest request, ViewCommandExecutionContext executionContext)
saveAttributes
in class StrutsViewCommand
request
- the request objectexecutionContext
- the context objectpublic java.lang.String getQueryString(PortletRequest request)
request
- the portlet request object
public void setQueryString(PortletRequest request, java.lang.String query)
request
- the portlet request objectquery
- the query stringpublic java.lang.String getUri(PortletRequest request)
request
- the portlet request object
null
public void setUri(PortletRequest request, java.lang.String uri)
ViewCommandFactory
will make the determination
that the URI is for a JSP file.
request
- the portlet request objecturi
- the uripublic 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 type
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |