Configuring Arbortext Publishing Engine > Setting Configuration Parameters > Specifying a Request Handler > The RequestHandler for Arbortext Publishing Engine Functions
  
The RequestHandler for Arbortext Publishing Engine Functions
The Arbortext Publishing Engine Request Handler is implemented to support client functions that perform the work of processing a request. A client function refers to one either supplied by Arbortext or a custom application. Each request has a parameter that specifies a query specification resolving to a corresponding f=function-name or f-function-name function call. The parameters map each supported type of function-name to its underlying Java interface which handles the processing for Arbortext Publishing Engine.
The RequestHandler object specified in e3config.xml is com.arbortext.e3.RequestHandler with the ID e3-functions. This RequestHandler manages HTTP requests that meet one of the defined query conditions and are not otherwise routed by a previously invoked RequestHandler.
The com.arbortext.e3.RequestHandler has a list of parameters defining the query specification. In each case, an HTTP or SOAP request is evaluated for a match to assist in routing the request to the proper Arbortext PE sub-process pool. By default, parameters are associated with ClientFunction entries in the AllowedFunctions section of the e3config.xml file where permission for functions to run is specified.
In the following list of default parameters, the parameter name specifies the type of function call and the value specifies the associated Java interface that enables the underlying processing. Each of the Java classes in turn implements the com.arbortext.e3.E3RequestFunction interface. To implement a custom query parameter and support for the associated processing mechanism, you can review these parameter specifications for guidelines.
Default Request Handler Parameters
name
value
query-function-name
f specifies the prefix for a function
function-prefix
f- also specifies a prefix for a function
f-acl and f-eval
com.arbortext.e3.FunctionAcl processes calls to ACL functions
f-convert
com.arbortext.e3.FunctionNewConvert processes calls to convert documents. It supports the built-in convert function call and its associated series of explicitly supported parameters (explained in the Programmer's Guide to Arbortext Publishing Engine).
f-init
com.arbortext.e3.FunctionInit triggers a reload of custom ACL and JavaScript applications in an Arbortext PE sub-process pool. It supports the built-in init function call. Manual initialization is also available from a link on the Arbortext Publishing Engine index page (refer to Monitoring and Reporting Using a Web Browser).
f-java
com.arbortext.e3.FunctionJava processes calls to Java applications. It supports the built-in java application call and its associated class parameter specifying the Java class name.
f-javascript
com.arbortext.e3.FunctionJavascript processes calls to JavaScript functions. It supports the built-in javascript function call and its associated function parameter specifying the JavaScript function name.
f-vbscript
com.arbortext.e3.FunctionVbscript processes calls to VBScript functions. It supports the built-in vbscript function call and its associated function parameter specifying the VBScript function name.
f-oldconvert
com.arbortext.e3.FunctionConvert processes calls to convert documents that use an older methodology. It supports the backward compatibility supplied by the oldconvert function call.
f-license
com.arbortext.e3.FunctionLicense requests a report about the Arbortext Publishing Engine license. It supports the built-in license function, which is an administrative tool that returns a license report. A license report is also available from a link on the Arbortext Publishing Engine index page (refer to Monitoring and Reporting Using a Web Browser for information).
f-status
com.arbortext.e3.FunctionStatus requests a report from the Arbortext PE Request Manager. It supports the built-in status function, which is an administrative tool that returns an XHTML report. A status report is also available from a link on the Arbortext Publishing Engine index page.
f-version
com.arbortext.e3.FunctionVersion requests a report on your Arbortext Publishing Engine version. It supports the built-in version function, which is an administrative tool that returns a version report. A version report is also available from a link on the Arbortext Publishing Engine index page.
f-compconfig-rescan
com.arbortext.e3.FunctionRescan triggers a rescan of publishing configuration information used by Arbortext Editor clients. A rescan is also available from a link on the Arbortext Publishing Engine index page.
f-supportdata
com.arbortext.e3.FunctionSupportData collects data to put into a zip archive to submit to PTC Support. A zip archive is also available from a link on the Arbortext Publishing Engine index page.
q-enable
com.arbortext.e3.function.QueueEnable enables queuing. The queuing functions f=q-queue-function can be used by a custom application to send requests to a Queue Manager. These functions are described in the Programmer's Guide to Arbortext Publishing Engine.
q-holdall
com.arbortext.e3.function.QueueHold holds all queued transactions. The queuing functions f=q-queue-function can be used by a custom application to send requests to a Queue Manager.
q-list
com.arbortext.e3.function.QueueList enables listing queues. The queuing functions f=q-queue-function can be used by a custom application to send requests to a Queue Manager.
qt-cancel
com.arbortext.e3.function.TransactionCancel cancels a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager. These functions are described in the Programmer's Guide to Arbortext Publishing Engine.
qt-discard
com.arbortext.e3.function.TransactionDiscard discards a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager.
qt-execute
com.arbortext.e3.function.TransactionExecute executes a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager. These functions are described in the Programmer's Guide to Arbortext Publishing Engine.
qt-hold
com.arbortext.e3.function.TransactionHold holds a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager.
qt-list
com.arbortext.e3.function.TransactionList lists all queued transactions. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager. These functions are described in the Programmer's Guide to Arbortext Publishing Engine.
qt-move
com.arbortext.e3.function.TransactionMove moves a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager. .
qt-retrieve
com.arbortext.e3.function.TransactionRetrieve retrieves a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager.
qt-setpriority
om.arbortext.e3.function.TransactionPriority sets the priority of a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager.
qt-status
com.arbortext.e3.function.TransactionStatus gets the status of a queued transaction. The queuing functions f=qt-queued-transaction-function can be used by a custom application to send requests to a Queue Manager.
For information about writing and implementing custom Java, JavaScript, VBScript, and ACL applications, consult the Programmer's Guide to Arbortext Publishing Engine.