universum.studios.android.officium.service

Class ServiceManager

java.lang.Object

universum.studios.android.officium.service.ServiceManager

public class ServiceManager
extends Object

Manager that may be used for accessing of multiple instances of services (theirs PROXYies) and also of theirs configuration. Each instance of ServiceManager should have its end point specified via setEndPoint(EndPoint). This end point is than attached to each ServiceConnection object that is created whenever a desired services PROXY instance is requested via services(Class) or its configuration is requested via servicesConfiguration(Class).

As it is described in ServiceManager.ServicesConfiguration class, each services configuration object caches its services PROXY instance and re-creates it only in case of configuration change. Also ServiceManager caches each instance of these configuration objects and maps them to theirs corresponding services interface.

Author:

Martin Albedinsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceManager.ServicesConfiguration<S> Class used for configuration of a specific Retrofit services interface.

Constructor Summary

Constructors

Constructor and Description
ServiceManager() Creates a new instance of ServiceManager without specified end point.
ServiceManager(EndPoint endPoint) Creates a new instance of ServiceManager with the specified endPoint.

Method Summary

Modifier and Type	Method and Description
EndPoint	getEndPoint() Returns the end point specified for this manager.
protected ServiceManager.ServicesConfiguration	onCreateServicesConfiguration(Class<?> servicesInterface) Invoked whenever servicesConfiguration(Class) or services(Class) is called for the first time for the specified servicesInterface.
<S> S	services(Class<S> servicesInterface) Returns the PROXY instance for the requested servicesInterface.
<S> ServiceManager.ServicesConfiguration<S>	servicesConfiguration(Class<S> servicesInterface) Returns the services configuration object for the requested servicesInterface.
void	setEndPoint(EndPoint endPoint) Sets an end point for this manager.
void	setEndPoint(String baseUrl) Same as setEndPoint(EndPoint) with EndPoint instance providing the given baseUrl as its base url via EndPoint.getBaseUrl().

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceManager

public ServiceManager()

Creates a new instance of ServiceManager without specified end point.

See Also:

setEndPoint(EndPoint)

ServiceManager

public ServiceManager(EndPoint endPoint)

Creates a new instance of ServiceManager with the specified endPoint.

Parameters:

endPoint - The desired end point. This end point will be attached to each services configuration created via onCreateServicesConfiguration(Class).

See Also:

getEndPoint()

Method Detail

setEndPoint

public void setEndPoint(String baseUrl)

Same as setEndPoint(EndPoint) with EndPoint instance providing the given baseUrl as its base url via EndPoint.getBaseUrl().

Parameters:

baseUrl - Base url of the desired end point.

setEndPoint

public void setEndPoint(EndPoint endPoint)

Sets an end point for this manager.

The specified end point will be attached to each services configuration created via onCreateServicesConfiguration(Class).

Parameters:

endPoint - The desired end point.

See Also:

getEndPoint()

getEndPoint

public EndPoint getEndPoint()

Returns the end point specified for this manager.

Returns:

This manager's end point used for services configuration or null if no end point has been specified.

services

public <S> S services(Class<S> servicesInterface)

Returns the PROXY instance for the requested servicesInterface. The returned PROXY can be immediately used for services invocation that are declared by the given services interface.

Each services interface can be configured via its corresponding configuration object that can be obtained via servicesConfiguration(Class).

Type Parameters:

S - Type of the services interface.

Parameters:

servicesInterface - The services interface for which to access its PROXY instance.

Returns:

PROXY for the desired services interface ready for services invocation.

See Also:

servicesConfiguration(Class)

servicesConfiguration

public <S> ServiceManager.ServicesConfiguration<S> servicesConfiguration(Class<S> servicesInterface)

Returns the services configuration object for the requested servicesInterface.

Type Parameters:

S - Type of the services interface.

Parameters:

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

Returns:

Configuration object that can be used to configure the desired services.

See Also:

ServiceManager.ServicesConfiguration, services(Class)

onCreateServicesConfiguration

protected ServiceManager.ServicesConfiguration onCreateServicesConfiguration(Class<?> servicesInterface)

Invoked whenever servicesConfiguration(Class) or services(Class) is called for the first time for the specified servicesInterface.

Default implementation creates a new instance of ServicesConfiguration with the given services interface and end point specified for this manager (if any).

Custom implementations of ServiceManager may override this method to perform default services configuration for them specific.

Parameters:

servicesInterface - Class of the services interface for which to create new configuration object.

Returns:

New services configuration for the services interface.