8 Using the Imaging API as Pure Web Services

This chapter has the following sections:

• Section 8.1, "About Using the Imaging API as Pure Web Services"

• Section 8.2, "Using Web Services in Stateless Sessions"

• Section 8.3, "Using Web Services in a Stateful Session"

8.1 About Using the Imaging API as Pure Web Services

Although the Native Java API is the most convenient way to leverage Imaging services, it is mostly a set of proxy and utility classes that wrap calls to the Imaging web services set. All of the functionality exposed by the native Java API is available using direct web service calls as well. Use of the API through direct web services requires a in depth understanding of WSDL documents and of environment specific techniques for invoking web services.

8.1.1 Locating Web Service WSDLs

Understanding how to invoke Imaging web services starts with knowing where to access the WSDL documentation. The following is a complete list of the Imaging service WSDL locations. The host name and port number will vary depending on your installation.

• http://<ipmhost>:<port>/imaging/ws/ApplicationService?wsdl

• http://<ipmhost>:<port>/imaging/ws/ConnectionService?wsdl

• http://<ipmhost>:<port>/imaging/ws/DocumentContentService?wsdl

• http://<ipmhost>:<port>/imaging/ws/DocumentService?wsdl

• http://<ipmhost>:<port>/imaging/ws/ImportExportService?wsdl

• http://<ipmhost>:<port>/imaging/ws/LoginService?wsdl

• http://<ipmhost>:<port>/imaging/ws/PreferenceService?wsdl

• http://<ipmhost>:<port>/imaging/ws/SearchService?wsdl

• http://<ipmhost>:<port>/imaging/ws/SecurityService?wsdl

• http://<ipmhost>:<port>/imaging/ws/TicketService?wsdl

8.2 Using Web Services in Stateless Sessions

The majority of Imaging web services are capable of operating in either stateless or stateful mode. In stateless mode, authentication credentials passed in each service request are used to transparently log the user in, perform the requested operation, and then log out before returning.

8.3 Using Web Services in a Stateful Session

In stateful operation, a call is first made to the LoginService.login operation to establish the user session with Imaging. Credentials to the login method are provided by the security policy currently in effect, or through HTTP Basic Auth if no policy is applied.

The jsessionid cookie returned by the log in operation is subsequently passed to call other services, thus maintaining session state from call to call. Note that web service security still requires that each call pass user credentials in order to comply with OWSM security policy enforcement. A call to LoginService.logout ends the user session.

As mentioned above, most Imaging services operate in either mode. The exception to this is the DocumentContentService. DocumentContentService operations are capable of leveraging a streaming Message Transmission Optimization Mechanism (MTOM) feature that is incompatible with OWSM security policies. Therefore, the stateful mode is required to wrap appropriate security around DocumentContentService operations.