io.cdap.cdap.api.service

Class AbstractService<T extends ServiceConfigurer,V extends ServiceContext>

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<T>

io.cdap.cdap.api.service.AbstractService<T,V>

Type Parameters:

T - type of service configurer

V - type of service context

All Implemented Interfaces:

ProgramLifecycle<V>, Service<T,V>

Direct Known Subclasses:

BasicService

public abstract class AbstractService<T extends ServiceConfigurer,V extends ServiceContext>
extends AbstractPluginConfigurable<T>
implements Service<T,V>

An abstract implementation of Service. Users may extend this to write a Service. The default no-op constructor must be implemented.

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Modifier and Type	Method and Description
protected void	addHandler(HttpServiceHandler handler) Add handler to the Service.
protected void	addHandlers(Iterable<? extends HttpServiceHandler> handlers) Add a list of handlers to the Service.
protected abstract void	configure() Implements this method to configure this Service.
void	configure(T serviceConfigurer) Configure the Service by adding HttpServiceHandlers to handle requests.
protected T	getConfigurer() Returns the ServiceConfigurer, only available at configuration time.
protected V	getContext()
void	initialize(V context) Initialize the Service.
protected void	setDescription(String description) Set the description of the Service.
protected void	setInstances(int instances) Sets the number of instances needed for the server that runs all HttpServiceHandlers of this Service.
protected void	setName(String name) Set the name for the Service.
protected void	setProperties(Map<String,String> properties) Sets a set of properties that will be available through the ServiceSpecification.getProperties() at runtime.
protected void	setResources(Resources resources) Sets the resources requirements for the server that runs all HttpServiceHandlers of this Service.

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.cdap.cdap.api.service.Service

destroy

Constructor Detail

AbstractService

public AbstractService()

Method Detail

configure

public final void configure(T serviceConfigurer)

Description copied from interface: Service

Configure the Service by adding HttpServiceHandlers to handle requests.

Specified by:

configure in interface Service<T extends ServiceConfigurer,V extends ServiceContext>

Parameters:

serviceConfigurer - to use to add handlers to the Service.

setName

protected void setName(String name)

Set the name for the Service.

Parameters:

name - of the service.

setDescription

protected void setDescription(String description)

Set the description of the Service.

Parameters:

description - of the service.

addHandler

protected void addHandler(HttpServiceHandler handler)

Add handler to the Service.

Parameters:

handler - to serve requests with.

addHandlers

protected void addHandlers(Iterable<? extends HttpServiceHandler> handlers)

Add a list of handlers to the Service.

Parameters:

handlers - to service requests with.

setInstances

protected void setInstances(int instances)

Sets the number of instances needed for the server that runs all HttpServiceHandlers of this Service.

Parameters:

instances - Number of instances, must be > 0.

setResources

protected void setResources(Resources resources)

Sets the resources requirements for the server that runs all HttpServiceHandlers of this Service.

Parameters:

resources - The requirements.

setProperties

protected void setProperties(Map<String,String> properties)

Sets a set of properties that will be available through the ServiceSpecification.getProperties() at runtime.

Parameters:

properties - the properties to set

getConfigurer

protected final T getConfigurer()

Returns the ServiceConfigurer, only available at configuration time.

Specified by:

getConfigurer in class AbstractPluginConfigurable<T extends ServiceConfigurer>

configure

protected abstract void configure()

Implements this method to configure this Service.

getContext

protected V getContext()

initialize

public void initialize(V context)
                throws Exception

Description copied from interface: Service

Initialize the Service. This method will be called before the service starts up. This method will be called before each service instance starts up. If there is more than one instance of the service, it will be called more than once. Note that unlike most program types, this method is not called within an implicit transaction, but instead it can start its own transactions using Transactional.execute(TxRunnable). methods.

Specified by:

initialize in interface ProgramLifecycle<V extends ServiceContext>

Specified by:

initialize in interface Service<T extends ServiceConfigurer,V extends ServiceContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.