AndroidHttpRestService

Additional

Language
Java
Version
simmra (Sep 21, 2015)
Created
Sep 10, 2014
Updated
Nov 22, 2015 (Retired)
Owner
aguilarguisado
Contributors
AMongeMoreno
aguilarguisado
juaagugui
3
Activity
Badge
Generate
Download
Source code

Show card

Android Http Service

Android Http Service is probably the easiest way of using RestServices with Android.

With this component you only have to define whatever you want before and after the request, and declare an intent in your manifest. It will handle network problems, verbs, headers etc. only giving them to it. Developers only have to tell the component what they want to send.

For this version you can:

  • Set headers.
  • Set the type of the verb for the request
  • Set default query parameters that used to be in your URL (even with POST, like http://www.example.com?api=json) - This feature will be surely deprecated.
  • Define your logout method and isLogged method for the cases when user must be authentified before making the request.
  • Set parameters for the query (via JSON or query parameters attached to the URL).

##Screenshots

Version

  • Version 2.0

How-to use this code

###Implementation

Short implementation: Using RestManagerFactory.

  • RestManagerFactory has two methods: createDefaultRestManager (useful most times) and createRestManagerWithHttpEventListener for customizing elements like loadings etc. (You can see an implementation in the sample).

Custom implementation: Defining it yourself

  • Declare your RestManager in your fragment or your activity and define the two required method (isLogged and logout) in case you need them. You can also let them empty. For example:

      RestManager restManager = new RestManager(this.getActivity(),this) {
       @Override
       public boolean logout() {
        // Not necessary
        return false;
       }
       @Override
       public boolean isLogged() {
        // Not necessary
        return false;
       }
      };
    
  • The RestManager object receives a listener OnHttpEventListener. In our sample, the fragment implements this interface. The code implemented in its two methods will be executed before and after the request. For example, we can show/hide loading before and after the request.

       @Override
       public void onRequestInit() {
        loading.setVisibility(ProgressBar.VISIBLE);
       }
      
       @Override
       public void onRequestFinish() {    
        loading.setVisibility(ProgressBar.GONE);
       }
    

###Use

  • To make an HttpRequest you have to define a HttpConnection object. We can set the object from its constructor or by its getters and setters. A simple HttpConnection:

       IHttpConnection connection = new HttpConnection("http://www.example.com?p=q", //URL
                  RESTIntentService.GET, //Verb=GET
                  null, //No JSON
                  this); //OnRESTResultCallback
    
  • OnRESTResultCallback implements the method which will be called when the server side makes a response. We have to process the response with appropriates codes, Strings, JSONs or whatever we expect or can get.

       @Override
       public void onRESTResult(int returnCode, int code, String result) {
        //Custom behavior
       }
    
  • At last, make the request (it could raise NoInternetConnectionException). The method declared above will handle the response:

       try {
        restManager.sendRequest(connection);
       } catch (NoInternetConnectionException expected) {
        setCustomCSSHtmlToWebView(R.string.noInternet, "no_internet.png");
       }
    
  • From version 1.0.1, you can set a return code for each request. "sendRequestWithReturn" allows sending different request from the same activity and react differently depending on the source request. Choose what to in each case in your onRESTResult method

      try {
        restManager.sendRequestWithReturn(1,connection1);
        restManager.sendRequestWithReturn(2,connection2);
        
       } catch (NoInternetConnectionException expected) {
        setCustomCSSHtmlToWebView(R.string.noInternet, "no_internet.png");
       }
    

License

Contact

Developer/Company