Package org.apache.fluo.api.client

Interface FluoAdmin

All Superinterfaces:

AutoCloseable

public interface FluoAdmin
extends AutoCloseable

Provides methods for initializing and administering a Fluo application.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FluoAdmin.AlreadyInitializedException	Exception that is thrown if Fluo application was already initialized.
static class	FluoAdmin.InitializationOptions	Specifies destructive Fluo initialization options that can not be set using FluoConfiguration.
static class	FluoAdmin.TableExistsException	Exception that is thrown if Accumulo table (set by fluo.admin.accumulo.table) exists during initialization.

Method Summary

Modifier and Type	Method	Description
void	close()
SimpleConfiguration	getApplicationConfig()
SimpleConfiguration	getConnectionConfig()
void	initialize(FluoAdmin.InitializationOptions opts)	Initializes Fluo application and stores shared configuration in Zookeeper.
void	remove()	Removes Fluo application, Accumulo table and shared configuration in Zookeeper.
void	updateSharedConfig()	Updates shared configuration in Zookeeper.

Method Detail

initialize

void initialize(FluoAdmin.InitializationOptions opts)
         throws FluoAdmin.AlreadyInitializedException,
                FluoAdmin.TableExistsException

Initializes Fluo application and stores shared configuration in Zookeeper. Shared configuration consists of all properties except those with "fluo.connection" prefix. Throws FluoAdmin.AlreadyInitializedException if Fluo application was already initialized in Zookeeper. If you want to initialize Zookeeper again, set FluoAdmin.InitializationOptions.setClearZookeeper(boolean) to true. Throws FluoAdmin.TableExistsException if Accumulo table exists. If you want to clear table, set FluoAdmin.InitializationOptions.setClearTable(boolean) to true.

Throws:

FluoAdmin.AlreadyInitializedException

FluoAdmin.TableExistsException

remove

void remove()

Removes Fluo application, Accumulo table and shared configuration in Zookeeper. Shared configuration consists of all properties except those with "fluo.connection" prefix.

Since:

1.2.0

updateSharedConfig

void updateSharedConfig()

Updates shared configuration in Zookeeper. Shared configuration consists of all properties except those with "fluo.connection" prefix. This method is called if a user has previously called initialize(InitializationOptions) but wants changes to shared configuration updated in Zookeeper.

During this method Observers are reinitialized using configuration passed to FluoAdmin and not existing shared configuration stored in zookeeper. So make sure all config needed by observers is present.

getConnectionConfig

SimpleConfiguration getConnectionConfig()

Returns:

SimpleConfiguration containing connection-specific configuration passed to FluoFactory

Since:

1.2.0

getApplicationConfig

SimpleConfiguration getApplicationConfig()

Returns:

SimpleConfiguration containing application-specific configuration stored in Zookeeper

Since:

1.2.0

close

void close()

Specified by:

close in interface AutoCloseable