Step 1: Getting an Instance of XService

The first step involves getting an the instance of XService using the XServiceSer– viceLocator (generated by Axis). The second line of the code segment instructs the system to maintain the session.

XService service = new XServiceServiceLocator().
getDiscoveryService(new java.net.URL(
   "http://www.xactlycorp.com/icm/services/DiscoveryService"));

((DiscoveryServiceSoapBindingStub)service).setMaintainSession(true);

Step 2: Logging into the Xactly Connect Server

After getting an instance of the service object, the next step involves resolving the appropriate gateway and logging into the Xactly Connect Server. The login method returns a LoginResponse object.

String username = "demouser@xactlycorp.com";
String password = "password";

GatewayResolutionResponse gatewayResponse = 
   service.resolveGateway(username);
String gatewayUrl = gatewayResponse.getGatewayUrl();
System.out.println("Resolved Gateway URL for Authentication:" 
   + gatewayUrl);
((DiscoveryServiceSoapBindingStub) service).
   _setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, gatewayUrl);

LoginResponse response = service.login(username,password, "Incent");
((DiscoveryServiceSoapBindingStub) service).clearHeaders();

String sessionId = response.getSessionId();
String serverUrl = response.getServerUrl();

((DiscoveryServiceSoapBindingStub) service).
   _setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);

((DiscoveryServiceSoapBindingStub) service).setHeader(new
   XServiceServiceLocator().getServiceName().getNamespaceURI(),
   "SessionId", sessionId);

((DiscoveryServiceSoapBindingStub) service).setHeader(new
   XServiceServiceLocator().getServiceName().getNamespaceURI(),
   "UserName",username);

if (!response.isAuthenticated()) {
   ...
}

Creating an Xactly Connect Microsoft .NET Application

This section explains how to create a simple Microsoft .NET-based Xactly Connect application to log into Xactly Incent and search for a user using a cut-and-paste tutorial. The following is the complete listing for the tutorial application, followed by an explanation of the principal sections:

using System;
   using System.Collections.Generic;
   using System.Text;
   using System.Reflection;
   using System.IO;

namespace XService {
   class SearchObjects {
      public static int Main(string[] arg)  {
         SearchObjects toolkitClient = new SearchObjects();
    XService.XServiceClient client = new
            XService.XServiceClient("DiscoveryService",
            "http://www.xactlycorp.com/icm/services/DiscoveryService");

            string username = "username";
            string password = "password";

    XService.loginRequest request = 
            new XService.loginRequest(username, password, "Incent");
         XService.loginResponse1 response = client.login(request);
         toolkitClient.log(response);
         XService.LoginResponse lResp = response.loginReturn;
         client = new XService.XServiceClient("DiscoveryService", 
            lResp.serverUrl)
    XService.UserWSO user = new XService.UserWSO();

         user.email = "xactly";
         XService.SearchResponse searchResponse = service.search(user);
         toolkitClient.log(searchResponse);

    if (!searchResponse.result) {
            XService.XObject[] objects = searchResponse.searchRecords;
            for (int i = 0; i < objects.Length; i++) {
               user = (XService.UserWSO)objects[i];
               toolkitClient.log("----- Search Result -----");
               toolkitClient.log("Name: " + user.name);
               toolkitClient.log("email: " + user.email);
            }
         }

         return 0;
      }
   }
}

Step 1: Getting an Instance of XService

The first step involves getting an instance of XService.

XService.XServiceClient client = new
   XService.XServiceClient("DiscoveryService",
   "http://www.xactlycorp.com/icm/services/DiscoveryService");

Step 2: Logging into the Xactly Connect Server

The next step involves logging into the Xactly Connect Server.

string username = "username";
string password = "password";

XService.loginRequest request = new XService.loginRequest(username,
   password, "Incent");

XService.loginResponse1 response = client.login(request);
XService.LoginResponse lResp = response.loginReturn;
client = new XService.XServiceClient("DiscoveryService", lResp.serverUrl);

Step 3: Setting the Search Criteria

