com.espertech.esper.runtime.client

Interface EPDeploymentService

All Known Subinterfaces:

EPDeploymentServiceSPI

All Known Implementing Classes:

EPDeploymentServiceImpl

public interface EPDeploymentService

Service for deploying and undeploying modules and obtaining information about current deployments and statements.

Method Summary

Modifier and Type	Method and Description
void	addDeploymentStateListener(DeploymentStateListener listener) Add a deployment state listener
EPDeployment	deploy(com.espertech.esper.common.client.EPCompiled compiled) Deploy a compiled module and with the default options.
EPDeployment	deploy(com.espertech.esper.common.client.EPCompiled compiled, DeploymentOptions options) Deploy a compiled module and with the provided options.
EPDeployment	getDeployment(String deploymentId) Returns the deployment.
String[]	getDeployments() Returns the deployment ids of all deployments.
Iterator<DeploymentStateListener>	getDeploymentStateListeners() Returns an iterator of deployment state listeners (read-only)
EPStatement	getStatement(String deploymentId, String statementName) Returns the statement of a given deployment.
boolean	isDeployed(String deploymentId) Returns indicator whether a deployment for this deployment id exists
void	removeAllDeploymentStateListeners() Removes all deployment state listener
void	removeDeploymentStateListener(DeploymentStateListener listener) Remove a deployment state listener
void	undeploy(String deploymentId) Undeploy a deployment and with the default options.
void	undeploy(String deploymentId, UndeploymentOptions options) Undeploy a deployment and with the provided options
void	undeployAll() Undeploy all deployments and with the default options.
void	undeployAll(UndeploymentOptions options) Undeploy all deployments and with the provided options.

Method Detail

deploy

EPDeployment deploy(com.espertech.esper.common.client.EPCompiled compiled)
             throws EPDeployException

Deploy a compiled module and with the default options.

Parameters:

compiled - byte code

Returns:

deployment

Throws:

EPDeployException - when the deployment failed

deploy

EPDeployment deploy(com.espertech.esper.common.client.EPCompiled compiled,
                    DeploymentOptions options)
             throws EPDeployException

Deploy a compiled module and with the provided options.

Parameters:

compiled - byte code

options - deployment options

Returns:

deployment

Throws:

EPDeployException - when the deployment failed

getDeployments

String[] getDeployments()

Returns the deployment ids of all deployments.

Returns:

deployment ids

undeploy

void undeploy(String deploymentId)
       throws EPUndeployException

Undeploy a deployment and with the default options.

Parameters:

deploymentId - of the deployment to undeploy

Throws:

EPUndeployException - when the deployment does not exist or the undeployment failed and the deployment remains deployed

undeploy

void undeploy(String deploymentId,
              UndeploymentOptions options)
       throws EPUndeployException

Undeploy a deployment and with the provided options

Parameters:

deploymentId - of the deployment to undeploy

options - undeployment options

Throws:

EPUndeployException - when the deployment does not exist or the undeployment failed and the deployment remains deployed

undeployAll

void undeployAll()
          throws EPUndeployException

Undeploy all deployments and with the default options.

Throws:

EPUndeployException - when the undeployment failed, of the deployments may remain deployed

undeployAll

void undeployAll(UndeploymentOptions options)
          throws EPUndeployException

Undeploy all deployments and with the provided options.

Parameters:

options - undeployment options or null if none provided

Throws:

EPUndeployException - when the undeployment failed, of the deployments may remain deployed

getStatement

EPStatement getStatement(String deploymentId,
                         String statementName)

Returns the statement of a given deployment.

A statement is uniquely identified by the deployment id that deployed the statement and by the statement name.

Parameters:

deploymentId - deployment id of the statement

statementName - statement name

Returns:

statement or null if the statement could not be found

getDeployment

EPDeployment getDeployment(String deploymentId)

Returns the deployment.

A deployment is uniquely identified by its deployment id.

Parameters:

deploymentId - the deployment id of the deployment

Returns:

deployment or null if the deployment could not be found

addDeploymentStateListener

void addDeploymentStateListener(DeploymentStateListener listener)

Add a deployment state listener

Parameters:

listener - to add

removeDeploymentStateListener

void removeDeploymentStateListener(DeploymentStateListener listener)

Remove a deployment state listener

Parameters:

listener - to remove

getDeploymentStateListeners

Iterator<DeploymentStateListener> getDeploymentStateListeners()

Returns an iterator of deployment state listeners (read-only)

Returns:

listeners

removeAllDeploymentStateListeners

void removeAllDeploymentStateListeners()

Removes all deployment state listener

isDeployed

boolean isDeployed(String deploymentId)

Returns indicator whether a deployment for this deployment id exists

Parameters:

deploymentId - deployment id

Returns:

true for deployed, false for not deployed