Package net.officefloor.vertx.sqlclient

Class VertxSqlPoolManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<None,None>

net.officefloor.vertx.sqlclient.VertxSqlPoolManagedObjectSource

All Implemented Interfaces:

ManagedObject, ManagedObjectSource<None,None>

public class VertxSqlPoolManagedObjectSource
extends AbstractManagedObjectSource<None,None>
implements ManagedObject

ManagedObjectSource for Vertx Pool.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_DATABASE	Property name for database.
static final String	PROPERTY_HOST	Property name for host.
static final String	PROPERTY_PASSWORD	Property name for password.
static final String	PROPERTY_PORT	Property name for port.
static final String	PROPERTY_USERNAME	Property name for username.

Constructor Summary

Constructors

Constructor	Description
VertxSqlPoolManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
Object	getObject()	Obtains the object being managed.
io.vertx.sqlclient.Pool	getPool()	Obtains the Pool.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	Overridden to load specifications.
void	stop()	Called to notify that the OfficeFloor is being closed.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROPERTY_HOST

public static final String PROPERTY_HOST

Property name for host.

See Also:

• Constant Field Values

PROPERTY_PORT

public static final String PROPERTY_PORT

Property name for port.

See Also:

• Constant Field Values

PROPERTY_DATABASE

public static final String PROPERTY_DATABASE

Property name for database.

See Also:

• Constant Field Values

PROPERTY_USERNAME

public static final String PROPERTY_USERNAME

Property name for username.

See Also:

• Constant Field Values

PROPERTY_PASSWORD

public static final String PROPERTY_PASSWORD

Property name for password.

See Also:

• Constant Field Values

Constructor Details

VertxSqlPoolManagedObjectSource

public VertxSqlPoolManagedObjectSource()

Method Details

getPool

public io.vertx.sqlclient.Pool getPool()

Obtains the Pool.

Returns:

Pool.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<None,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<None,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

stop

public void stop()

Description copied from interface: ManagedObjectSource

Called to notify that the OfficeFloor is being closed.

On return from this method, no further ProcessState instances may be invoked.

Specified by:

stop in interface ManagedObjectSource<None,None>

Overrides:

stop in class AbstractAsyncManagedObjectSource<None,None>

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<None,None>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.

getObject

public Object getObject()
                 throws Throwable

Description copied from interface: ManagedObject

Obtains the object being managed.

Specified by:

getObject in interface ManagedObject

Returns:

Object being managed.

Throws:

Throwable - Indicating failed to obtain the object for use.