org.jminor.framework.db.http

Class HttpEntityConnectionProvider

java.lang.Object

org.jminor.framework.db.AbstractEntityConnectionProvider<org.jminor.framework.db.http.HttpEntityConnection>

org.jminor.framework.db.http.HttpEntityConnectionProvider

All Implemented Interfaces:

EntityConnectionProvider<org.jminor.framework.db.http.HttpEntityConnection>

public final class HttpEntityConnectionProvider
extends AbstractEntityConnectionProvider<org.jminor.framework.db.http.HttpEntityConnection>

A class responsible for managing a HttpEntityConnection.

See Also:

HTTP_CLIENT_HOST_NAME, HTTP_CLIENT_PORT, HTTP_CLIENT_SECURE

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.String>	HTTP_CLIENT_HOST_NAME The host on which to locate the http server Value type: String Default value: localhost
static PropertyValue<java.lang.Integer>	HTTP_CLIENT_PORT The port which the http client should use. Value type: Integer Default value: 8080
static PropertyValue<java.lang.Boolean>	HTTP_CLIENT_SECURE Specifies whether https should be used. Value types: Boolean Default value: true

Fields inherited from class org.jminor.framework.db.AbstractEntityConnectionProvider

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
HttpEntityConnectionProvider() Instantiates a new HttpEntityConnectionProvider.
HttpEntityConnectionProvider(java.lang.String serverHostName, java.lang.Integer serverPort, java.lang.Boolean https) Instantiates a new HttpEntityConnectionProvider.

Method Summary

Modifier and Type	Method and Description
protected org.jminor.framework.db.http.HttpEntityConnection	connect()
protected void	disconnect(org.jminor.framework.db.http.HttpEntityConnection connection) Disconnects the given connection
java.lang.String	getConnectionType() Returns a String specifying the type of connection provided by this connection provider
java.lang.String	getDescription()
java.lang.String	getServerHostName()

Methods inherited from class org.jminor.framework.db.AbstractEntityConnectionProvider

addOnConnectListener, disconnect, getClientId, getClientTypeId, getClientVersion, getConnection, getDomain, getDomainClassName, getDomainId, getUser, isConnected, isConnectionValid, removeOnConnectListener, setClientId, setClientTypeId, setClientVersion, setDomainClassName, setUser

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_CLIENT_HOST_NAME

public static final PropertyValue<java.lang.String> HTTP_CLIENT_HOST_NAME

The host on which to locate the http server
Value type: String
Default value: localhost

HTTP_CLIENT_PORT

public static final PropertyValue<java.lang.Integer> HTTP_CLIENT_PORT

The port which the http client should use.
Value type: Integer
Default value: 8080

HTTP_CLIENT_SECURE

public static final PropertyValue<java.lang.Boolean> HTTP_CLIENT_SECURE

Specifies whether https should be used.
Value types: Boolean
Default value: true

Constructor Detail

HttpEntityConnectionProvider

public HttpEntityConnectionProvider()

Instantiates a new HttpEntityConnectionProvider.

HttpEntityConnectionProvider

public HttpEntityConnectionProvider(java.lang.String serverHostName,
                                    java.lang.Integer serverPort,
                                    java.lang.Boolean https)

Instantiates a new HttpEntityConnectionProvider.

Parameters:

serverHostName - the server host name

serverPort - the server port

https - true if https should be used

Method Detail

getConnectionType

public 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

public java.lang.String getDescription()

Returns:

a string describing the server connection

getServerHostName

public java.lang.String getServerHostName()

Returns:

the name of the host providing the connection

connect

protected org.jminor.framework.db.http.HttpEntityConnection connect()

Specified by:

connect in class AbstractEntityConnectionProvider<org.jminor.framework.db.http.HttpEntityConnection>

Returns:

an established connection

disconnect

protected void disconnect(org.jminor.framework.db.http.HttpEntityConnection connection)

Disconnects the given connection

Specified by:

disconnect in class AbstractEntityConnectionProvider<org.jminor.framework.db.http.HttpEntityConnection>

Parameters:

connection - the connection to be disconnected