io.cdap.cdap.api.service.http

Class HttpServiceHandlerSpecification

java.lang.Object

io.cdap.cdap.api.AbstractProgramSpecification

io.cdap.cdap.api.service.http.HttpServiceHandlerSpecification

All Implemented Interfaces:

PropertyProvider, ProgramSpecification

public final class HttpServiceHandlerSpecification
extends AbstractProgramSpecification
implements PropertyProvider

Specification for a HttpServiceHandler.

Constructor Summary

Constructors

Constructor and Description
HttpServiceHandlerSpecification(String className, String name, String description, Map<String,String> properties, Set<String> datasets, List<ServiceHttpEndpoint> endpoints) Create an instance of HttpServiceHandlerSpecification.

Method Summary

Modifier and Type	Method and Description
Set<String>	getDatasets()
List<ServiceHttpEndpoint>	getEndpoints()
Map<String,String>	getProperties() Returns an immutable Map of all properties.
String	getProperty(String key) Return the property value of a given key.

Methods inherited from class io.cdap.cdap.api.AbstractProgramSpecification

getClassName, getDescription, getName, getPlugins

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServiceHandlerSpecification

public HttpServiceHandlerSpecification(String className,
                                       String name,
                                       String description,
                                       Map<String,String> properties,
                                       Set<String> datasets,
                                       List<ServiceHttpEndpoint> endpoints)

Create an instance of HttpServiceHandlerSpecification.

Method Detail

getProperties

public Map<String,String> getProperties()

Description copied from interface: PropertyProvider

Returns an immutable Map of all properties.

Specified by:

getProperties in interface PropertyProvider

Returns:

the properties

getProperty

public String getProperty(String key)

Description copied from interface: PropertyProvider

Return the property value of a given key.

Specified by:

getProperty in interface PropertyProvider

Parameters:

key - for getting specific property value

Returns:

the property value

getDatasets

public Set<String> getDatasets()

Returns:

An immutable set of Dataset names that are used by the HttpServiceHandler.

getEndpoints

public List<ServiceHttpEndpoint> getEndpoints()

Returns:

An immutable set of ServiceHttpEndpoints that are exposed by the HttpServiceHandler.