This step creates a new UserWSO object and sets the search criteria for the user email to xactly. This instructs the search method to find all users that have xactly as part of their email address.

XService.UserWSO user = new XService.UserWSO();
user.email = "xactly";

Step 4: Searching for Users

The final step uses the search method to locate all users that have Xactly as part of their email address and then iterates through the searchResponse object to extract the name and email address for each matching user.

XService.SearchResponse searchResponse = service.search(user);
toolkitClient.log(searchResponse);
if (!searchResponse.result) {
   XService.XObject[] objects = searchResponse.searchRecords;
   for (int i = 0; i < objects.Length; i++) {
      user = (XService.UserWSO)objects[i];
      toolkitClient.log("----- Search Result -----");
      toolkitClient.log("Name: " + user.name);
      toolkitClient.log("email: " + user.email);
   } 
}

Performing Error Handling

Xactly Connect uses the ErrorCode object as the basic error handling object. Response objects returned by the Xactly Connect API embeds an array of ErrorCode objects.

The ErrorCode object has three attributes:

• A code
• An error message (reason)
• A string representation of the stack trace

The following shows the ErrorCode class:

public class ErrorCode implements java.io.Serializable {
   private java.lang.Integer code;
   private java.lang.String reason;
   private java.lang.String stackTrace;

   public ErrorCode() {
   }

   public ErrorCode(
      java.lang.Integer code,
      java.lang.String reason,
      java.lang.String stackTrace) {
         this.code = code;
         this.reason = reason;
         this.stackTrace = stackTrace;
      }
      .
      .
      .
}

import org.apache.axis.client.Stub;

import com.xactly.icm.xtoolkit.service.XService;
import com.xactly.icm.xtoolkit.service.XServiceServiceLocator;
import com.xactly.icm.xtoolkit.wso.ErrorCode;
import com.xactly.icm.xtoolkit.wso.LoginResponse;
import com.xactly.icm.xtoolkit.service.DiscoveryServiceSoapBindingStub;

public class LoginUser {
   public static void main(String args[]) throws Exception {
      // Locate the Service and maintain session
      XService service = new XServiceServiceLocator().getDiscoveryService(new 
         java.net.URL("http://www.xactlycorp.com/icm/services/DiscoveryService"));
      ((DiscoveryServiceSoapBindingStub) service).setMaintainSession(true);

 String username = "xconnect@xactlycorp.com";
      String password = "invalidPassword";

      GatewayResolutionResponse gatewayResponse = 
         service.resolveGateway(username);
      String gatewayUrl = gatewayResponse.getGatewayUrl();
      System.out.println("Resolved Gateway URL for Authentication:" 
         + gatewayUrl);
      ((DiscoveryServiceSoapBindingStub) service).
         setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, gatewayUrl); 

      LoginResponse response = service.login(username,password,"Incent");
      ((DiscoveryServiceSoapBindingStub) service).clearHeaders();

      String sessionId = response.getSessionId();
      String serverUrl = response.getServerUrl();

      // Change the endpoint URL of the service and set session header.
      // The endpoint URL is similar to the following:
      // http://www.na1.xactlycorp.com/xiconnect/services/XService

      ((DiscoveryServiceSoapBindingStub) service).
         _setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);
      ((DiscoveryServiceSoapBindingStub) service).
         setHeader(new XServiceServiceLocator().getServiceName().
         getNamespaceURI(), "SessionId", sessionId);

      ((DiscoveryServiceSoapBindingStub) service).
         setHeader(new XServiceServiceLocator().getServiceName().
         getNamespaceURI(), "UserName", username);

 if (!response.isAuthenticated()){
         System.out.println("Login failed. Error code below.");
         ErrorCode errorCode = response.getErrorCodes();
         if (errorCode != null) {
            System.out.println("Error Code: " + errorCode.getCode());
            System.out.println("Reason: " + errorCode.getReason());
         } 
      } else
         System.out.println("User Logged in Successfully");
      } 
   }

   Login failed. Error code below.
   Error Code: 1224
   Reason: Login Failed. Please try again.