universum.studios.android.officium.service

Class ServiceApi<M extends ServiceManager>

java.lang.Object

universum.studios.android.officium.service.ServiceApi<M>

Type Parameters:

M - Type of the service manager used by the ServiceApi implementation.

public class ServiceApi<M extends ServiceManager>
extends Object

ServiceApi represents an access layer for a single services interface or set of such service interfaces.

Sample API structure

Classes described below should be placed in same package: ANDROID.APPLICATION.service

 // Api interface that is visible across whole application.
 public interface Api {

      String END_POINT = "http://messenger.com";
      String VERSION = "1";
      String URL = "/api/v" + VERSION;

      void signIn(@NonNull SignInRequest request);

      void forgotPassword(@NonNull ForgotPasswordRequest request);
 }

 // Retrofit services definition interface.
 interface Services {

      @POST(Api.URL + "/signIn")
      void signIn(
          @Body @NonNull SignInRequest request,
          @NonNull Callback<SignInResponse> callback
      );

      @POST(Api.URL + "/forgotPassword")
      void forgotPassword(
          @Body @NonNull ForgotPasswordRequest request,
          @NonNull Callback<ForgotPasswordResponse> callback
      );
 }

 // Api implementation provided by ApiProvider.
 final class ApiImpl implements Api {

      ApiImpl(@NonNull Bus bus) {
          super(new ServiceManager(), bus);
      }

      @Override
      public void signIn(@NonNull SignInRequest request) {
          services(Services.class).signIn(
              request,
              new ServiceCallback<SignInResponse>(1, mBus)
          );
      }

      @Override
      public void forgotPassword(@NonNull ForgotPasswordRequest request) {
          services(Services.class).forgotPassword(
              request,
              new ServiceCallback<ForgotPasswordResponse>(2, mBus)
          );
      }
 }

 // Provider that provides instance of ApiImpl for application clients.
 public final class ApiProvider extends ServiceApiProvider<Api> {

     public ApiProvider(@NonNull Bus bus) {
         super(bus);
     }

     @NonNull
     @Override
     protected Api onCreateApi(@NonNull Bus bus) {
          return new ApiImpl(bus);
     }
 }
 

Author:

Martin Albedinsky

See Also:

ServiceApiProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected M	mManager Instance of ServiceManager used to configure and access services provided by this API.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceApi(M manager) Creates a new instance of ServiceApi with the specified service manager.

Method Summary

Modifier and Type	Method and Description
protected <S> S	services(Class<S> servicesInterface) Returns an instance of services PROXY for the specified servicesInterface.
protected <S> ServiceManager.ServicesConfiguration<S>	servicesConfiguration(Class<S> servicesInterface) Returns the configuration for services with the specified servicesInterface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mManager

protected final M extends ServiceManager mManager

Instance of ServiceManager used to configure and access services provided by this API.

Constructor Detail

ServiceApi

protected ServiceApi(M manager)

Creates a new instance of ServiceApi with the specified service manager.

Parameters:

manager - The desired service manager used to configure and access services.

Method Detail

services

protected final <S> S services(Class<S> servicesInterface)

Returns an instance of services PROXY for the specified servicesInterface.

Type Parameters:

S - Type of the requested services.

Parameters:

servicesInterface - The services interface for which to the associated PROXY.

Returns:

Services PROXY ready to be used for requests execution.

See Also:

ServiceManager.services(Class)

servicesConfiguration

protected final <S> ServiceManager.ServicesConfiguration<S> servicesConfiguration(Class<S> servicesInterface)

Returns the configuration for services with the specified servicesInterface.

Returned configuration object can be used to change current configuration of a specific services PROXY instance.

Type Parameters:

S - Type of the services of the requested services configuration.

Parameters:

servicesInterface - The services interface for which to return theirs configuration.

Returns:

Configuration for the requested services.

See Also:

ServiceManager.servicesConfiguration(Class)