Task Execution Web Service › Client Application Development

Client Application Development

The following steps are an overview of the client application development process for submitting remote web service requests to CA Identity Manager.

Note: This overview assumes that your integrated development environment includes a third-party tool like Axis that generates proxies. While this approach automates some of the development, it is not required.

1. Be sure that web services are enabled for the Identity Manager environment and for each task that is to support remote requests.
2. Generate the WSDL code by invoking the following URL:

   http://host:port/idm/TEWS6/environmentalias?wsdl
   

   For example:

   http://tewstest.ca.com:7001/idm/TEWS6/neteauto?wsdl
   

   Note: The URL is case sensitive, and environmentalias is the protected alias of the Identity Manager environment.

3. In your integrated development environment (IDE), create the proxies based on the WSDL document generated in the preceding step.

   Proxies reflect the operations that your client can submit to CA Identity Manager. Java proxies generated by third-party tools such as Apache Axis provide precise, self-documenting entry points and parameters.

4. In your IDE, develop the client code that formulates and submits the remote requests, and process the responses. Typically, you develop this code using a third-party tool such as Apache Axis and Microsoft .NET.

   Develop whatever programming logic is required to process the SOAP requests and responses in compliance with your business requirements.

5. At run time, the client application submits a CA Identity Manager request through a generated proxy. The proxy transforms the request into a SOAP document that the Task Execution Web Service can understand, and then submits the request to the web service.
6. CA Identity Manager processes the request and returns a SOAP response to the client application.

The following diagram illustrates the development and run-time processes:

WSDL Generation

Request a WSDL document from CA Identity Manager by invoking the following URL:

http://host:port/idm/TEWS6/environmentalias?wsdl

For example:

http://tewstest.ca.com:7001/idm/TEWS6/neteauto?wsdl

The URL is case sensitive, and environmentalias is the protected alias of the Identity Manager environment.

If WSDL generation is enabled for the Identity Manager environment, the response from CA Identity Manager is a single generated WSDL document. You can use this WSDL document directly to generate proxy code with a development tool like Axis WSDL2Java.

The WSDL document contains a class definition for each task that is enabled for web services in the User Console. By default, all tasks are enabled, so the WSDL document is large.

An IDE like Eclipse Web Tools Platform (WTP) enables you to invoke the URL and display the WSDL file with a list of all possible operations. You can also supply operation input values, execute the operation, and display the SOAP request and response messages.

Eclipse WTP, IntelliJ, and .NET include plug-ins that test web services by parsing the returned WSDL and rendering a test interface to call the available services with no manual coding required.

If WSDL generation is disabled, one of the following HTTP errors is returned with additional message information:

• 404 file not found
• 500 not authorized

Note: When generating WSDLs in a clustered environment, run one Policy Server and one Identity Manager Server, and stop all other Policy Servers and Identity Manager Servers within the cluster.