Package com.appiancorp.ap2
Class PortletUpdateAction
java.lang.Object
com.appiancorp.web.framework.kernel.main.Action
com.appiancorp.common.struts.BaseAction
com.appiancorp.common.struts.BaseViewAction
com.appiancorp.common.struts.BaseUpdateAction
com.appiancorp.ap2.PortletUpdateAction
- All Implemented Interfaces:
com.appiancorp.web.framework.kernel.main.IAction
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Framework for updating portlets.
The
portletmain
method must be implemented in the children.
The method will contain the logic for updating the specific
Portlet
, and for determining the ActionForward
after the Portlet
is updated.
The canAcces
method currently checks if the user has
editor privileges and can perform an update.
(@see com.appiancorp.suiteapi.portal.Portlet#PORTLET_ACCESS_LEVEL_EDIT )
It can be overwritten to give anyone privileges by always returning
true
as it is done in BaseUpdateAction
- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.common.struts.BaseUpdateAction
FORWARD_CANCEL, FORWARD_INVALID_TOKEN, FORWARD_PREPARE, REQUEST_FORM_STATE, REQUEST_RECOVERED, REQUEST_TOKEN, REQUEST_TOKEN_OVERRIDE, STATE_PREPARE, STATE_SAVE, STATE_VALIDATE
Fields inherited from class com.appiancorp.common.struts.BaseAction
FORWARD_ERROR, FORWARD_NO_ACCESS, FORWARD_SUCCESS
Fields inherited from class com.appiancorp.web.framework.kernel.main.Action
servlet
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
canAccess
(com.appiancorp.web.framework.kernel.main.IActionMapping m_, javax.servlet.http.HttpServletRequest q_) Deprecated.Checks if the user has update privileges on thePortlet
.static void
clearPortletTarget
(com.appiancorp.ap2.PortalRequest pq_) Deprecated.static void
clearPortletTarget
(javax.servlet.http.HttpServletRequest q_) Deprecated.Clears the portlet target action path, so that the next time the portlet is loaded it will use the default $t from its tiles config.final com.appiancorp.web.framework.kernel.main.IActionForward
main
(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated.Executes theportletmain
method of its child class, returns the childActionForward
, and resets thePortletTarget
to benull
;abstract com.appiancorp.web.framework.kernel.main.IActionForward
portletMain
(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated.Abstract method that must be overriden to specify theActionForward
after thePortlet
updatesMethods inherited from class com.appiancorp.common.struts.BaseUpdateAction
afterPrepare, afterValidate, beforePrepare, beforeValidate, handleInvalidToken, prepare, shouldSetSessionAttributes, validate
Methods inherited from class com.appiancorp.common.struts.BaseViewAction
addOutput, afterMain, beforeMain, getOutputValue, getServiceContext
Methods inherited from class com.appiancorp.common.struts.BaseAction
addError, addError, addError, addError, addError, addError, addError, addError, addMessage, addMessage, addMessage, addMessage, decodeParameters, execute, generateToken, getAuthorizationActionName, getAuthorizationProvider, getValueFromRequest, getValueFromRequest, initBundle, isTokenValid, isTokenValid, requiresAuthorization, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken
Methods inherited from class com.appiancorp.web.framework.kernel.main.Action
addErrors, addMessages, execute, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, saveErrors, saveMessages, setLocale, setServlet
-
Field Details
-
FORM_FORWARD
Deprecated.- See Also:
-
-
Constructor Details
-
PortletUpdateAction
public PortletUpdateAction()Deprecated.
-
-
Method Details
-
main
public final com.appiancorp.web.framework.kernel.main.IActionForward main(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated.Executes theportletmain
method of its child class, returns the childActionForward
, and resets thePortletTarget
to benull
;- Specified by:
main
in classBaseViewAction
- Parameters:
m_
- the mappingf_
- the formq_
- the requestr_
- the response- Returns:
- an
ActionForward
-
portletMain
public abstract com.appiancorp.web.framework.kernel.main.IActionForward portletMain(com.appiancorp.web.framework.kernel.main.IActionMapping m_, com.appiancorp.web.framework.kernel.main.IActionForm f_, javax.servlet.http.HttpServletRequest q_, javax.servlet.http.HttpServletResponse r_) Deprecated.Abstract method that must be overriden to specify theActionForward
after thePortlet
updates- Parameters:
m_
- the mappingf_
- the formq_
- the requestr_
- the response- Returns:
- an
ActionForward
-
canAccess
protected boolean canAccess(com.appiancorp.web.framework.kernel.main.IActionMapping m_, javax.servlet.http.HttpServletRequest q_) Deprecated.Checks if the user has update privileges on thePortlet
. Guards against people updatingportlets
they do not have access to. This can be extended and overriden to return alwaystrue
if anyone can update.- Overrides:
canAccess
in classBaseAction
- Parameters:
m_
- the mapping of a particular request to an instance of a particularAction
classq_
- the request- Returns:
true
if the user has edit privileges otherwisefalse
-
clearPortletTarget
public static void clearPortletTarget(javax.servlet.http.HttpServletRequest q_) Deprecated.Clears the portlet target action path, so that the next time the portlet is loaded it will use the default $t from its tiles config.- Parameters:
q_
- the request
-
clearPortletTarget
public static void clearPortletTarget(com.appiancorp.ap2.PortalRequest pq_) Deprecated.
-