planetj.dataengine.sqloperation.http
Class HttpOperationManager

java.lang.Object
  planetj.dataengine.sqloperation.http.HttpOperationManager

public class HttpOperationManager

extends java.lang.Object

This class contains methods for handling and preparing Operations. It handles actions such as executing or putting objects in the request or response.

Field Summary

static java.lang.String

className

Constructor Summary

protected

HttpOperationManager() HttpOperationManager constructor.

Method Summary

java.lang.StringBuffer	appendOperationInstructions(Operation operation, java.lang.StringBuffer html) Deprecated. This method is no longer supported as of (5/23/2003). It was replaced with HTMLGenerator.appendParagraphHeading(String, StringBuffer). This method will be removed on (01/01/2004).
java.lang.StringBuffer	appendOperationURI(Operation operation, java.lang.StringBuffer sb) Appends a complete URI that can be used to directly access the operation
java.lang.StringBuffer	appendOperationURI(Operation operation, java.lang.StringBuffer sb, HttpServletRequest req) Appends a complete URI that can be used to directly access the operation
java.lang.String	getBaseURL() Gets the base URL
IOperationContext	getContext(Operation operation, java.lang.String contextKey, HttpServletRequest request) Gets the SQLOperation's ApplicationSQLContext.
java.lang.Object	prepareOperation(Operation operation, boolean replaceContext, HttpServletRequest request, HttpServletResponse response) Deprecated. - use same method with row parameter added.
java.lang.Object	prepareOperation(Operation operation, DataEngineServlet servlet, boolean replaceContext, HttpServletRequest request, HttpServletResponse response) Deprecated. - use same method with row parameter added.
java.lang.Object	prepareOperation(Operation operation, Row associatedRow, boolean replaceContext, HttpServletRequest request, HttpServletResponse response) Prepares the given Operation to be viewed.
java.lang.Object	prepareOperation(Operation operation, Row associatedRow, DataEngineServlet servlet, boolean replaceContext, ExecutingContext ec, HttpServletRequest request, HttpServletResponse response) Prepares the given Operation to be viewed.
java.lang.Object	prepareOperation(Operation operation, Row associatedRow, DataEngineServlet servlet, boolean replaceContext, HttpServletRequest request, HttpServletResponse response) Deprecated. This method now takes in an ExecutingContext object
void	setBaseURL(java.lang.String newBaseURL) Sets the base URL.
static void	setSingleton(HttpOperationManager singleton) Sets the singleton instance of the HttpOperationManager.
static HttpOperationManager	singleton() Gets the singleton instance of HttpOperationManager

Methods inherited from class java.lang.Object

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

Field Detail

className

public static final java.lang.String className

Constructor Detail

HttpOperationManager

protected HttpOperationManager()

HttpOperationManager constructor.

Method Detail

appendOperationInstructions

public java.lang.StringBuffer appendOperationInstructions(Operation operation,
                                                          java.lang.StringBuffer html)
                                                   throws CMException

Deprecated. This method is no longer supported as of (5/23/2003). It was replaced with HTMLGenerator.appendParagraphHeading(String, StringBuffer). This method will be removed on (01/01/2004).

Appends the givin operation's instructions. The instructions are generated within a table

Throws:

CMException

appendOperationURI

public java.lang.StringBuffer appendOperationURI(Operation operation,
                                                 java.lang.StringBuffer sb)
                                          throws CMException

Appends a complete URI that can be used to directly access the operation

Throws:

CMException

appendOperationURI

public java.lang.StringBuffer appendOperationURI(Operation operation,
                                                 java.lang.StringBuffer sb,
                                                 HttpServletRequest req)
                                          throws CMException

Appends a complete URI that can be used to directly access the operation

Throws:

CMException

getBaseURL

public java.lang.String getBaseURL()

Gets the base URL

getContext

public IOperationContext getContext(Operation operation,
                                    java.lang.String contextKey,
                                    HttpServletRequest request)
                             throws CMException

Gets the SQLOperation's ApplicationSQLContext.

Throws:

CMException

prepareOperation

public java.lang.Object prepareOperation(Operation operation,
                                         DataEngineServlet servlet,
                                         boolean replaceContext,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws CMException

Deprecated. - use same method with row parameter added.

Prepares the given Operation to be viewed. (executes to operation, sets any properties of the operation on the results, puts the results and/or the operation's context in the session)

Throws:

CMException

prepareOperation

public java.lang.Object prepareOperation(Operation operation,
                                         Row associatedRow,
                                         DataEngineServlet servlet,
                                         boolean replaceContext,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws CMException

Deprecated. This method now takes in an ExecutingContext object

Prepares the given Operation to be viewed. (executes to operation, sets any properties of the operation on the results, puts the results and/or the operation's context in the session)

Throws:

CMException

prepareOperation

public java.lang.Object prepareOperation(Operation operation,
                                         Row associatedRow,
                                         DataEngineServlet servlet,
                                         boolean replaceContext,
                                         ExecutingContext ec,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws CMException

Prepares the given Operation to be viewed. (executes to operation, sets any properties of the operation on the results, puts the results and/or the operation's context in the session)

Throws:

CMException

prepareOperation

public java.lang.Object prepareOperation(Operation operation,
                                         boolean replaceContext,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws CMException

Deprecated. - use same method with row parameter added.

Prepares the given Operation to be viewed. (executes to operation, sets any properties of the operation on the results, puts the results and/or the operation's context in the session)

Throws:

CMException

prepareOperation

public java.lang.Object prepareOperation(Operation operation,
                                         Row associatedRow,
                                         boolean replaceContext,
                                         HttpServletRequest request,
                                         HttpServletResponse response)
                                  throws CMException

Prepares the given Operation to be viewed. (executes to operation, sets any properties of the operation on the results, puts the results and/or the operation's context in the session)

Throws:

CMException

setBaseURL

public void setBaseURL(java.lang.String newBaseURL)

Sets the base URL. This is an internal DataEngine method and should not be invoked by applications

setSingleton

public static void setSingleton(HttpOperationManager singleton)

Sets the singleton instance of the HttpOperationManager. This only needs to be done if the HttpOperationManager class has been overridden. The singleton instance is not synchronized, so this method should only be invoked during initialization.

singleton

public static HttpOperationManager singleton()

Gets the singleton instance of HttpOperationManager