org.jminor.framework.db

Interface EntityConnectionProvider<T extends EntityConnection>

Type Parameters:

T - the type of EntityConnection provided

All Known Implementing Classes:

AbstractEntityConnectionProvider, HttpEntityConnectionProvider, LocalEntityConnectionProvider, RemoteEntityConnectionProvider

public interface EntityConnectionProvider<T extends EntityConnection>

Specifies a class resposible for providing a single EntityConnection instance. getConnection() is guaranteed to return a healthy connection or throw an exception.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.String>	CLIENT_CONNECTION_TYPE Specifies whether the client should connect locally, remotely or via http, accepted values: local, remote, http Value type: String Default value: local
static PropertyValue<java.lang.String>	CLIENT_DOMAIN_CLASS Specifies the name of the domain model class required for a client connection. Value type: String Default value: null
static java.lang.String	CONNECTION_TYPE_HTTP Indicates a http database connection
static java.lang.String	CONNECTION_TYPE_LOCAL Indicates a local database connection
static java.lang.String	CONNECTION_TYPE_REMOTE Indicates a remote database connection

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
void	disconnect() Logs out, disconnects and performs cleanup if required
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
java.lang.String	getConnectionType() Returns a String specifying the type of connection provided by this connection provider
java.lang.String	getDescription()
Domain	getDomain() Returns the domain model this connection is based on
java.lang.String	getDomainClassName()
java.lang.String	getServerHostName()
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.

Field Detail

CONNECTION_TYPE_LOCAL

static final java.lang.String CONNECTION_TYPE_LOCAL

Indicates a local database connection

See Also:

CLIENT_CONNECTION_TYPE, Constant Field Values

CONNECTION_TYPE_REMOTE

static final java.lang.String CONNECTION_TYPE_REMOTE

Indicates a remote database connection

See Also:

CLIENT_CONNECTION_TYPE, Constant Field Values

CONNECTION_TYPE_HTTP

static final java.lang.String CONNECTION_TYPE_HTTP

Indicates a http database connection

See Also:

CLIENT_CONNECTION_TYPE, Constant Field Values

CLIENT_DOMAIN_CLASS

static final PropertyValue<java.lang.String> CLIENT_DOMAIN_CLASS

Specifies the name of the domain model class required for a client connection.
Value type: String
Default value: null

CLIENT_CONNECTION_TYPE

static final PropertyValue<java.lang.String> CLIENT_CONNECTION_TYPE

Specifies whether the client should connect locally, remotely or via http, accepted values: local, remote, http
Value type: String
Default value: local

See Also:

CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE, CONNECTION_TYPE_HTTP

Method Detail

getDomain

Domain getDomain()

Returns the domain model this connection is based on

Returns:

the underlying domain model

getConnection

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

Returns:

a EntityConnection instance

getConnectionType

java.lang.String getConnectionType()

Returns a String specifying the type of connection provided by this connection provider

Returns:

a String specifying the type of connection, e.g. "local" or "remote"

getDescription

java.lang.String getDescription()

Returns:

a short description of the database provider

getServerHostName

java.lang.String getServerHostName()

Returns:

the name of the host providing the connection

isConnected

boolean isConnected()

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:

isConnectionValid()

isConnectionValid

boolean isConnectionValid()

Returns:

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

addOnConnectListener

void addOnConnectListener(EventListener listener)

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

Parameters:

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

removeOnConnectListener

void removeOnConnectListener(EventListener listener)

Removes the given listener

Parameters:

listener - the listener to remove

disconnect

void disconnect()

Logs out, disconnects and performs cleanup if required

setUser

EntityConnectionProvider setUser(User user)

Disconnects the underlying connection if connected.

Parameters:

user - the user

Returns:

this EntityConnectionProvider instance

getUser

User getUser()

Returns:

the user used by this connection provider

setDomainClassName

EntityConnectionProvider setDomainClassName(java.lang.String domainClassName)

Disconnects the underlying connection if connected.

Parameters:

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

Returns:

this EntityConnectionProvider instance

Throws:

java.lang.IllegalArgumentException - in case domainClassName is null

getDomainClassName

java.lang.String getDomainClassName()

Returns:

the domain model classname

setClientId

EntityConnectionProvider setClientId(java.util.UUID clientId)

Disconnects the underlying connection if connected.

Parameters:

clientId - the UUID identifying this client connection

Returns:

this EntityConnectionProvider instance

Throws:

java.lang.IllegalArgumentException - in case clientId is null

getClientId

java.util.UUID getClientId()

Returns:

the UUID identifying this client connection

setClientTypeId

EntityConnectionProvider setClientTypeId(java.lang.String clientTypeId)

Disconnects the underlying connection if connected.

Parameters:

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

Returns:

this EntityConnectionProvider instance

getClientTypeId

java.lang.String getClientTypeId()

Returns:

the String identifying the client type for this connection provider

setClientVersion

EntityConnectionProvider setClientVersion(Version clientVersion)

Parameters:

clientVersion - the client version

Returns:

this EntityConnectionProvider instance

getClientVersion

Version getClientVersion()

Returns:

the client version