com.espertech.esper.runtime.client.stage

Interface EPStage

public interface EPStage

A stage allows staging and unstageing deployments, allowing independent control over event and time for the deployments.

This API is under development for version 8.4 and newer, and is considered UNSTABLE.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the stage.
EPStageDeploymentService	getDeploymentService() Returns the stage's deployment service that provides information about staged deployments.
EPStageEventService	getEventService() Returns the stage's event service that can be used to send events to the stage and to advance time for the stage.
java.lang.String	getURI() Returns the stage unique identifier URI.
void	stage(java.util.Collection<java.lang.String> deploymentIds) Stage deployments.
void	unstage(java.util.Collection<java.lang.String> deploymentIds) Un-stage deployments.

Method Detail

stage

void stage(java.util.Collection<java.lang.String> deploymentIds)
    throws EPStageException,
           EPStageDestroyedException

Stage deployments.

This effectively removes the deployment from the runtime and adds it to the stage's deployments. The deployment can be obtained from EPStageDeploymentService and can no longer be obtained from EPRuntime.getDeploymentService().

The staged deployments only receive events that the application sends using the EPStageEventService for this stage. The staged deployments only advance time according to the application advancing time using the EPStageEventService for this stage.

The staged deployments no longer receive events that the application sends into the runtime EPRuntime.getEventService(). The staged deployments no longer advance time according to time advancing for the runtime EPRuntime.getEventService().

Requires that dependent public or protected (not preconfigured) EPL objects are also getting staged.

Parameters:

deploymentIds - deployment ids of deployments to stage

Throws:

EPStageException - if preconditions validation fails or a deployment does not exist

EPStageDestroyedException - if the stage is already destroyed

unstage

void unstage(java.util.Collection<java.lang.String> deploymentIds)
      throws EPStageException,
             EPStageDestroyedException

Un-stage deployments.

This effectively removes the deployment from the stage and adds it to the runtime deployments. The deployment can be obtained from EPRuntime.getDeploymentService() and can no longer be obtained from EPStageDeploymentService.

The un-staged deployments only receive events that the application sends using the runtime EPRuntime.getEventService(). The un-staged deployments only advance time according to the application advancing time using the runtime EPRuntime.getEventService().

The staged deployments no longer receive events that the application sends into the EPStageEventService for this stage. The staged deployments no longer advance time according to time advancing for the EPStageEventService for this stage.

Requires that dependent public or protected (not preconfigured) EPL objects are also getting un-staged.

Parameters:

deploymentIds - deployment ids of deployments to un-stage

Throws:

EPStageException - if preconditions validation fails or a deployment does not exist

EPStageDestroyedException - if the stage is already destroyed

getDeploymentService

EPStageDeploymentService getDeploymentService()
                                       throws EPStageDestroyedException

Returns the stage's deployment service that provides information about staged deployments.

Returns:

stage deployment service

Throws:

EPStageDestroyedException - if the stage is already destroyed

getEventService

EPStageEventService getEventService()
                             throws EPStageDestroyedException

Returns the stage's event service that can be used to send events to the stage and to advance time for the stage.

Returns:

stage event service

Throws:

EPStageDestroyedException - if the stage is already destroyed

destroy

void destroy()
      throws EPException

Destroy the stage.

Requires that any deployments are un-staged.

Throws:

EPException - when the destroy operation fails

getURI

java.lang.String getURI()

Returns the stage unique identifier URI.

Returns:

uri