2017

USING QUARKXPRESS SERVER
196 | A Guide to QuarkXPress Server 2017
The prerequisites for using the Extensibility tool are as follows:
J
DK 1.6•
A
pache ANT 1.6.5 or later•
P
erl 5.8.4 or later with the XML::DOM module•
Third-party libraries (available at
[QXPSM application•
folder]\Server\dependencies)
QXPSM libraries (avaiable at
[QXPSM application folder]\Server\lib•
Microsoft .NET Framework 3.5 or later (required only for generating .NET stubs)•
The Extensibility tool is located in the
XDK/Extensibility folder. For instructions
on how to use it, see the following topics.
Writing special request handlers
If you need to perform custom actions on specific flags, you need to define special
flags and write handlers for them. These flags can then be passed as GET parameters
to the servlet, as additional QParam parameters in QCommand (executed using
QManagerSvc.executeCommand), or as additional NameValueParam parameters in
a derived class of QRequest using RequestService.processRequest. The servlet
will automatically create parameters out of these flags and set these in the
command before sending it for execution.
To handle these special flags, you can write your request handler derived from the
class
QRequestHandler. You can then insert this new handler class anywhere in
the chain of responsibility pattern, starting with QDocProviderImpl and ending
with
QHostRequestHandler.
Try not to change end points. In your handler implementation, handle your special 
flags, then either return a response after handling or pass the control to the
successor for further handling.
Implementing a custom load balancer
To implement a custom load balancer, first implement the
com.quark.manager.lb.QLoadBalancer interface. To use this interface, add a
reference to “managerengine.jar” to your project.
This interface method contains the following methods:
getLoadBalancerAlgorithm
Signature public String getLoadBalancerAlgorithm();
Description
Returns the name of the algorithm that is
mapped to the current load balancer while
loading the server.
Returns
The algorithm name used to load-balance the list
of hosts.
getLoadBalancerDescription
Signature public String getLoadBalancerDescription();
Description
Gets the description of the load-balancing
algorithm so it can be displayed in the