RenderX

Chapter 12 of the VDPMill User Guide

VDPMill XML-RPC Components

B.1. XML-RPC Server

VDPMill XML-RPC Server is an XML-RPC interface to VDPMill Job Manager. It provides the Job Manager's functionality via XML-RPC protocol and allows to run job processing in a separate process. VDPMill XML-RPC Server makes possible to use VDPMill full functionality from applications which are built using languages/frameworks providing libraries for XML-RPC.

The server opens a TCP port and listens for incoming connections. The port to listen to is a configurable parameter and it must not be used when the server is starting. When the server starts it launches VDPMill Job Manager and transfers incoming requests to it. For Job Manager information see Appendix A, VDPMill Job Manager**.

For detailed information about the API of VDPMill XML-RPC Server refer to VDPMill API documentation in VDPMill DevKit package.

VDPMill XML-RPC Server can be run through the command line (see Section B.1, “XML-RPC Server ”) or from VDPMill Control Panel (see Chapter 7, VDPMill Control Panel**).

VDPMill XML-RPC Server uses Apache libraries for XML-RPC.

VDPMill package includes XML-RPC Server running scripts. The bin/vdpmill-xmlrpc-server(.bat)[1] script has the following command-line parameters:

            Usage: com.renderx.vdpmill.xmlrpc.Server [-d]
                                                     [-p port]
                                                     [-f finished-jobs-list-size>]
                                                     VDPMILL.CONF
                                                     SESSION_DIR

where:

  • -d - debug mode.

  • port - TCP port for the server to listen on. The given port must be free when the server starts.

  • finished-jobs-list-size - finished jobs list limit. For the detailed description of this parameter see Appendix A, VDPMill Job Manager**.

  • VDPMILL.CONF - path to VDPMill configuration file.

  • SESSION_DIR - path to session directory to load previous sessions on Job Manager start and to store session on quit.

 

The server writes all the log messages to the standard error stream, that can be redirected to a file using > or >> redirection symbols in the command line.

 

B.2. XML-RPC Client

VDPMill XML-RPC Client is a Java class to connect and call methods of VDPMill XML-RPC Server.

VDPMill package includes the bin/vdpmill-xmlrpc-client(.bat)[1] script which allows to call VDPMill XML-RPC Server methods using the command-line interface. This tool is built around VDPMill XML-RPC Client. The command-line syntax is the following:

              Usage: xmlrpc-client [-p port]
                                   [-t timeout]
                                   command
                                   param
                                   [param2]

where:

  • port - VDPMill XML-RPC port to connect to.

  • timeout - socket timeout in milliseconds.

  • command - apply|pause|resume|list|priority|stop

  • param - job ticket file path for the apply command, job-id for other commands.

  • stop server stops the server

  • list all - lists all queued jobs.

  • param2 - additional parameter for priority command, that should appear as priority <job-id> normal/high/low.