com.atlassian.activeobjects.external

Interface ActiveObjectsModuleMetaData

All Known Implementing Classes:

AbstractActiveObjectsMetaData

public interface ActiveObjectsModuleMetaData

This interface provides information about the state of the active objects module itself, in the context of the current data source.

Since:

0.24

Method Summary

Modifier and Type	Method and Description
void	awaitInitialization() Awaits initialization of the ActiveObjects model,this method will block until the active objects schema has been initialized for the current data source.
void	awaitInitialization(long timeout, TimeUnit unit) See awaitInitialization()
DatabaseType	getDatabaseType()
boolean	isDataSourcePresent() Indicates whether there is a data source (i.e.
boolean	isInitialized() Indicates if initialization has completed successfully.
boolean	isTablePresent(Class<? extends net.java.ao.RawEntity<?>> type) Checks if the table corresponding to given type exists in the database.

Method Detail

awaitInitialization

void awaitInitialization()
                  throws ExecutionException,
                         InterruptedException

Awaits initialization of the ActiveObjects model,this method will block until the active objects schema has been initialized for the current data source.

This method cannot be called from within an UpgradeTask

Blocks indefinitely.

Throws:

NoDataSourceException

ExecutionException

InterruptedException

awaitInitialization

void awaitInitialization(long timeout,
                         TimeUnit unit)
                  throws InterruptedException,
                         ExecutionException,
                         TimeoutException

See awaitInitialization()

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

InterruptedException

ExecutionException

TimeoutException

Since:

0.26

isInitialized

boolean isInitialized()

Indicates if initialization has completed successfully. If this returns true a call to awaitInitialization will return immediately and won't throw an exception, providing a tenant is present.

Returns:

true if initialized, false otherwise

getDatabaseType

DatabaseType getDatabaseType()

Returns:

the configured database type that active objects is using

Throws:

NoDataSourceException

isDataSourcePresent

boolean isDataSourcePresent()

Indicates whether there is a data source (i.e. a tenant) present. If this returns true, calls to awaitInitialization(), awaitInitialization(long, java.util.concurrent.TimeUnit) and getDatabaseType() will not throw a NoDataSourceException

Since:

0.26

isTablePresent

boolean isTablePresent(Class<? extends net.java.ao.RawEntity<?>> type)

Checks if the table corresponding to given type exists in the database.

Parameters:

type - to check against

Returns:

true if the table exists, false otherwise

Since:

1.2.1