Index (Arbortext Publishing Engine)

A C D E F G H I L M N P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addDateHeader(String, long) - Method in interface com.arbortext.e3.E3RequestResponse: Adds a response header with the given name and date value.
addDeferredRequestTask(E3Task) - Method in interface com.arbortext.e3.E3RequestContext: Adds a job to the list of jobs to be performed after the current request finishes processing but before the response is returned to the user.
addHeader(String, String) - Method in interface com.arbortext.e3.E3InternalRequest: Adds an HTTP header to the request
addHeader(String, String) - Method in interface com.arbortext.e3.E3RequestResponse: Adds a response header with the given name and value.
addIntermediateFile(String, String, String) - Method in interface com.arbortext.e3.E3ApplicationConfig: Add intermediate file full path, content type and description into intermediate log file
addIntHeader(String, int) - Method in interface com.arbortext.e3.E3RequestResponse: Adds a response header with the given name and an integer value.
addMessage(String) - Method in exception class com.arbortext.e3.E3RequestException: Adds a message to our message store
addQueryParameter(String, String) - Method in interface com.arbortext.e3.E3InternalRequest: Adds a query parameter to the request
addStateListener(E3TransactionStateListener) - Method in interface com.arbortext.e3.E3Transaction: Add request state listener.
allocate() - Method in interface com.arbortext.e3.E3SubprocessPool: Obtains a subprocess from the request pool.
allocateE3Subprocess(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestContext: Allocates an E3 subprocess, possibly blocking until one is available.
allocateImmediate() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns a subprocess from the request pool without waiting.

C

cache(HttpServletRequest, E3RequestResponse) - Method in interface com.arbortext.e3.E3CacheManager: Places a request/response pair in the cache for retrieval later
CACHEABLE - Static variable in interface com.arbortext.e3.E3CacheEntry: Indicates that the response corresponding to a request is not in the cache, but that the response should be placed there for use later.
Cancelled - Enum constant in enum class com.arbortext.e3.RequestState
cancelOperation() - Method in interface com.arbortext.e3.E3Subprocess: Cancel the current operation and free this subprocess.
changeState(E3Transaction, RequestState, RequestState) - Method in interface com.arbortext.e3.E3TransactionStateListener: It handles the change of transaction state.
com.arbortext.e3 - package com.arbortext.e3
Complete - Enum constant in enum class com.arbortext.e3.RequestState
contains(E3Transaction) - Method in interface com.arbortext.e3.E3Queue: Indicates whether a transaction is on this queue.
containsHeader(String) - Method in interface com.arbortext.e3.E3RequestResponse: Returns a boolean indicating whether the named response header has already been set.
CONTINUE - Static variable in interface com.arbortext.e3.E3RequestHandler
createRequest() - Method in interface com.arbortext.e3.E3RequestContext: Creates an HTTP GET request for internal use
createRequest(File) - Method in interface com.arbortext.e3.E3RequestContext: Creates an HTTP POST request for internal use
createResponse() - Method in interface com.arbortext.e3.E3RequestContext: Creates an empty E3RequestResponse object
createResponse(E3RequestResponse) - Method in interface com.arbortext.e3.E3RequestContext: Creates an E3RequestResponse object with the same content as another response.
createSubtree(Document, Element) - Method in interface com.arbortext.e3.E3Request: Creates an XML document subtree describing this request.
createSubtree(Document, Element) - Method in interface com.arbortext.e3.E3Response: Constructs a DOM document or subdocument describing this response.
createTemporaryFile(boolean) - Method in interface com.arbortext.e3.E3RequestContext: Creates a temporary file; the file will be accessible to code running in both the E3 servlet and an E3 Subprocess

D

deallocate() - Method in interface com.arbortext.e3.E3Subprocess: Frees this subprocess and returns it to the pool of usable services.
deallocate(E3Subprocess) - Method in interface com.arbortext.e3.E3SubprocessPool: Returns a subprocess to the pool for use by another request.
deleteFile(File) - Method in interface com.arbortext.e3.E3RequestContext: Schedules a file for deletion.
deleteRecursive(File) - Method in interface com.arbortext.e3.E3RequestContext: Deletes a file or directory and its content
dequeue(E3Transaction) - Method in interface com.arbortext.e3.E3Queue: Deletes a trsnaction from the queue.
destroy() - Method in interface com.arbortext.e3.E3Application: Called by E3 after the last call to this E3Application has been made.
destroy() - Method in interface com.arbortext.e3.E3DynamicComponent: Called when the E3 servlet is shutting down
doGet(E3ApplicationRequest, E3ApplicationResponse) - Method in interface com.arbortext.e3.E3Application: Called by E3 to handle an HTTP GET request.
doPost(E3ApplicationRequest, E3ApplicationResponse) - Method in interface com.arbortext.e3.E3Application: Called by E3 to handle an HTTP POST or SOAP request.

E

E3Application - Interface in com.arbortext.e3: Provides an interface that users can implement to create an object that runs in each E3 sub-process and is called by E3 to process HTTP requests.
E3ApplicationConfig - Interface in com.arbortext.e3: An object used by an E3 sub-process to pass information to an E3 Application during initialization.
E3ApplicationRequest - Interface in com.arbortext.e3: Provides request information for E3 Applications.
E3ApplicationResponse - Interface in com.arbortext.e3: Defines an object that assists an E3 Application in sending a response to the HTTP or SOAP client.
E3CacheEntry - Interface in com.arbortext.e3: Describes an entry in a cache.
E3CacheManager - Interface in com.arbortext.e3: Describes a cache manager object.
E3DynamicComponent - Interface in com.arbortext.e3: Interface that must be supported by every object that E3 loads dynamically (cache managers, queue managers, etc.)
E3Initializer - Interface in com.arbortext.e3: Describes user-supplied code that runs after the service pools have been initialized but before the first request is received.
E3InternalRequest - Interface in com.arbortext.e3: Describes an internal E3 request, one created by Java code inside the E3 servlet rather than transmitted by a client.
E3Notifier - Interface in com.arbortext.e3: This interface describes an object that takes some action when a transaction changes state.
E3Queue - Interface in com.arbortext.e3: Describes an ordered container of transactions that will be processed in the future.
E3QueueManager - Interface in com.arbortext.e3: Describes a queue manager object.
E3Request - Interface in com.arbortext.e3: Represents a request for use by the PE Request Manager.
E3RequestContext - Interface in com.arbortext.e3: Provides information and services to E3 Request Handlers and E3 Request Functions.
E3RequestError - Exception Class in com.arbortext.e3: Represents a programming error or server misconfiguration.
E3RequestError() - Constructor for exception class com.arbortext.e3.E3RequestError: Initializes with no message or root cause.
E3RequestError(String, boolean) - Constructor for exception class com.arbortext.e3.E3RequestError: Initializes from an error message
E3RequestError(String, boolean, Throwable) - Constructor for exception class com.arbortext.e3.E3RequestError: Initializes from an error message with a root cause exception
E3RequestError(String, Throwable, boolean) - Constructor for exception class com.arbortext.e3.E3RequestError: Initializes from an error message and from another exception that caused this one.
E3RequestEvaluator - Interface in com.arbortext.e3: Object capable of applying a logical expression consisting of AND, OR, and E3 Request Selectors to a request and determining whether or not the request meets the specified criteria.
E3RequestException - Exception Class in com.arbortext.e3: Describes a failure of some kind in the E3 Request Manager.
E3RequestException(String, Throwable, boolean) - Constructor for exception class com.arbortext.e3.E3RequestException: Initializes a new instance.
E3RequestFailure - Exception Class in com.arbortext.e3: Represents a failure in processing an E3 Request that results from bad data on the request or another user-correctible error.
E3RequestFailure() - Constructor for exception class com.arbortext.e3.E3RequestFailure: Initializes with no message or root cause.
E3RequestFailure(String, boolean) - Constructor for exception class com.arbortext.e3.E3RequestFailure: Initializes from an error message
E3RequestFailure(String, Throwable, boolean) - Constructor for exception class com.arbortext.e3.E3RequestFailure: Initializes from an error message and from another exception that caused this one.
E3RequestFunction - Interface in com.arbortext.e3: Describes a function that can be run by the E3 Request Manager.
E3RequestHandler - Interface in com.arbortext.e3: Describes an E3 Request Handler, which handles HTTP requests for the E3 servlet.
E3RequestResponse - Interface in com.arbortext.e3: Describes the response that will be sent to the HTTP or SOAP client.
E3RequestSelector - Interface in com.arbortext.e3: Describes a test that can be applied to an HTTP request.
E3Response - Interface in com.arbortext.e3: Represents the non-body part of an HTTP response for use by the PE Request Manager.
E3Subprocess - Interface in com.arbortext.e3: Describes an E3 Subprocess.
E3SubprocessPool - Interface in com.arbortext.e3: Describes an object that maintains a set of E3 Subprocess objects and doles them out as needed, possibly making the requestor wait until a service is available.
E3Task - Interface in com.arbortext.e3: Interface to a unit of work to be performed at some later time.
E3Transaction - Interface in com.arbortext.e3: Represents a transaction interface in request manager
E3TransactionArchive - Interface in com.arbortext.e3: Describes an archive of completed transactions.
E3TransactionStateListener - Interface in com.arbortext.e3: RMTransaction object state change listener interface.
E3Version - Interface in com.arbortext.e3: Returns information describing the E3 version and characteristics
enqueue(E3Transaction, boolean) - Method in interface com.arbortext.e3.E3Queue: Adds a transaction to this queue.
evaluate(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestEvaluator: Indicates whether a request meets the criteria embedded in this object.
evaluateFunction(String) - Method in interface com.arbortext.e3.E3Subprocess: Passes an ACL function to the E3 subprocess for evaluation.
evaluateFunction(String, E3Transaction) - Method in interface com.arbortext.e3.E3Subprocess: Passes an ACL function to the E3 subprocess for evaluation.
execute() - Method in interface com.arbortext.e3.E3Task
execute(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestFunction: Serves an HTTP request by doing something.
executeCommand(String) - Method in interface com.arbortext.e3.E3Subprocess: Passes an ACL command to the E3 subprocess for execution.
executeCommand(String, E3Transaction) - Method in interface com.arbortext.e3.E3Subprocess: Passes an ACL command to the E3 subprocess for execution.

F

findQueue(String) - Method in interface com.arbortext.e3.E3RequestContext: Finds a queue object.
findTransaction(E3SubprocessPool) - Method in interface com.arbortext.e3.E3Queue: Finds the first transaction on the queue that is eligible for execution.

G

getAllowedFunctions() - Method in interface com.arbortext.e3.E3RequestContext: Returns an iterator over the list of allowed functions
getAlternateArchiveFlag() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the alternate archive flag.
getApplicationConfig() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the E3ApplicationConfig object associated with this application.
getApplicationLogger() - Method in interface com.arbortext.e3.E3ApplicationConfig: Returns the names of the application's Logger.
getArchiveFlag() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the archive flag.
getAuthType() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the name of the authentication scheme used to protect the servlet, for example, "BASIC" or "SSL" or null if the servlet was not protected.
getBinaryPath() - Method in interface com.arbortext.e3.E3Version: Returns the top-level path in which the E3 subprocess is installed.
getBuildName() - Method in interface com.arbortext.e3.E3Version: Returns the name of the build for this version of E3 (e.g., "Build CHE-70")
getCacheManagers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of cache managers
getCharacterEncoding() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returnsthe name of the character encoding used in the body of this request or null if the request does not specify a character encoding.
getCharacterEncoding() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the name of the charset used for the MIME body to be sent in this response.
getCode() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the HTTP response code that will be transmitted to the client.
getCompletedTransactionCount() - Method in interface com.arbortext.e3.E3Queue: Returns the number of transactions that were placed on this queue when they were submitted and that have now completed execution or been cancelled.
getContentLength() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the length, in bytes, of the request body or -1 if the length is not known.
getContentType() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the MIME type of the body of the request, or null if the type is not known.
getContextPath() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the portion of the request URI that indicates the context of the request.
getDataFields() - Method in interface com.arbortext.e3.E3RequestContext
getDateHeader(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the value of the specified request header as a long value that represents a Date object.
getDefaultTransactionName() - Method in interface com.arbortext.e3.E3RequestContext: Returns the name to be assigned to any transaction whose request doesn't specify a transaction-name parameter.
getEnabled() - Method in interface com.arbortext.e3.E3Queue: Indicates whether this queue is enabled.
getEnabled() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns our 'enabled' flag
getEndTime() - Method in interface com.arbortext.e3.E3Transaction: Returns the time at which this transaction finished processing.
getEpicInstallation() - Method in interface com.arbortext.e3.E3RequestContext: Returns the location in which Epic is installed
getErrorMessage() - Method in interface com.arbortext.e3.E3Response: Returns the error message string.
getExecutingTransactionCount() - Method in interface com.arbortext.e3.E3Queue: Returns the number of transactions from this queue that are currently executing.
getHeader(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the value of the specified request header as a String.
getHeaderNames() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns an Enumeration of all the header names the request contains.
getHeaderNames() - Method in interface com.arbortext.e3.E3RequestResponse: Returns an enumeration containing the names of the headers that will be transmitted to the client.
getHeaders(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns all the values of the specified request header as an Enumeration of string objects.
getHeaderValues(String) - Method in interface com.arbortext.e3.E3RequestResponse: Returns an enumeration containing the values for a specified HTTP header.
getHold() - Method in interface com.arbortext.e3.E3Transaction: Returns this transaction's hold flag.
getHttpRequest() - Method in interface com.arbortext.e3.E3Transaction: Returns the HTTP request that started the transaction process.
getId() - Method in interface com.arbortext.e3.E3DynamicComponent: Returns the name of this component
getId() - Method in interface com.arbortext.e3.E3RequestSelector: Returns our ID
getId() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns unique ID
getId() - Method in interface com.arbortext.e3.E3Transaction: Returns this transaction's unique ID.
getInitializers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of initializers
getInitParameter(String) - Method in interface com.arbortext.e3.E3ApplicationConfig: Returns the value associated with a parameter, or null if the parameter does not exist.
getInitParameterNames() - Method in interface com.arbortext.e3.E3ApplicationConfig: Returns the names of the application's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the application has no initialization parameters.
getInputFile() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns a File object indicating a disk file containing the message body of the HTTP POST or SOAP request.
getIntHeader(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the value of the specified header as an int.
getLocale() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
getLocale() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the locale assigned to the response.
getLocales() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns an Enumeration of Locale objects indicating in decreasing order starting with the preferred Locale the locales that are acceptable to the client based on the Accept-Language header.
getMaxBusyInterval() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns our maximum busy interval parameter.
getMaxSubprocessWait() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns our maximum subprocess wait parameter.
getMessages() - Method in exception class com.arbortext.e3.E3RequestException: Returns our list of messages
getMethod() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the name of the HTTP method for this request, either "GET" or "POST".
getName() - Method in interface com.arbortext.e3.E3Transaction: Returns this transaction's name.
getNotifiers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of notifications
getOutputFile() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the file that's currently slated for transmission to the HTTP or SOAP client or null if the E3Application hasn't called setOutputFile.
getParameter(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the value of a request parameter as a String, or null if the parameter does not exist.
getParameter(String) - Method in interface com.arbortext.e3.E3RequestContext: Returns the value of a parameter
getParameter(String) - Method in interface com.arbortext.e3.E3SubprocessPool: Returns a subprocess-pool-specific parameter value
getParameterNames() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns an Enumeration of String objects containing the names of the parameters contained in the request.
getParameterNames() - Method in interface com.arbortext.e3.E3RequestContext: Returns an iterator over the list of global parameter names
getParameters() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns all subprocess-pool-specific parameter names
getParameterSets() - Method in interface com.arbortext.e3.E3RequestContext: Returns a list of standalone parameter sets.
getParameterValues(String) - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
getPathInfo() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns any extra path information associated with the URL the client sent when it made the request.
getPathTranslated() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the extra path information after the servlet name but before the query string, trnaslated to a real path.
getPid() - Method in interface com.arbortext.e3.E3Subprocess: Returns the process ID of the PE subprocess corresponding to this subprocess object.
getPriority() - Method in interface com.arbortext.e3.E3Transaction: Returns priority of this transaction on its queue.
getProcessingDuration() - Method in interface com.arbortext.e3.E3Transaction: Returns the elapsed time in milliseconds that this transaction took to execute.
getProtocol() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the name and version of the protocol the request uses in the form "protocol/major version.minor version", for example "HTTP/1.1".
getQueryString() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the query string that is contained in the request URL after the path, or null if the URL does not have a query string.
getQueueId() - Method in interface com.arbortext.e3.E3Transaction: Returns the ID of the queue on which this transaction is waiting, or either a null pointer or empty string if the transaction is not waiting on a queue.
getQueueManagers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of queue managers
getQueues() - Method in interface com.arbortext.e3.E3RequestContext: Return the list of the queues available in the manager.
getRealContextPath() - Method in interface com.arbortext.e3.E3Version: Returns the absolute path to the servlet context.
getRecycleSubprocessFlag() - Method in interface com.arbortext.e3.E3RequestResponse: Returns the recycle-subprocess flag.
getRedirectTarget() - Method in interface com.arbortext.e3.E3Response: Returns the redirect target string.
getRedirectTransactionId() - Method in interface com.arbortext.e3.E3Response: Returns the redirect body file string.
getRemoteAddr() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the Internet Protocol (IP) address of the client that sent the address.
getRemoteHost() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the fully-qualified name of the client that sent the request, or the IP address of the client if the name cannot be determined.
getRemoteUser() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the login of the user making the request, if the user has been authenticated.
getRequestData() - Method in interface com.arbortext.e3.E3Transaction: Returns the request information (except the body) received from our HTTP call.
getRequestHandlers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of request handlers
getRequestParameter(String) - Method in interface com.arbortext.e3.E3Transaction: Returns the value of an HTTP query parameter.
getRequestSelector(String) - Method in interface com.arbortext.e3.E3RequestContext: Returns a request selector
getRequestSelectors() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of request selectors
getRequestState() - Method in interface com.arbortext.e3.E3Transaction: Returns the state of the transaction: queued, executing, complete, etc.
getRequestURI() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the part of this request's URL from the protocol name up to the query string.
getResponse() - Method in interface com.arbortext.e3.E3CacheEntry: Returns the response object that should be transmitted to the client.
getResponseData() - Method in interface com.arbortext.e3.E3Transaction: Returns the response data (except the body) that will be/has been transmitted to the HTTP client.
getScheme() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the name of the scheme used to make this request, for example "http", "https", or "ftp".
getSecurityConstraints() - Method in interface com.arbortext.e3.E3RequestContext: Returns an iterator over the list of security constraints.
getServerName() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the host name of the server that received the request.
getServerPort() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the port number on which this request was received.
getServletConfig() - Method in interface com.arbortext.e3.E3RequestContext: Returns the servlet configuration object.
getServletContext() - Method in interface com.arbortext.e3.E3RequestContext: Returns the servlet context object.
getServletPath() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns the part of this request's URL that resulted in the E3 servlet being invoked.
getSiteLicenseOwner() - Method in interface com.arbortext.e3.E3Version: Returns the site license owner.
getStackTrace(Throwable) - Method in interface com.arbortext.e3.E3RequestContext: Returns an exception stack trace as a string.
getStartDate() - Method in interface com.arbortext.e3.E3Version: Returns the date/time at which E3 was started
getStartDateFormatted() - Method in interface com.arbortext.e3.E3Version: Returns the date/time at which E3 was started, expressed as a formatted string (such as "08:06:59 on 09/16/2003")
getStartTime() - Method in interface com.arbortext.e3.E3Transaction: Returns the time at which this transaction started processing.
getState() - Method in interface com.arbortext.e3.E3RequestResponse: Returns a code indicating what will be returned to the client that made the HTTP or SOAP request to E3 based upon the current content of the E3ApplicationRequest object.
getStatus() - Method in interface com.arbortext.e3.E3CacheEntry: Indicates whether this entry is not cacheable, or cacheable but not currently in the cache, or in the cache
getStatus(PrintWriter) - Method in interface com.arbortext.e3.E3DynamicComponent: Writes XHTML status information for inclusion in the status page.
getStatus(PrintWriter) - Method in interface com.arbortext.e3.E3SubprocessPool: Formats information about our internal status for inclusing in the E3 status web page.
getString() - Method in interface com.arbortext.e3.E3RequestResponse: Returns our string buffer.
getSubmitTime() - Method in interface com.arbortext.e3.E3Transaction: Returns the time at which this transaction was submitted.
getSubPriority() - Method in interface com.arbortext.e3.E3Transaction: Returns sub-priority of this transaction.
getSubprocessBuildDate() - Method in interface com.arbortext.e3.E3Version: Returns the build date of the E3 subprocess (e.g., "Fall 2003")
getSubprocessBuildName() - Method in interface com.arbortext.e3.E3Version: Returns the name of the build of the E3 subprocess (e.g., "Build CHE-70")
getSubprocessEnvironment() - Method in interface com.arbortext.e3.E3SubprocessPool: Deprecated.
No longer supported.
getSubprocessPool() - Method in interface com.arbortext.e3.E3Subprocess: Returns the subprocess pool containing this subprocess.
getSubprocessPools() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of subprocess pools
getSubprocessVersionName() - Method in interface com.arbortext.e3.E3Version: Returns name of the E3 subprocessversion (e.g., "Version 5.0")
getTemporaryDirectory() - Method in interface com.arbortext.e3.E3RequestContext: Returns the directory in which temporary files should be created
getTemporaryPrefix() - Method in interface com.arbortext.e3.E3RequestContext: Returns the string that will be used as a prefix in creating all temporary files.
getTemporarySuffix() - Method in interface com.arbortext.e3.E3RequestContext: Returns the string that will be used as a suffix in creating all temporary files.
getTestSets() - Method in interface com.arbortext.e3.E3RequestContext: Returns a list of standalone test sets.
getTraceInteresting() - Method in exception class com.arbortext.e3.E3RequestException: Indicates whether the traceback is likely to be of interest.
getTransaction() - Method in interface com.arbortext.e3.E3Request: Get the transaction object.
getTransactionArchive() - Method in interface com.arbortext.e3.E3RequestContext: Returns a reference to the transaction archive.
getTransactionDir() - Method in interface com.arbortext.e3.E3ApplicationConfig: Returns current transaction directory.
getTransactionId() - Method in interface com.arbortext.e3.E3ApplicationConfig: Returns the current transaction ID.
getTransactionIndex(E3Transaction) - Method in interface com.arbortext.e3.E3Queue: Returns the number of transactions ahead of a specified transaction on the queue.
getTransmissionTime() - Method in interface com.arbortext.e3.E3Transaction: Returns the time at which this transaction's response was transmitted to its client.
getVersion() - Method in interface com.arbortext.e3.E3RequestContext: Returns a version descriptor
getVersionDate() - Method in interface com.arbortext.e3.E3Version: Returns the E3 version date (e.g., "Fall 2003")
getVersionName() - Method in interface com.arbortext.e3.E3Version: Returns name of the E3 version running (e.g., "Version 5.0")
getWaitingTransactionCount() - Method in interface com.arbortext.e3.E3Queue: Returns the number of transactions on this queue that are awaiting execution.

H

hasFileResult() - Method in interface com.arbortext.e3.E3RequestResponse: Determines if this response is setup to return a file.
hasStringResult() - Method in interface com.arbortext.e3.E3RequestResponse: Determines if this response is setup to return a string.

I

IN_CACHE - Static variable in interface com.arbortext.e3.E3CacheEntry: Indicates that the response corresponding to a request is in the cache and can be returned to the user immediately.
indexValue() - Method in enum class com.arbortext.e3.RequestState
init(E3ApplicationConfig) - Method in interface com.arbortext.e3.E3Application: Called by E3 before the first call to doGet or doPost.
init(E3RequestContext, E3CacheManagerDescriptor) - Method in interface com.arbortext.e3.E3CacheManager: Called to initialize everything
init(E3RequestContext, E3InitializerDescriptor) - Method in interface com.arbortext.e3.E3Initializer: Called by E3 servlet initialization after everything else has been initialized, but before any requests are received.
init(E3RequestContext, E3NotifierDescriptor) - Method in interface com.arbortext.e3.E3Notifier: Initialize a new notification object.
init(E3RequestContext, E3QueueDescriptor) - Method in interface com.arbortext.e3.E3Queue: Called during PE Request Manager startup to initialize.
init(E3RequestContext, E3QueueManagerDescriptor) - Method in interface com.arbortext.e3.E3QueueManager: Called by E3 servlet initialization after everything else has been initialized, but before any requests are received.
init(E3RequestContext, E3RequestHandlerDescriptor) - Method in interface com.arbortext.e3.E3RequestFunction: Called at start-up to allocate resources and initialize.
init(E3RequestContext, E3RequestHandlerDescriptor) - Method in interface com.arbortext.e3.E3RequestHandler: Called at start-up to allocate resources and initialize.
init(E3RequestContext, E3RequestSelectorDescriptor) - Method in interface com.arbortext.e3.E3RequestSelector: Called from E3 servlet initialization
init(E3RequestContext, E3SubprocessPoolDescriptor) - Method in interface com.arbortext.e3.E3SubprocessPool: Called during E3 servlet initialization
Initial - Enum constant in enum class com.arbortext.e3.RequestState
isActive() - Method in interface com.arbortext.e3.E3Queue: Indicates whether this queue is active.
isComplete() - Method in enum class com.arbortext.e3.RequestState: Check the statte belongs to the finish state group: Cancelled, Failed, Succeeded, InternalError
isEmpty() - Method in interface com.arbortext.e3.E3Queue: Indicates whether this queue contains any transactions.
isFunctionAllowed(String, String) - Method in interface com.arbortext.e3.E3RequestContext: Indictates whether a given function should be passed to an E3 subprocess for execution.
isLocked() - Method in interface com.arbortext.e3.E3CacheEntry: Indicates whether the response is locked.
isSecure() - Method in interface com.arbortext.e3.E3ApplicationRequest: Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
iterator() - Method in interface com.arbortext.e3.E3Queue: Returns an iterator over all transactions awaiting execution on this queue.

L

logDebugMessage(String) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log only if debugging is enabled.
logDebugMessage(String, Throwable) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log only if debugging is enabled.
logMessage(String) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log.
logMessage(String, Throwable) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log.
logVerboseDebugMessage(String) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log only if verbose debugging is enabled.
logVerboseDebugMessage(String, Throwable) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the servlet context log only if verbose debugging is enabled.

M

move(E3Transaction, boolean, int) - Method in interface com.arbortext.e3.E3Queue: Moves a transaction to a new location on the queue.

N

NOT_CACHEABLE - Static variable in interface com.arbortext.e3.E3CacheEntry: Indicates that the response corresponding to a request is not in the cache and that the response should not be placed in the cache after E3 computes it.

P

patternMatch(String, String) - Method in interface com.arbortext.e3.E3RequestContext: Indicates whether a string matches a pattern
Processing - Enum constant in enum class com.arbortext.e3.RequestState

Q

Queued - Enum constant in enum class com.arbortext.e3.RequestState
queueFileDeletion(File) - Method in interface com.arbortext.e3.E3SubprocessPool: Queues a file or directory for deletion.

R

receiveFile(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestContext: Allocates a temporary file and stores the file accompanying an HTTP POST request into it
reinitialize() - Method in interface com.arbortext.e3.E3SubprocessPool: Instructs every allocated E3 subprocess to re-source its E3 applications.
removeStateListener(E3TransactionStateListener) - Method in interface com.arbortext.e3.E3Transaction: remove request state listener
RequestState - Enum Class in com.arbortext.e3: request state enumeration
reset() - Method in interface com.arbortext.e3.E3RequestResponse: Clears any data in the response.
restoreZipArchive(File, File) - Method in interface com.arbortext.e3.E3RequestContext: Deprecated, for removal: This API element is subject to removal in a future version.

S

saveXmlFile(File) - Method in interface com.arbortext.e3.E3Request: Stores this request to disk in an XML file.
saveXmlFile(File) - Method in interface com.arbortext.e3.E3Response: Writes this object to disk as an XML document.
search(HttpServletRequest, boolean) - Method in interface com.arbortext.e3.E3CacheManager: Searches the cache for a response matching the request.
sendError(int) - Method in interface com.arbortext.e3.E3RequestResponse: Resets the response, then stores the status code for transmission to the client.
sendError(int, String) - Method in interface com.arbortext.e3.E3RequestResponse: Resets the response, then stores the status code and descriptive error message for transmission to th client.
sendRedirect(String) - Method in interface com.arbortext.e3.E3RequestResponse: Resets the response, then sets the status code and response headers to send a temporary redirect response to the client using the specified redirect location URL.
service(HttpServletRequest) - Method in interface com.arbortext.e3.E3QueueManager: Examines a request and, possibly, saves the request for execution later.
service(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestHandler: Called to handle an HTTP reqeust from a client.
setAlternateArchiveFlag(boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the alternate archive flag.
setAppConfig(E3ApplicationConfig) - Method in interface com.arbortext.e3.E3Transaction: Associates an Application Configuration object with this transaction.
setArchiveFlag(boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the archive flag.
setContentLength(int) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the HTTP Content-Length header.
setContentType(String) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the content type of the response being sent to the client.
setDateHeader(String, long) - Method in interface com.arbortext.e3.E3RequestResponse: Sets a response header with the given name and date value.
setEnabled(boolean) - Method in interface com.arbortext.e3.E3Queue: Sets this queue's 'enabled' flag
setHeader(String, String) - Method in interface com.arbortext.e3.E3RequestResponse: Sets a response header with the given name and value.
setHold(boolean) - Method in interface com.arbortext.e3.E3Transaction: Sets the hold flag to allow or prevent this transaction from executing.
setIndirectResponseData(E3Response) - Method in interface com.arbortext.e3.E3Transaction: Associates a queued response with this transaction.
setIntHeader(String, int) - Method in interface com.arbortext.e3.E3RequestResponse: Sets a response header with the given name and integer value.
setLocale(Locale) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
setOutputFile(File, boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets up to return the content of a file.
setOutputPage(String) - Method in interface com.arbortext.e3.E3RequestResponse: Sets up to return an HTML page.
setOutputPath(String, boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets up to return the content of a file.
setPriority(int) - Method in interface com.arbortext.e3.E3Transaction: Set this transaction's priority on its queue.
setQueueId(String) - Method in interface com.arbortext.e3.E3Transaction: Set the ID of the queue that this transaction is waiting on.
setRecycleSubprocessFlag(boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets our 'recycle-subprocess' flag.
setRedirectTransactionId(long) - Method in interface com.arbortext.e3.E3Response: Store redirect transaction id.
setRequestState(RequestState) - Method in interface com.arbortext.e3.E3Transaction: Sets the transaction state to a new value.
setResponseData(E3Response) - Method in interface com.arbortext.e3.E3Transaction: Associates a response with this transaction.
setResponseException(Throwable, int) - Method in interface com.arbortext.e3.E3Transaction: Associates exception with this transaction.
setStatus(int) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the status code for this response.
setSubPriority(int) - Method in interface com.arbortext.e3.E3Transaction: Set this transaction's subpriority value.
setSubprocess(E3Subprocess) - Method in interface com.arbortext.e3.E3Transaction: Associates a subprocess with this transaction.
setTransactionPriority(E3Transaction, int) - Method in interface com.arbortext.e3.E3Queue: Sets a transaction's priority and moves the transaction to the appropriate position on the queue.
shouldRecycleSubprocess(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestContext: Indicates whether the sub-process that processes a request should be terminated after doing so.
sort() - Method in interface com.arbortext.e3.E3Queue: Sorts the transaction list into order based upon transaction priority and sub-priority.
STATE_FILE - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating that we'll return the status code, HTTP headers, and the output file specified via setOutputFile.
STATE_FILE_DELETE - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating that we'll return the status code, HTTP headers, and the output file specified via setOutputFile.
STATE_MAXIMUM - Static variable in interface com.arbortext.e3.E3RequestResponse: Maximum legal state code
STATE_MINIMUM - Static variable in interface com.arbortext.e3.E3RequestResponse: Minimum legal state code
STATE_PAGE - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating that we'll return the status code, HTTP headers, and the HTML page set using setOutputPage.
STATE_REDIRECT - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating that we'll send a temporary redirect to the client.
STATE_SC - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating we'll return a fabricated HTML page based upon the status code.
STATE_SC_MSG - Static variable in interface com.arbortext.e3.E3RequestResponse: State code indicating that we'll return a fabricated HTML page based upon the status code and error message.
STOP - Static variable in interface com.arbortext.e3.E3RequestHandler

T

test(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestSelector: Indicates whether or not 'request' meets some condition
testRequest(HttpServletRequest) - Method in interface com.arbortext.e3.E3SubprocessPool: Tests a request to see if it matches this pool's defined list of tests.
toRequestState(int) - Static method in enum class com.arbortext.e3.RequestState
toRequestState(String) - Static method in enum class com.arbortext.e3.RequestState
trace(String) - Method in interface com.arbortext.e3.E3RequestContext: Writes a string to the platform-specific trace mechanism
transmitResponse(HttpServletResponse, E3RequestResponse) - Method in interface com.arbortext.e3.E3RequestContext: Transmits a response to an HTTP client.

U

UNKNOWN_PROCESS_ID - Static variable in interface com.arbortext.e3.E3Subprocess
unlock() - Method in interface com.arbortext.e3.E3CacheEntry: Unlocks the entry.

V

valueOf(String) - Static method in enum class com.arbortext.e3.RequestState: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arbortext.e3.RequestState: Returns an array containing the constants of this enum class, in the order they are declared.

W

Waiting - Enum constant in enum class com.arbortext.e3.RequestState

A C D E F G H I L M N P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form