org.mycore.frontend.servlets
Class MCRWebCLIServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.mycore.frontend.servlets.MCRServlet
              org.mycore.frontend.servlets.MCRWebCLIServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class MCRWebCLIServlet
extends MCRServlet

Handles request from AJAX GUI.

Since:

2.0

Author:

Thomas Scheffler (yagee)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mycore.frontend.servlets.MCRServlet

BASE_URL_ATTRIBUTE, trustedProxies

Constructor Summary

MCRWebCLIServlet()

Method Summary

protected void	doGetPost(MCRServletJob job) Provides the access for the ajax gui.
protected static List<MCRCommand>	getCommands()
void	init()

Methods inherited from class org.mycore.frontend.servlets.MCRServlet

buildRedirectURL, doGet, doGet, doPost, doPost, generateActiveLinkErrorpage, generateErrorPage, getBaseURL, getLastModified, getLayoutService, getProperty, getRemoteAddr, getServletBaseURL, getSession, handleException, initTrustedProxies, render, reportException, think

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MCRWebCLIServlet

public MCRWebCLIServlet()

Method Detail

init

public void init()
          throws ServletException

Overrides:

init in class MCRServlet

Throws:

ServletException

doGetPost

protected void doGetPost(MCRServletJob job)
                  throws Exception

Provides the access for the ajax gui. Two parameters are recognized: request and run

While run will not return anything else but a HTTP return code, it is used to submit a new command to the current MCRSession command queue (see addCommand method).

On the other hand: request can be used to receive some information from the command execution.

• getStatus will return

  {"running": return of MCRWebCLIContainer.isRunning()}

• getStatus will return MCRWebCLIContainer.getLogs()
• getKnownCommands will return

  {"commands":[
  simple class name of MCR.CLI.Classes.Internal: [commands return by MCRExternalCommandInterface.getPossibleCommands()]]
  ]}

• getCommandQueue will return

  {"commandQueue":[return of MCRWebCLIContainer.getCommandQueue()]}

The content type of the OK response is application/x-json.

Overrides:

doGetPost in class MCRServlet

Throws:

Exception

getCommands

protected static List<MCRCommand> getCommands()