Index (Arbortext Publishing Engine Composition)

A C D E F G H I L N P Q R S T U
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.
addOption(String, String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Adds a new set option to our list
addParameter(E3ServerCompositionParameter) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Adds a new parameter to our list
addQueryParameter(String, String) - Method in interface com.arbortext.e3.E3InternalRequest: Adds a query parameter to the request
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.
cancelOperation() - Method in interface com.arbortext.e3.E3Subprocess: Cancel the current operation and free this subprocess.
ClientComposer - Class in com.arbortext.e3c: Java object that manages E3 composition for Epic Editor.
close() - Static method in class com.arbortext.e3c.ClientComposer: Called exit_editor_hook in initrtns.cpp to terminate our storage.
com.arbortext.e3 - package com.arbortext.e3
com.arbortext.e3c - package com.arbortext.e3c
compose(Map<String, String>, Map<String, String>) - Method in class com.arbortext.e3c.ClientComposer: Entry point for both synchronous and asynchronous composition.
containsHeader(String) - Method in interface com.arbortext.e3.E3RequestResponse: Returns a boolean indicating whether the named response header has already been set.
containsParameter(String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Indicates whether we contain the specified parameter
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.
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
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
destroy() - Method in interface com.arbortext.e3c.E3ServerComposer: Called after the last call to doCompose
doCompose(E3ServerCompositionRequest, E3ServerCompositionResult, File, File, Map, PropertyMap, Logger) - Method in interface com.arbortext.e3c.E3ServerCompositionExtension: Called to handle a single composition operation.
doCompose(File, File, long, Logger) - Method in interface com.arbortext.e3c.E3ServerComposer: Translates an input Java Archive file (JAR) to an output JAR file.
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.
E3ClientCompositionExtension - Interface in com.arbortext.e3c: Interface that provides composition operation type-specific pre- and post-processing support.
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.
E3QueueManager - Interface in com.arbortext.e3: Describes a queue manager object.
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.
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.
E3ServerComposer - Interface in com.arbortext.e3c: Interface that handles composition operations on an E3 server.
E3ServerCompositionExtension - Interface in com.arbortext.e3c: Interface for extensions to the Arbortext E3 Server Composition Application.
E3ServerCompositionParameter - Interface in com.arbortext.e3c
E3ServerCompositionRequest - Interface in com.arbortext.e3c: Describes the request for a composition operation to be performed by the E3 server composition application.
E3ServerCompositionResult - Interface in com.arbortext.e3c: Describes the result of a composition operation under the E3 server composisition application.
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.
E3Tracer - Interface in com.arbortext.e3c: Interface to an object which makes entries in the trace files.
E3Version - Interface in com.arbortext.e3: Returns information describing the E3 version and characteristics
error(String) - Method in interface com.arbortext.e3c.E3Tracer: Makes an error trace entry
error(String, String) - Method in interface com.arbortext.e3c.E3Tracer: Makes an error trace entry
error(String, Throwable) - Method in interface com.arbortext.e3c.E3Tracer: Makes an error trace entry
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
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.

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.
getComposerPath() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Returns the absolute path to the composer (.ccf file) that should be used to control this operation.
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.
getDoc() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: document entry name accessor
getEnabled() - Method in interface com.arbortext.e3.E3SubprocessPool: Returns our 'enabled' flag
getEpicInstallation() - Method in interface com.arbortext.e3.E3RequestContext: Returns the location in which Epic is installed
getErrorFileEntry() - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Accessor for the error file entry.
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.
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
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.
getInstance() - Static method in class com.arbortext.e3c.ClientComposer: Get singleton instance, allocating if necesary.
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.
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.e3c.E3ServerCompositionParameter: Name accessor
getNotifiers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of notifications
getOption(String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Returns the value of an option
getOptionNames() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Returns an iterator over the set of names in our option list.
getOutputDirPrefix() - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Accessoor for output directory prefix
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.
getOutputFileEntry() - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Accessor for output file entry
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
getParameter(String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Returns a parameter descriptor
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
getParameters() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Returns all parameters
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.
getPath() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: composer path accessor
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.
getPostProcessorParameters() - Static method in class com.arbortext.e3c.ClientComposer: Returns a map containing parameters for use by the ACL routine compose::callPostProcessorForE3().
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.
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.
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.
getRequestHandlers() - Method in interface com.arbortext.e3.E3RequestContext: Return an iterator over the list of request handlers
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
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.
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")
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.
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")
getSuccess() - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Accessor for 'success' flag
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.
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.
getType() - Method in interface com.arbortext.e3c.E3ServerCompositionParameter: Type code accessor
getValue() - Method in interface com.arbortext.e3c.E3ServerCompositionParameter: Value accessor
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")
getWorkDir() - Method in class com.arbortext.e3c.ClientComposer: Returns the absolute path to our working directory

H

handleResponse(E3ResponseInterface, Map<String, String>, E3Tracer) - Method in class com.arbortext.e3c.ClientComposer: Decodes a response returned by the PE server.
handleResponse(E3ResponseInterface, Map<String, String>, List<String>, E3Tracer) - Method in class com.arbortext.e3c.ClientComposer: Decodes a response returned by the PE server.
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.
info(String) - Method in interface com.arbortext.e3c.E3Tracer: Makes an informational trace entry
info(String, String) - Method in interface com.arbortext.e3c.E3Tracer: Makes an informational trace entry
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, 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.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
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.

L

logAsynchronousError(String, String) - Static method in class com.arbortext.e3c.ClientComposer: Appends an error message to the composerlog stanza associated with the current operation.
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.

N

normalizeOpenDocument(String, String, ClientComposer.DocOptions, File, String, String, List<String>, E3Tracer) - Method in class com.arbortext.e3c.ClientComposer: Writes a flattened version of an open Arbortext Editor document to the input directory (the directory that will be zipped and transmitted to the PE server).
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
popMissingGraphicWarning(String) - Static method in class com.arbortext.e3c.ClientComposer: Retrieves a 'missing graphic' warning message from the global list and returns it.
postProcess(Map<String, String>, E3ServerCompositionResult, JarFile, E3Tracer) - Method in interface com.arbortext.e3c.E3ClientCompositionExtension: Called by the E3 client composer after a normal return from E3.
preProcess(File, E3ServerCompositionRequest, Map, E3Tracer) - Method in interface com.arbortext.e3c.E3ClientCompositionExtension: Called by the E3 client composer just before the parameter docuemnt is saved to disk.
processComposerLog(String, String) - Static method in class com.arbortext.e3c.ClientComposer: Looks for a composerlog.xml in the given response and, if present, extracts the records and inserts them into the current client-side composerlog associated with this compose.

Q

QUEUE_NAME - Static variable in class com.arbortext.e3c.ClientComposer: queue name
queueFileDeletion(File) - Method in interface com.arbortext.e3.E3SubprocessPool: Queues a file or directory for deletion.
queueMissingGraphicWarning(String) - Static method in class com.arbortext.e3c.ClientComposer: Loads a 'missing graphic' warning messages into global storage.

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.
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

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.
serialize(Writer) - Method in interface com.arbortext.e3c.E3ServerCompositionParameter: Writes this parameter to an XML document
serialize(Writer) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Writes our content to an XML document
serialize(Writer) - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Encodes our content as an XML document
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.
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.
setDeleteCompDirs(boolean) - Static method in class com.arbortext.e3c.ClientComposer: Stores a new value for 'deleteCompDirs'
setDeleteWorkDir(boolean) - Static method in class com.arbortext.e3c.ClientComposer: Stores a new value for 'deleteWorkDir'
setDoc(String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Sets the name of the entry in the JAR file containing the document to be composed.
setErrorFileEntry(String) - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Stores a new error file entry value.
setHeader(String, String) - Method in interface com.arbortext.e3.E3RequestResponse: Sets a response header with the given name and value.
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.
setOutputDirPrefix(String) - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Stores a new output directory prefix value.
setOutputFile(File, boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets up to return the content of a file.
setOutputFileEntry(String) - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Stores a new output file entry value.
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.
setPath(String) - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Sets the absolute path to the composer (.ccf) file on the E3 server
setRecycleSubprocessFlag(boolean) - Method in interface com.arbortext.e3.E3RequestResponse: Sets our 'recycle-subprocess' flag.
setStatus(int) - Method in interface com.arbortext.e3.E3RequestResponse: Sets the status code for this response.
setSuccess(boolean) - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Stores a new 'success' flag
setTraceFile(boolean) - Static method in class com.arbortext.e3c.ClientComposer: Stores a new value for 'traceFile'
setTraceLevel(int) - Static method in class com.arbortext.e3c.ClientComposer: Stores a new value for 'traceLevel'
setTraceSystem(boolean) - Static method in class com.arbortext.e3c.ClientComposer: Stores a new value for 'traceSystem'
shouldRecycleSubprocess(HttpServletRequest) - Method in interface com.arbortext.e3.E3RequestContext: Indicates whether the sub-process that processes a request should be terminated after doing so.
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.
toString() - Method in interface com.arbortext.e3c.E3ServerCompositionRequest: Return our content as a string
toString() - Method in interface com.arbortext.e3c.E3ServerCompositionResult: Translates our content into a string
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.
TYPE_ENTRY - Static variable in interface com.arbortext.e3c.E3ServerCompositionParameter: Entry parameter: 'value' is the name of an entry in the JAR file containing all of the documents that comprise the composition request
TYPE_FILE - Static variable in interface com.arbortext.e3c.E3ServerCompositionParameter: File parameter: 'value' is an absolute path on the E3 server
TYPE_STRING - Static variable in interface com.arbortext.e3c.E3ServerCompositionParameter: String parameter: value is the string specified in 'value'
TYPE_UNKNOWN - Static variable in interface com.arbortext.e3c.E3ServerCompositionParameter: Unknown parameter value

U

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

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