SOAP Client using ksoap2 in Android - Kotlin

-

Introduction:


SOAP stands for Simple Object Access Protocol. It is XML-based protocol that allows programs that run on different operating systems (like Windows, Linux, etc) to communicate using HTTP and XML.

Pros:

  • Security - SOAP provides its own security known as WS Security.
  • Platform Independent - SOAP web services can be written in any programming language and executed in any platform

Cons:

  • Slow - It uses XML format that must be parsed, to be read. It defines many standards to be followed while developing. So its slow and consumes more bandwidth and resource.
  • WSDL dependent - It uses WSDL mechanism and doesn't have any other mechanism to discover the service.

Things to know:

The following are the things we have to know before we proceed further:

                   URL - It is the URL of WSDL file.

                   NAMESPACE - It is targetNamespace in WSDL.
                   
                   METHOD_NAME - It is the methodName(function name) of web service. We can have any no. of methods.

                    SOAP_ACTION - Its nothing but, NAMESPACE+METHOD_NAME

Example:

The following image is request and response format of  SOAP url that I've used. (public sample one)


Here, the above image is request format. And you can see that the SOAPACTION is "http://tempuri.org/Add", so obviously, NAMESPACE is "http://tempuri.org/" and METHOD_NAME is "Add".

Also, it requires two parameters namely, <intA> and <intB> of type, Integer.

In the below image, you can see the response format. In this sample, the response is just an Integer of Result value. In most cases, it will be in JSON format(it depends).

Implementation:

To fetch and post data to Soap api, we can use ksoap2 library. Its simple to use as well. Let's see how to use that in step-by-step procedure.

AndroidManifest.xml

To initiate, first we need the INTERNET permission to be added in AndroidManifest.xml.


 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

build.gradle

We can either add ksoap2 library into the project by adding JAR file or adding it via build.gradle. I found it easier to add using build.gradle. So I am posting code for it. If you are gonna add JAR file, then you skip this step and proceed next.


apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'

android {
    compileSdkVersion 27
    buildToolsVersion '27.0.3'
    defaultConfig {
        applicationId "com.yamikrish.soap_webservicesample"
        minSdkVersion 15
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }

        repositories {
            maven { url 'https://oss.sonatype.org/content/repositories/ksoap2-android-releases/' }
        }
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    implementation 'com.android.support:appcompat-v7:27.1.1'
    implementation 'com.android.support.constraint:constraint-layout:1.1.0'
    implementation 'com.google.code.ksoap2-android:ksoap2-android:3.6.2'
    compile 'com.android.support:design:27.1.1'
    testImplementation 'junit:junit:4.12'
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
}
repositories {
    mavenCentral()
}

activity_soap.xml

Then, design the layout to get two integer inputs and a button and a textView. While clicking the button, those two input integers to be added using SOAP api and display the result in the textView below it.

<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    xmlns:app="http://schemas.android.com/apk/res-auto">


    <android.support.design.widget.TextInputLayout
        android:id="@+id/inputLayout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        android:layout_margin="15dp">

        <android.support.design.widget.TextInputEditText
            android:id="@+id/enterInput1"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:inputType="number"
            android:hint="@string/enter_input_1" />

    </android.support.design.widget.TextInputLayout>

    <android.support.design.widget.TextInputLayout
        android:id="@+id/input2Layout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/inputLayout"
        android:layout_margin="15dp">

        <android.support.design.widget.TextInputEditText
            android:id="@+id/enterInput2"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:inputType="number"
            android:hint="@string/enter_input_2" />

    </android.support.design.widget.TextInputLayout>

    <TextView
        android:id="@+id/add"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/input2Layout"
        android:textAppearance="@style/TextAppearance.AppCompat.Medium"
        android:gravity="center"
        android:layout_margin="15dp"
        android:textColor="@color/colorWhite"
        android:background="@color/colorPrimary"
        android:text="@string/add"
        android:padding="10dp"/>
    <TextView
        android:id="@+id/resultValue"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/add"
        android:textAppearance="@style/TextAppearance.AppCompat.Small"
        android:layout_margin="15dp"
        android:padding="10dp"/>

