io.cdap.cdap.api.service

Class AbstractService<T extends ServiceConfigurer>

java.lang.Object

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

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

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

Type Parameters:

T - type of service configurer

All Implemented Interfaces:

Service<T>

Direct Known Subclasses:

BasicService

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

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 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	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

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>

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.

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.