Creating Custom Apex SOAP based Web Service in Salesforce.com's Force.com platform

This blog describes how to create a Custom web service in Salesforce using Apex.

Steps:
 
  • Navigate to Setup>Develop>Apex Classes  and create new class by clicking new button.
  • Write a class with "global" access modifier with methods (to be exposed) with "webService" keyword
        eg.

global class KartikService
{
    webService static String hello(String Name) 
    {
        return 'Hello '+Name+' ! :D';
    }
}

  • Then save this class. After saving the class you will view a button "Generate WSDL". Click on that to get WSDL for web service you just created. Save the WSDL file. Let say file name is "KartikService.wsdl"
  • Now we will consider how we generate clients to call this service in Java and in .Net.



 For Java:



  • We will create new project in Eclipse with name "ApexCustomWS"
  • You need Enterprise/Partner WSDL to access your Salesforce org. by getting a valid sessionId.
  • Import Enterprise or Partner WSDL file into the project and generate the web service client for that.
  • Import the "KartikService.wsdl" into project and  generate web service client by right clicking on the WSDL file.
  • Image below shows code generated for Partner WSDL in Blue box and code for Custom Web service in Red Box

Above step will generate few Java files. Now add a class "Test.java" and write following code:

package com.sforce.soap.schemas._class.KartikService;
 
import java.net.URL;
import org.apache.axis.AxisFault;
import com.sforce.soap.partner.LoginResult;
import com.sforce.soap.partner.SessionHeader;
import com.sforce.soap.partner.SforceServiceLocator;
import com.sforce.soap.partner.SoapBindingStub;
 
public class Test 
{
   public static void main(String[] args) 
   {
       try 
       {
         //Get a stub for calling partner WSDL's login method in order to get SessionID
         SoapBindingStub bind= (SoapBindingStub)new SforceServiceLocator().getSoap();
         LoginResult lr=bind.login("your_username_here", "your_Password+SecurityToken");
 
         //Create a sessionHeader object and set its sessioId property to sessionId 
         //received in loginResult object                        
         SessionHeader sh=new SessionHeader();
         sh.setSessionId(lr.getSessionId());
 
         //Create a service locator object for your custom web service
         KartikServiceServiceLocator locator=new KartikServiceServiceLocator();
 
         //Get URL for your custom web service
         URL url=new URL(locator.getKartikServiceAddress());
 
         //Create a stub for your custom web service with URL for your service and locator as parameters
         KartikServiceBindingStub stub=new KartikServiceBindingStub(url, locator);
 
         //Set the header property of stub with name "SessionHeader" and value as sh-sessionHeader 
         //object created above 
         stub.setHeader(locator.getKartikServiceAddress(), "SessionHeader", sh);
 
         //now make call to custom service-in our case its "Hello(String name)"
         System.out.println(stub.hello("KARTIK"));
        }
        catch (Exception e) 
        {e.printStackTrace(); }  
   } 
}


Its output:
 
Hello KARTIK !
 

For VB.NET:

    • Create a new Winows project or ASP.net project with name "ApexCustomWS"
    • Add Web Service Reference using Partner.wsdl with namespace name as "sForceService"
    • Add Web Service Reference using KartikService.wsdl with namespace name as "MyCustomApexWS"
 
 
               
 
    • Now the project in solution explorer with these references will look like :


               

    • Now we write a procedure "callCustomApexService" that first calls login service and get a sessionID and then make call to custom web service.
    • Code:
    • Imports ApexCustomWS.sForceService
Imports ApexCustomWS.MyCustomApexWS
 
Public Class Form1
    Public Sub callCustomApexService()
        Dim stub As New ApexCustomWS.sForceService.SforceService
        Dim lr As LoginResult
        Dim sh As New ApexCustomWS.sForceService.SessionHeader
 
        'make call to login service to get sessionId
        lr = stub.login("your_username_here", "your_Password+SecurityToken")        sh.sessionId = lr.sessionId
        stub.Url = lr.serverUrl
        stub.SessionHeaderValue = sh
 
        'Create stub to call custom web service
        Dim myserviceStub As New MyCustomApexWS.KartikServiceService
        myserviceStub.SessionHeaderValue = New MyCustomApexWS.SessionHeader
        myserviceStub.SessionHeaderValue.sessionId = sh.sessionId
 
        MsgBox(myserviceStub.hello("KARTIK"))
 
    End Sub
    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        callCustomApexService()
    End Sub
End Class

Comments

Post a Comment

Popular posts from this blog

Approval Process

Image
Salesforce: Approval Process - Who can approve ? To build an approval workflow in Salesforce is simple, since Salesforce provide  Approval Processes . You can find this under  Setup  -  Create  -  Workflow & Approvals  -  Approval Processes . In early blogs, we have discussed about  Serial and Parallel Approval  in Salesforce, in this blog, we would like to discuss in depth option of users can approve? Manager Approval In the approval process  Step 3. Specify Approver Field and Record Editability Properties , there is option to determine next automated approver. Notice that  Next Automated Approver Determined By  is not a mandatory field here. Option available here: Manager   - a standard field in user object and has no relation with Role Hierarchy All custom fields in user object with type = Hierarchy - in above sample: Boss and Sales Director. If you select  Manager  as in above screenshot, when you set up Approval Step, in  Step 3. Select Assigned Approv
Read more

Spring Batch 2.0 -Basic Concepts

There is always a healthy debate when talking Java and batches. When I heard  Spring Batch , I had to try it out.  On a previous project, many eons back, I did some batch processing in Java. What hurt me there (after a lots of optimizations) was a call to another persons module. His module happily loaded up an entity bean. You can guess where that ended. Next release I went through the code and replaced the entity bean calls with ONE update SQL statement. That fixed things. I was processing 200k records in 15-20 minutes, with an extremely small memory footprint. Even this I could reduce further if I tuned another module. But the performance was deemed enough and we moved on. What I personally felt from that experience was the need of a decent Java-based Batch processing framework. Of course having this does not mean use Java for batches. Sometimes for bulk processing doing it in the database may be the right approach. In this blog I want to go over Spring Batch processing. We wi
Read more

Sending Mass Emails From Salesforce

Image
Create a Email Template  Then you either go to the Lead Tab or the Contact Tab and scroll down the page until you see the Mass Email link in the Tools section. On the first step of the mass email wizard is to create your target list. To do this you have the option of leveraging an existing View that is available on the Leads tab, or you can create a new View from within the wizard. In this example we will create our target list from within the wizard by clicking the   Create New View   link. In my example I’m   creating a quick View   to grab any Lead that is in the State of California. Notice in Step 2 of the View you can use a Campaign to filter (handy if your Campaign has your target list as Campaign Members!). Remember you have governor limits based on your edition (see paragraph two of this blog posts). If you’re running Professional Edition for example, and your View pulls more than 250 records, you’ll need to add additional filters to your View to reduce the
Read more