</android.support.constraint.ConstraintLayout>


SoapActivity.kt

While clicking the button, 'add', we have to check whether the two inputs are entered or not. If it entered, we can call the SOAP api using AsyncTask and pass the two input values to it as well to process. For this process, another class, CallWebService is used. (I have written that class below.)

class SoapActivity : AppCompatActivity() {


    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.new_layout)

        add.setOnClickListener {
            val input1 = enterInput1.text.toString().trim()
            val input2 = enterInput2.text.toString().trim()
            when {
                input1.length == 0 || input2.length == 0 -> Toast.makeText(this, getString(R.string.fill_field), Toast.LENGTH_SHORT).show()

                !Utils.isConnected(this@SoapActivity) -> Toast.makeText(this, getString(R.string.no_internet), Toast.LENGTH_SHORT).show()

                else -> getCitiesOfCountry().execute(input1,input2)
            }
        }
    }

    inner class getCitiesOfCountry : AsyncTask<String, String, String>() {

        override fun doInBackground(vararg params: String?): String {
            val response = CallWebService().callApi(Utils.METHOD_ADD, params[0], params[1])
            Log.v("response", "response==" + response)
            return response
        }

        override fun onPostExecute(result: String?) {
            super.onPostExecute(result)
            Log.v("response", "OnPostresponse==" + result)
            try {
                resultValue.text = getString(R.string.result)+" "+result
            } catch (e: Exception) {
                e.printStackTrace()
            }

        }
    }
}

CallWebService.kt

This class is to process SOAP API. Note that we have added the parameters intA and intB here.  
                            soapObject.addProperty("intA", input1)
                            soapObject.addProperty("intB", input2)


Don't forget to add the parameters, otherwise the api will throw error. 




Also the input and URL all will be posted as XML and the response will also be received as XML, later


that will be converted to string.






                            val soapPrimitive = envelope.response
                            result = soapPrimitive.toString()















class CallWebService {

    fun callApi(methodName: String, input1: String?, input2: String?): String {
        var result = ""
        val SOAP_ACTION = Utils.SOAP_NAMESPACE + methodName
        val soapObject = SoapObject(Utils.SOAP_NAMESPACE, methodName)


        soapObject.addProperty("intA", input1)
        soapObject.addProperty("intB", input2)

        val envelope = SoapSerializationEnvelope(SoapEnvelope.VER11)
        envelope.setOutputSoapObject(soapObject)
        envelope.dotNet = true
        
        val httpTransportSE = HttpTransportSE(Utils.SOAP_URL)

        try {
            httpTransportSE.call(SOAP_ACTION, envelope)
            val soapPrimitive = envelope.response
            result = soapPrimitive.toString()
        } catch (e: Exception) {
            e.printStackTrace()
        }

        return result
    }
}












Utils.kt



This class is to have all static strings and methods to be used throughout the app.






class Utils {
    companion object {
 
        val SOAP_URL = "http://www.dneonline.com/calculator.asmx?"
        val SOAP_NAMESPACE = "http://tempuri.org/"
        val METHOD_ADD = "Add"

        fun isConnected(context: Context): Boolean {
            val cm = context.getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager
            val activeNetwork = cm.activeNetworkInfo
            return activeNetwork != null && activeNetwork.isConnectedOrConnecting
        }
    }
}





Run Application:





That's it. We are done!! Now we can run the application to get output.









 












































Comments









  1. saul santiagoOctober 02, 2018 2:59 pm
    thank you very much for the example you saved my life
    ReplyDelete
  2. Aydın Mehmet ÖZKANNovember 23, 2018 3:39 am
    Thanks for the example. Is it on github or somewhere?
    ReplyDelete
  3. Aydın Mehmet ÖZKANNovember 23, 2018 4:05 am
    Do you have any idea about this problem?

    SoapFault - faultcode: 'a:ActionNotSupported' faultstring: 'The message with Action '' cannot be processed at the receiver, due to a ContractFilter mismatch at the EndpointDispatcher. This may be because of either a contract mismatch (mismatched Actions between sender and receiver) or a binding/security mismatch between the sender and the receiver.  Check that sender and receiver have the same contract and the same binding (including security requirements, e.g. Message, Transport, None).' faultactor: 'null' detail: null
    ReplyDelete
  4. AnonymousJanuary 25, 2024 10:52 am
    Tengo problemas con el SOAPObject , tendras un ejemplo??
    ReplyDelete











