Android light weight library made up of two features Call and Network. Connection can be used in any Android project either using build script or adding aar file, no need to declare any thing else as all the permissions will be merged, it is simply a plug and play library!
- Network : Monitors connections like Wi-Fi, GPRS, UMTS, e.t.c. Device network usually attempts to fail over to another network connection when connectivity to a given network is lost, Network feature simply allows checking such as isConnectedOrConnecting to get the device network state. It also provides a way that allows apps to query the coarse-grained or fine-grained state of the available networks by checking isTypeMobile or isTypeWifi. It also allows apps to request and check networks for their fast data traffic by checking isConnectedConnectionFast or isConnectedConnectionSlow.
- Call : Makes asynchronous / non blocking http request with easy in a single line. To make a call simply do 2 things out of the box Call.execute(taskId,task,method,url,contentTypeRequest,contentTypeResponse,requestBody), and make your Class / Activity / Fragment / Model / Repositry whatever architecture you have implements Task where onTaskCompleted(int task, int httpCode, Object result) returns the response, thats it, 2 steps. It is also possible to make synchronous / blocking http request by simply cascaded the calls on Task completed for the consecutive calls.
implements Task in a class that is expected to receive http responses on task completed such as an Activity / Fragment / Model / Repositry whatever architecture you have, pass a unique task ID in the range of 1000 or as you so choose and pass the instance of the class that implemented the Task interface example call/s in one class for simple demo
public class MainActivity extends AppCompatActivity implements Task {
...
// Global settings affecting all calls just to be set once or changed before a specific / special call
Call.setTimeOut(5000); // not required only when needed, default half a minute / 30 seconds / 3000 milliseconds
// Global property add if needed, list support removed to make the library simple with 5 methods for any dev level
// Global property such as security / date / authentication e.t.c for all calls, just set once if needed
GlobalProperty globalProperty1 = new GlobalProperty("Authorization", "Bearer 3672e8ae491a13072c1-YOUR-KEY-48afb6c6d3");
// Adding global property
Call.addGlobalProperty(globalProperty1); // can be repeated for globalProperty2 e.t.c
// Removing global property
// Call.removeGlobalProperty(globalProperty1); // can be added / removed vice verser for specific flow
// POST Sample
String postData = "{\"name\":\"Khalid\",\"email\":\"khalid@alkathirikhalid.com\",\"gender\":\"male\",\"status\":\"active\"}";
String postURL = "https://gorest.co.in/public/v1/users";
// GET Sample
String getData = null;
String getURL = "https://gorest.co.in/public/v1/users/2676";
// PUT Sample
String putData = "{\"name\":\"Al Kathiri Khalid\",\"email\":\"k@alkathirikhalid.com\",\"gender\":\"male\",\"status\":\"active\"}";
String putURL = "https://gorest.co.in/public/v1/users/2676";
// DELETE Sample
String deleteData = null;
String deleteURL = "https://gorest.co.in/public/v1/users/2676";
// Execute CRUD Call
Call.execute(1000, this, POST, postURL, APPLICATION_JSON, APPLICATION_JSON, postData);
//Call.execute(2000, this, GET, getURL, APPLICATION_JSON, APPLICATION_JSON, null);
//Call.execute(3000, this, PUT, putURL, APPLICATION_JSON, APPLICATION_JSON, putData);
//Call.execute(4000, this, DELETE, deleteURL, APPLICATION_JSON, APPLICATION_JSON, null);
// Cancel executed Call if not needed for any reason example as leaving screen such as onPause e.t.c
// Call.cancelTask(4000);
...
@Override
public void onTaskCompleted(int task, int httpCode, @Nullable Object result) {
Log.d("***** Task ID: ", String.valueOf(task)); // the task unique identiifier provided in the execution of the call
Log.d("***** HTTP CODE: ", String.valueOf(httpCode)); // server response range 2xx success, range 4xx - 5xx error (normal http response) or 0 local error
Log.d("***** Data Received: ", String.valueOf(result)); // Object instance of String success / failure from Server or instance of Exception local error
Log.d("***** is Success: ", String.valueOf(isSuccessResponse(httpCode))); // Call util to check success range / not needed
if (result instanceof Exception) {
// all local errors including Call cancled, the error string is provided, this will allow to stop loading screen / animation
// all local errors will have http code 0
}
...
}
Call has a total of 5 methods where only 1 is need to make the call
- Call.setTimeOut(5000) Not required, time in milliseconds, default 3000 / 30 seconds.
- Call.addGlobalProperty(globalProperty) Not required, extra properties such as security / date / authentication / authorization.
- Call.removeGlobalProperty(globalProperty) Not required, only to remove extra propert if needed.
- Call.execute(taskId,task,method,url,contentTypeRequest,contentTypeResponse,requestBody) Required to make the call.
- Call.cancelTask(taskId) not required, only if needed for any reason such as leaving screen.
Supported metheds are POST, GET, PUT and DELETE.
Supported content types are application/json, multipart/form-data and application/x-www-form-urlencoded
It is safer to check isConnectedConnectionSlow first or only rather than isConnectedConnectionFast first or combined, to allow forward compatibility in the event faster mobile connection are introduce in the future that are above 20 plus Mbps.
All accessible and usable methods automatically calls isConnected() to guarantees that connectivity exists except for isConnectedOrConnecting depending on your application needs.
Connection.isConnectedConnectionSlow(context);
Network has a total of 6 methods.
- isConnectedOrConnecting() Checks if there is connectivity or is in the process of being established. This is applicable for applications that need to do any less intensive or slow network related activities.
- isConnected() Checks if there is connectivity and it is possible to pass data. This is applicable for applications that need to do any intensive network related activities like data transactions such as read or write data, guarantees that the network is fully usable.
- isTypeWifi() Checks if there is connectivity to WIFI, when active, all data traffic will use this network.
- isTypeMobile() Checks if there is connectivity to MOBILE data, when active, all data traffic will use this network.
- isConnectedConnectionFast() Checks if there is connectivity to MOBILE data speed of about 400kbps to 23Mbps. Supports subtype EVDO0, EVDOA, EVDOB, UMTS, EHRPD, HSDPA, HSPA, HSUPA, HSPAP and LTE.
- isConnectedConnectionSlow()Checks if there is connectivity to MOBILE data speed of about 14kbps to 100kbps. Supports subtype CDMA, 1xRTT, EDGE, GPRS and IDEN.
To have connectivity updates in real time simply either replace:-
- ConnectionActivity in place of Activity.
- ConnectionAppCompactActivity in place of AppCompactActivity.
And Override any of the provided 7 methods, which gives real time updates of all 6 mothods explained in Network Accesible and usable Methods including the 7th being noNetwork(), or simply use them without real time update as seen fit such as calling Connection.isConnectedConnectionSlow(context).
public class MainActivity extends ConnectionAppCompactActivity {
// Optional realtime update, simply Override any or all / if needed
}
@Override
public void connectedOrConnecting() {
// TODO
}
@Override
public void connected() {
// TODO
}
@Override
public void typeWifi() {
// TODO
}
@Override
public void typeMobile() {
// TODO
}
@Override
public void connectedConnectionFast() {
// TODO
}
@Override
public void connectedConnectionSlow() {
// TODO
}
@Override
public void noNetwork() {
// TODO
}
}
The minimun Android API 16. Thats it!
The library will handle the system broadcast and permissions automatically, simply add the library via aar file or as a dependency declaration and use it out of the box without further settings, Eloquent Connection has already declared for internet and network state.
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.alkathirikhalid:connection:v2.0.0'
}
A problem occurred will occur where the declared jitpack repo in project will fail to resolve / get the connection library
Simple Fix, in settings.gradle add jitpack repo, it must be present in settings.gradle on faliure will trigger dependencyResolutionManagement
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' } // Jitpack Repo
jcenter() // Warning: this repository is going to shut down soon
}
}
rootProject.name = "Your App"
include ':app'
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependency>
<groupId>com.github.alkathirikhalid</groupId>
<artifactId>connection</artifactId>
<version>v2.1.0</version>
</dependency>
- Document download: https://github.com/alkathirikhalid/connection/releases/download/v2.1.0/call-doc.zip
- Document download: https://github.com/alkathirikhalid/connection/releases/download/v2.1.0/network-doc.zip
- AAR download: https://github.com/alkathirikhalid/connection/releases/download/v2.1.0/connection.aar (Network & Call)
- JAR download: https://github.com/alkathirikhalid/connection/releases/download/v2.1.0/call.jar (Call Only)
Copyright 2015 - 2021 Al-Kathiri Khalid www.alkathirikhalid.com
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.