org.rhq.cassandra.schema

Interface Step

All Known Implementing Classes:

CQLStep, PopulateCacheIndex

public interface Step

This corresponds to a step element in a schema update file. A <step> element can declare a class attribute which specifies the runtime type to use. The value must be the FQCN and must implement this interface. The default implementation is CQLStep which will be used when the class attribute is not declared.

Author:

John Sanda

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(Properties properties) Bind the set of provided properties to the input step.
void	execute() Perform the actual work of the step.
void	setSession(com.datastax.driver.core.Session session) Invoked prior to execute().

Method Detail

setSession

void setSession(com.datastax.driver.core.Session session)

Invoked prior to execute(). Note that this is the same session used by SchemaManager and it should not be closed.

bind

void bind(Properties properties)

Bind the set of provided properties to the input step. The text should have all the variable to be bound in %variable_name% form.

This method should be called even if no properties are provided because it will throw a runtime exception if the text contains properties that are expected to be bound but the list of variable is either empty or does not contain them.

This method is invoked prior to execute()

Parameters:

properties - properties to bind

execute

void execute()

Perform the actual work of the step.