Post a Comment








































Popular posts from this blog









Databinding in RecyclerView - Android - Kotlin






-














Image







 Hey Guyss!!   Already we have seen the basics of Databinding  and how to use it in previous  post .   Now let's see how to use Databinding  in RecyclerView . And Its gonna be a short post. ;)   You can find the Project in GitHub .   Prerequisite:  build.gradle   First, we have enable dataBinding in app-level build.gradle                             android {                                      dataBinding {                                              enabled = true                                      }                             }   Next, we have add the following plugin.                                 apply plugin: 'kotlin-kapt'    Next, we have to include dependency for databinding, (Not needed, if using Android Studio 3.2 or above, since its already bundled)                               kapt "com.android.databinding:compiler:3.2.0-alpha10"      Implementation:    We can directly bind the data to RecyclerView's Adapter layout. So, let's design the








Read more










RecyclerView  with different number of columns using SpanSizeLookup






-














Image







         We already know how to design RecyclerView. But how to create RecyclerView with different columns depending on its row? Like below image?       Yeah, we can do that, by using two different layouts with different viewType on Adapter. Another way is do some logic to do so. But, it's cumbersome. Luckily, we have another simple way to do that using SpanSizeLookUp . Let's see how to implement that in this post.   Implementation:   build.gradle   Include the following in app-level gradle file.       implementation  'com.android.support:recyclerview-v7:27.0.2'    implementation  'com.android.support.constraint:constraint-layout:1.1.0-beta5'     recycler.xml    <?xml version= "1.0"  encoding= "utf-8" ?> <android.support.constraint.ConstraintLayout xmlns:android= "http://schemas.android.com/apk/res/android"      android:layout_width= "match_parent"      android:layout_height= "match_parent"      xmlns:ap








Read more










Using Camera in Android - Kotlin






-














