io.cdap.cdap.api.service

Interface ServiceConfigurer

All Superinterfaces:

DatasetConfigurer, PluginConfigurer

public interface ServiceConfigurer
extends PluginConfigurer, DatasetConfigurer

Interface for configurers used to create custom Services.

Method Summary

Modifier and Type	Method and Description
void	addHandlers(Iterable<? extends HttpServiceHandler> handlers) Add a a list of request handlers to the Service.
void	setDescription(String description) Set description of the Service.
void	setInstances(int instances) Sets the number of instances needed for the server that runs all HttpServiceHandlers of this Service.
void	setName(String name) Set name of the service.
default void	setProperties(Map<String,String> properties) Sets a set of properties that will be available through the ServiceSpecification.getProperties() at runtime.
void	setResources(Resources resources) Sets the resources requirements for the server that runs all HttpServiceHandlers of this Service.

Methods inherited from interface io.cdap.cdap.api.plugin.PluginConfigurer

evaluateMacros, evaluateMacros, usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from interface io.cdap.cdap.api.DatasetConfigurer

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Method Detail

setName

void setName(String name)

Set name of the service.

Parameters:

name - of the service.

setDescription

void setDescription(String description)

Set description of the Service.

Parameters:

description - to set for the Service.

addHandlers

void addHandlers(Iterable<? extends HttpServiceHandler> handlers)

Add a a list of request handlers to the Service.

Parameters:

handlers - to serve requests.

setResources

void setResources(Resources resources)

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

Parameters:

resources - The requirements.

setInstances

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.

setProperties

default 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