com.xpn.xwiki.web
Class XWikiAction

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by com.xpn.xwiki.web.XWikiAction
Direct Known Subclasses:
AttachAction, CancelAction, ChartingAction, ChartWizardAction, CommentAddAction, CreateChartAction, DeleteAction, DeleteAttachmentAction, DotAction, DownloadAction, DownloadRevAction, EditAction, GetTablesAction, InlineAction, LifeBlogAction, LockAction, LoginAction, LoginErrorAction, LogoutAction, ObjectAddAction, ObjectRemoveAction, PDFAction, PreviewAction, PreviewChartAction, PropAddAction, PropDeleteAction, PropUpdateAction, RegisterAction, RollbackAction, SaveAction, SkinAction, SVGAction, UploadAction, ViewAction, ViewAttachRevAction, ViewrevAction

public abstract class XWikiAction
extends org.apache.struts.action.Action

A simple action that handles the display and editing of an wiki page..

The action support an action URL. The action in the URL controls what this action class does. The following values are supported:


Field Summary
 
Fields inherited from class org.apache.struts.action.Action
defaultLocale, servlet
 
Constructor Summary
XWikiAction()
           
 
Method Summary
 boolean action(XWikiContext context)
           
 org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
          Handle server requests.
 java.lang.String getRealPath(java.lang.String path)
           
protected  void handleRevision(XWikiContext context)
           
 java.lang.String render(XWikiContext context)
           
protected  void sendRedirect(XWikiResponse response, java.lang.String page)
           
 
Methods inherited from class org.apache.struts.action.Action
addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XWikiAction

public XWikiAction()
Method Detail

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest req,
                                                      javax.servlet.http.HttpServletResponse resp)
                                               throws java.lang.Exception,
                                                      javax.servlet.ServletException
Handle server requests.

Overrides:
execute in class org.apache.struts.action.Action
Parameters:
mapping - The ActionMapping used to select this instance
form - The optional ActionForm bean for this request (if any)
req - The HTTP request we are processing
resp - The HTTP response we are creating
Throws:
java.io.IOException - if an input/output error occurs
javax.servlet.ServletException - if a servlet exception occurs
java.lang.Exception

getRealPath

public java.lang.String getRealPath(java.lang.String path)

action

public boolean action(XWikiContext context)
               throws XWikiException
Throws:
XWikiException

render

public java.lang.String render(XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

handleRevision

protected void handleRevision(XWikiContext context)
                       throws XWikiException
Throws:
XWikiException

sendRedirect

protected void sendRedirect(XWikiResponse response,
                            java.lang.String page)
                     throws XWikiException
Throws:
XWikiException


Copyright 2003 Ludovic Dubost