Image







         Nowadays, most of our Android app require access to Camera to capture picture or Video. We can do that in two ways.                                  (i) Using built-in Camera,                                  (ii) Using custom Camera.   Using Built-in Camera  In this post, Let's see how to use the built-in camera to capture images and save it.     Its a simple way to capture pics. We can use the mobile's built-in camera app using Intent.      val REQUEST_IMAGE_CAPTURE =  1    private fun takePictureIntent() {       val takePictureIntent =  Intent(MediaStore . ACTION_IMAGE_CAPTURE)       if  (takePictureIntent . resolveActivity(packageManager) !=  null) {            startActivityForResult(takePictureIntent, REQUEST_IMAGE_CAPTURE)       }  }           After the picture has been captured, the result will received on onActivityResult method. There, we can get the data, in Bitmap form.     override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {    








Read more










Using RxJava, Retrofit in Android - Kotlin






-














Image







  Introduction:  Reactive Programming  is a programming paradigm that’s concerned with data streams and propagation of change. The reactive model listens to changes in the event and runs the relevant code accordingly.   RxJava  is a Java based implementation of Reactive Programming.   Whereas, RxAndroid  is specific to Android platform which utilises some classes on top of the RxJava library.    Classes and Concepts:  There are 3 main components in RxJava.   (i) Observable  - It emits a stream of data or events. i.e., a class that can be used to perform some action, and publish the result.   (ii) Observer  - It receivers the events or data and acts upon it. i.e. a class that waits and watches the Observable, and reacts whenever the Observable publishes results.   It have 4 interface methods to know the different states of Observable, as follows:           onSubscribe()  - invoked when the Observer is subscribed.          onNext()  - invoked when the new item is emitted from Observer.  








Read more










Map, Location update and AutoComplete Places - Kotlin






-














Image







         Let's see how to show current location in Maps and also show the location which is chosen from AutoComplete in Maps with the updated Google play services. That is, for location listening we gonna use   FusedLocationProviderClient and for autocomplete places, we gonna use, GeoDataClient with AutoCompletePrediction, i.e., no need to call places url from our end, Google Playservices will do that work for you. Okiee, Let's start now.   You can find the project in Github .   PreRequisite:  Navigate to  https://developers.google.com/maps/documentation/android-api/signup  and do as per the instructions to start.   Manifest:   Include your API key, which you got from previous step in AndroidManifest.xml              <meta-data             android:name= "com.google.android.geo.API_KEY"              android:value= "AIzXXXXXXXXXX_XXXXXXXXXXXXXX"  />     Gradle:  Include the following in app-level build 's dependencies.         implementation 'com








Read more










Braintree Integration in Android - Kotlin






-














Image







            Let’s learn how to integrate Braintree in Android app with Kotlin. Braintree is a subsidary of PayPal.  It focuses in helping businesses of all size and to help maximize business growth. Braintree accepts  the following payments:                                                            * Credit Cards                              * Venmo                             * Android Pay                             * Apple Pay                             * PayPal        Operation Flow:              1. App have to request token from the server.       2. Server have to generate a token using Braintree’s SDK and send that to the requested App.       3. With that Token, app should allow user to pay, which will be validated by Braintree’s server and              then the payment nonce will be received.       4. That received payment nonce and paid amount will be sent to our own server. There the             payment will be checked whether its successful or not and the response will be s








Read more










Exploring Android Slices - JetPack






-














Image







  Introduction:   Slices are a new way of embedding our app's content in other surfaces, like Google Search and later in other places like Google Assistant. Slices are UI templates, which gives look and feel at home in whatever surface, they get hosts in. Also they are rich, interactive and dynamically updatable.    Before jumping into that, first migrate your project to AndroidX, (Android Studio 3.2 & above), by navigating as,                                           Refactor --> Migrate  to AndroidX         Setup:   build.gradle        implementation 'androidx.slice:slice-core:1.0.0'     implementation 'androidx.slice:slice-builders-ktx:1.0.0-alpha6'     implementation 'androidx.slice:slice-builders:1.0.0'      Creating Slice Provider:   Slice Provider is a component that let us display the slices we are creating, on outside our application. We can create the Slice Provider by navigating,                                         File -> New ->








Read more










Room with LiveData, ViewModel - Android Architecture Components - Kotlin






-














Image







              Introduction:     We have already learnt about Room in last post,  Room-Kotlin . In this post, lets learn about how to use ViewModel and LiveData with Room to improve usablity. Using LiveData with Room, allows views to be notified about data changes automatically.   LiveData:    LiveData is nothing but observable data holder class. It allows us to observer changes in data across multiple components of app. It is also aware of and respects lifecycle of Activities/Fragments. It also ensures that LiveData only updates app component observers that are in an active lifecycle state.     The following image depicts the Lifecycle and States:     Here, CREATED, STARTED, RESUMED - Active States            INTIALIZED, DESTROYED - InActive States   So, LiveData will remove the updates automatically while in InActive States, i.e., INTIALIZED and DESTROYED.   ViewModel:    ViewModel is an entity that is free of Activity/Fragment's lifecycle. So it allows us to store and manage UI-r








Read more










Stripe Integration in Android - Kotlin






-














Image







           Stripe is one of the simplest payment gateway to be used. It enables us to process payments in minutes. Let's see how to integrate Stripe in Android using Kotlin.    Operational Flow:                   1. App should provide order details to Stripe server and the order total will be returned to App.              2. Then the user will enter the payment/card details. That will be sent to Stripe server and the result of the request will be sent back to the App.    Create Stripe Account:   (a) Go to  https://dashboard.stripe.com/register  and enter all your details and create account.          (b) Click API in side tab. Make sure that the Account is in Test mode. And make a note of          Publishable Key and Secret Key for use.           Code:    build.gradle:     compile 'com.stripe:stripe-android:5.1.0'    Layout files:    main_layout.xml:    <?xml version="1.0" encoding="utf-8"?>   <android.support.constraint.ConstraintLayout xmlns:an








Read more