org.jminor.framework.db

Class AbstractEntityConnectionProvider<T extends EntityConnection>

java.lang.Object

org.jminor.framework.db.AbstractEntityConnectionProvider<T>

Type Parameters:

T - the EntityConnection implementation provided by this connection provider

All Implemented Interfaces:

EntityConnectionProvider<T>

Direct Known Subclasses:

HttpEntityConnectionProvider, LocalEntityConnectionProvider, RemoteEntityConnectionProvider

public abstract class AbstractEntityConnectionProvider<T extends EntityConnection>
extends java.lang.Object
implements EntityConnectionProvider<T>

An abstract EntityConnectionProvider implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	IS_CONNECTED

Fields inherited from interface org.jminor.framework.db.EntityConnectionProvider

CLIENT_CONNECTION_TYPE, CLIENT_DOMAIN_CLASS, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE

Constructor Summary

Constructors

Constructor and Description
AbstractEntityConnectionProvider()

Method Summary

Modifier and Type	Method and Description
void	addOnConnectListener(EventListener listener) Adds a listener notified each time this connection provider establishes a connection to the database
protected abstract T	connect()
void	disconnect() Logs out, disconnects and performs cleanup if required
protected abstract void	disconnect(T connection) Disconnects the given connection
java.util.UUID	getClientId()
java.lang.String	getClientTypeId()
Version	getClientVersion()
T	getConnection() Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally
Domain	getDomain() Returns the domain model this connection is based on
java.lang.String	getDomainClassName()
protected static java.lang.String	getDomainId(java.lang.String domainClass)
User	getUser()
boolean	isConnected()
boolean	isConnectionValid()
void	removeOnConnectListener(EventListener listener) Removes the given listener
EntityConnectionProvider	setClientId(java.util.UUID clientId) Disconnects the underlying connection if connected.
EntityConnectionProvider	setClientTypeId(java.lang.String clientTypeId) Disconnects the underlying connection if connected.
EntityConnectionProvider	setClientVersion(Version clientVersion)
EntityConnectionProvider	setDomainClassName(java.lang.String domainClassName) Disconnects the underlying connection if connected.
EntityConnectionProvider	setUser(User user) Disconnects the underlying connection if connected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.framework.db.EntityConnectionProvider

getConnectionType, getDescription, getServerHostName

Field Detail

IS_CONNECTED

protected static final java.lang.String IS_CONNECTED

See Also:

Constant Field Values

Constructor Detail

AbstractEntityConnectionProvider

public AbstractEntityConnectionProvider()

Method Detail

getDomain

public final Domain getDomain()

Returns the domain model this connection is based on

Specified by:

getDomain in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the underlying domain model

getUser

public final User getUser()

Specified by:

getUser in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the user used by this connection provider

setUser

public final EntityConnectionProvider setUser(User user)

Disconnects the underlying connection if connected.

Specified by:

setUser in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

user - the user

Returns:

this EntityConnectionProvider instance

getDomainClassName

public final java.lang.String getDomainClassName()

Specified by:

getDomainClassName in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the domain model classname

setDomainClassName

public final EntityConnectionProvider setDomainClassName(java.lang.String domainClassName)

Disconnects the underlying connection if connected.

Specified by:

setDomainClassName in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

domainClassName - the name of the class specifying the domain model for this connection provider

Returns:

this EntityConnectionProvider instance

getClientId

public final java.util.UUID getClientId()

Specified by:

getClientId in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the UUID identifying this client connection

setClientId

public final EntityConnectionProvider setClientId(java.util.UUID clientId)

Disconnects the underlying connection if connected.

Specified by:

setClientId in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

clientId - the UUID identifying this client connection

Returns:

this EntityConnectionProvider instance

getClientTypeId

public final java.lang.String getClientTypeId()

Specified by:

getClientTypeId in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the String identifying the client type for this connection provider

setClientTypeId

public final EntityConnectionProvider setClientTypeId(java.lang.String clientTypeId)

Disconnects the underlying connection if connected.

Specified by:

setClientTypeId in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

clientTypeId - a String identifying the client type for this connection provider

Returns:

this EntityConnectionProvider instance

getClientVersion

public final Version getClientVersion()

Specified by:

getClientVersion in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

the client version

setClientVersion

public final EntityConnectionProvider setClientVersion(Version clientVersion)

Specified by:

setClientVersion in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

clientVersion - the client version

Returns:

this EntityConnectionProvider instance

isConnected

public final boolean isConnected()

Specified by:

isConnected in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

true if a connection has been established, note that this does not check if the actual connection is valid, only that one has been established.

See Also:

EntityConnectionProvider.isConnectionValid()

isConnectionValid

public final boolean isConnectionValid()

Specified by:

isConnectionValid in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

true if a connection has been establised and the connection is in a valid state

addOnConnectListener

public void addOnConnectListener(EventListener listener)

Adds a listener notified each time this connection provider establishes a connection to the database

Specified by:

addOnConnectListener in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

listener - a listener notified each time the underlying connection is connected

removeOnConnectListener

public void removeOnConnectListener(EventListener listener)

Removes the given listener

Specified by:

removeOnConnectListener in interface EntityConnectionProvider<T extends EntityConnection>

Parameters:

listener - the listener to remove

getConnection

public final T getConnection()

Provides a EntityConnection object, is responsible for returning a healthy EntityConnection object, that is, it must reconnect an invalid connection whether remotely or locally

Specified by:

getConnection in interface EntityConnectionProvider<T extends EntityConnection>

Returns:

a EntityConnection instance

disconnect

public final void disconnect()

Logs out, disconnects and performs cleanup if required

Specified by:

disconnect in interface EntityConnectionProvider<T extends EntityConnection>

connect

protected abstract T connect()

Returns:

an established connection

disconnect

protected abstract void disconnect(T connection)

Disconnects the given connection

Parameters:

connection - the connection to be disconnected

getDomainId

protected static java.lang.String getDomainId(java.lang.String domainClass)