io.cdap.cdap.api.service.http

Class AbstractHttpServiceHandler<T extends HttpServiceContext,V extends HttpServiceConfigurer>

java.lang.Object

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

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

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<T,V>

Type Parameters:

T - type of service context

V - type of service configurer

All Implemented Interfaces:

ProgramLifecycle<T>, HttpServiceHandler<T,V>

Direct Known Subclasses:

AbstractCubeHttpHandler

public abstract class AbstractHttpServiceHandler<T extends HttpServiceContext,V extends HttpServiceConfigurer>
extends AbstractPluginConfigurable<V>
implements HttpServiceHandler<T,V>

An abstract implementation of HttpServiceHandler. Classes that extend this class only have to implement a configure method which can be used to add optional arguments.

Constructor Summary

Constructors

Constructor and Description
AbstractHttpServiceHandler()

Method Summary

Modifier and Type	Method and Description
protected void	configure() This can be overridden in child classes to add custom user properties during configure time.
void	configure(V configurer) An implementation of HttpServiceHandler.configure(HttpServiceConfigurer).
void	destroy() An implementation of HttpServiceHandler.destroy() which does nothing
protected V	getConfigurer()
protected T	getContext()
void	initialize(T context) An implementation of HttpServiceHandler.initialize(HttpServiceContext).
protected void	setProperties(Map<String,String> properties)

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

AbstractHttpServiceHandler

public AbstractHttpServiceHandler()

Method Detail

configure

protected void configure()

This can be overridden in child classes to add custom user properties during configure time.

configure

public final void configure(V configurer)

An implementation of HttpServiceHandler.configure(HttpServiceConfigurer). Stores the configurer so that it can be used later and then runs the configure method which is overwritten by children classes.

Specified by:

configure in interface HttpServiceHandler<T extends HttpServiceContext,V extends HttpServiceConfigurer>

Parameters:

configurer - the HttpServiceConfigurer which is used to configure this Handler

initialize

public void initialize(T context)
                throws Exception

An implementation of HttpServiceHandler.initialize(HttpServiceContext). Stores the context so that it can be used later.

Specified by:

initialize in interface ProgramLifecycle<T extends HttpServiceContext>

Specified by:

initialize in interface HttpServiceHandler<T extends HttpServiceContext,V extends HttpServiceConfigurer>

Parameters:

context - the HTTP service runtime context

Throws:

Exception - If there is any error during initialization.

destroy

public void destroy()

An implementation of HttpServiceHandler.destroy() which does nothing

Specified by:

destroy in interface ProgramLifecycle<T extends HttpServiceContext>

Specified by:

destroy in interface HttpServiceHandler<T extends HttpServiceContext,V extends HttpServiceConfigurer>

getContext

protected final T getContext()

Returns:

the HttpServiceContext which was used when this class was initialized

getConfigurer

protected final V getConfigurer()

Specified by:

getConfigurer in class AbstractPluginConfigurable<V extends HttpServiceConfigurer>

Returns:

the HttpServiceConfigurer used to configure this class

setProperties

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

Parameters:

properties - the properties to set

See Also:

HttpServiceConfigurer.setProperties(java.util.Map)