io.cdap.cdap.api.service.http

Interface HttpServiceContext

All Superinterfaces:

ArtifactManager, DatasetContext, FeatureFlagsProvider, MessagingContext, MetadataReader, MetadataWriter, PluginContext, RuntimeContext, SecureStore, ServiceDiscoverer, Transactional

public interface HttpServiceContext
extends RuntimeContext, DatasetContext, ServiceDiscoverer, MessagingContext, PluginContext, SecureStore, Transactional, ArtifactManager, MetadataReader, MetadataWriter

The context for a HttpServiceHandler. Currently contains methods to receive the HttpServiceHandlerSpecification and the runtime arguments passed by the user.

Method Summary

Modifier and Type	Method and Description
PluginConfigurer	createPluginConfigurer() Deprecated. use createServicePluginConfigurer() instead
PluginConfigurer	createPluginConfigurer(String namespace) Deprecated. use createServicePluginConfigurer(String) instead
ServicePluginConfigurer	createServicePluginConfigurer() Create a ServicePluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time.
ServicePluginConfigurer	createServicePluginConfigurer(String namespace) Create a ServicePluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time.
int	getInstanceCount()
int	getInstanceId()
HttpServiceHandlerSpecification	getSpecification()

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

getAdmin, getApplicationSpecification, getClusterName, getDataTracer, getNamespace, getRunId, getRuntimeArguments

Methods inherited from interface io.cdap.cdap.api.data.DatasetContext

discardDataset, getDataset, getDataset, getDataset, getDataset, releaseDataset

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

getServiceURL, getServiceURL, getServiceURL, openConnection

Methods inherited from interface io.cdap.cdap.api.messaging.MessagingContext

getDirectMessagePublisher, getMessageFetcher, getMessagePublisher

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

getPluginProperties, getPluginProperties, loadPluginClass, newPluginInstance, newPluginInstance

Methods inherited from interface io.cdap.cdap.api.feature.FeatureFlagsProvider

isFeatureEnabled

Methods inherited from interface io.cdap.cdap.api.security.store.SecureStore

get, getData, getMetadata, list

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

execute, execute

Methods inherited from interface io.cdap.cdap.api.artifact.ArtifactManager

createClassLoader, createClassLoader, listArtifacts, listArtifacts

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataReader

getMetadata, getMetadata

Methods inherited from interface io.cdap.cdap.api.metadata.MetadataWriter

addProperties, addTags, addTags, removeMetadata, removeProperties, removeProperties, removeTags, removeTags

Method Detail

getSpecification

HttpServiceHandlerSpecification getSpecification()

Returns:

the specification bound to this HttpServiceContext

getInstanceCount

int getInstanceCount()

Returns:

number of instances of this handler.

getInstanceId

int getInstanceId()

Returns:

instance id of this handler.

createPluginConfigurer

@Deprecated
PluginConfigurer createPluginConfigurer()

Deprecated. use createServicePluginConfigurer() instead

Create a PluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time. Plugins registered by the dynamic configurer live in their own scope and will not conflict with any plugins that were registered by the service when it was configured. Plugins registered by the returned configurer will also not be available through PluginContext.newPluginInstance(String) or PluginContext.newPluginInstance(String, MacroEvaluator). Plugins with system scope and plugins in the same namespace as the running service will be visible. The dynamic configurer is meant to be used to create plugins for the lifetime of a single service call and then to be forgotten.

Returns:

an dynamic plugin configurer that must be closed

createPluginConfigurer

@Deprecated
PluginConfigurer createPluginConfigurer(String namespace)

Deprecated. use createServicePluginConfigurer(String) instead

Create a PluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time. Plugins registered by the dynamic configurer live in their own scope and will not conflict with any plugins that were registered by the service when it was configured. Plugins registered by the returned configurer will also not be available through PluginContext.newPluginInstance(String) or PluginContext.newPluginInstance(String, MacroEvaluator). Plugins with system scope and plugins in the specified namespace will be visible. The dynamic configurer is meant to be used to create plugins for the lifetime of a single service call and then to be forgotten.

Parameters:

namespace - the namespace for user scoped plugins

Returns:

an dynamic plugin configurer that must be closed

createServicePluginConfigurer

ServicePluginConfigurer createServicePluginConfigurer()

Create a ServicePluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time. Plugins registered by the dynamic configurer live in their own scope and will not conflict with any plugins that were registered by the service when it was configured. Plugins registered by the returned configurer will also not be available through PluginContext.newPluginInstance(String) or PluginContext.newPluginInstance(String, MacroEvaluator). Plugins with system scope and plugins in the same namespace as the running service will be visible. The dynamic configurer is meant to be used to create plugins for the lifetime of a single service call and then to be forgotten.

Returns:

an dynamic plugin configurer that must be closed

createServicePluginConfigurer

ServicePluginConfigurer createServicePluginConfigurer(String namespace)

Create a ServicePluginConfigurer that can be used to instantiate plugins at runtime that were not registered at configure time. Plugins registered by the dynamic configurer live in their own scope and will not conflict with any plugins that were registered by the service when it was configured. Plugins registered by the returned configurer will also not be available through PluginContext.newPluginInstance(String) or PluginContext.newPluginInstance(String, MacroEvaluator). Plugins with system scope and plugins in the same namespace as the running service will be visible. The dynamic configurer is meant to be used to create plugins for the lifetime of a single service call and then to be forgotten.

Parameters:

namespace - the namespace for user scoped plugins

Returns:

an dynamic plugin configurer that must be closed