Module is.codion.framework.db.http
Package is.codion.framework.db.http
Interface HttpEntityConnectionProvider
-
- All Superinterfaces:
AutoCloseable
,EntityConnectionProvider
public interface HttpEntityConnectionProvider extends EntityConnectionProvider
A class responsible for managing a HttpEntityConnection.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
HttpEntityConnectionProvider.Builder
Builds aHttpEntityConnectionProvider
instance.
-
Field Summary
Fields Modifier and Type Field Description static PropertyValue<String>
HTTP_CLIENT_HOST_NAME
The host on which to locate the http server
Value type: String
Default value: localhoststatic PropertyValue<Boolean>
HTTP_CLIENT_JSON
Specifies whether json serialization should be used.
Value types: Boolean
Default value: truestatic PropertyValue<Integer>
HTTP_CLIENT_PORT
The port which the http client should use.
Value type: Integer
Default value: 8080static PropertyValue<Boolean>
HTTP_CLIENT_SECURE
Specifies whether https should be used.
Value type: boolean
Default value: true-
Fields inherited from interface is.codion.framework.db.EntityConnectionProvider
CLIENT_CONNECTION_TYPE, CLIENT_DOMAIN_CLASS, CONNECTION_TYPE_HTTP, CONNECTION_TYPE_LOCAL, CONNECTION_TYPE_REMOTE
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static HttpEntityConnectionProvider.Builder
builder()
Instantiates a new builder instance.String
serverHostName()
-
Methods inherited from interface is.codion.framework.db.EntityConnectionProvider
addOnConnectListener, clientId, clientTypeId, clientVersion, close, connection, connectionType, description, domainClassName, entities, isConnected, isConnectionValid, removeOnConnectListener, user
-
-
-
-
Field Detail
-
HTTP_CLIENT_HOST_NAME
static final PropertyValue<String> HTTP_CLIENT_HOST_NAME
The host on which to locate the http server
Value type: String
Default value: localhost
-
HTTP_CLIENT_PORT
static final PropertyValue<Integer> HTTP_CLIENT_PORT
The port which the http client should use.
Value type: Integer
Default value: 8080
-
HTTP_CLIENT_SECURE
static final PropertyValue<Boolean> HTTP_CLIENT_SECURE
Specifies whether https should be used.
Value type: boolean
Default value: true
-
HTTP_CLIENT_JSON
static final PropertyValue<Boolean> HTTP_CLIENT_JSON
Specifies whether json serialization should be used.
Value types: Boolean
Default value: true
-
-
Method Detail
-
serverHostName
String serverHostName()
- Returns:
- the name of the host of the server providing the connection
-
builder
static HttpEntityConnectionProvider.Builder builder()
Instantiates a new builder instance.- Returns:
- a new builder
- See Also:
EntityConnectionProvider.CLIENT_CONNECTION_TYPE
-
-