Top Description Inners Methods
com.mysql.cj.xdevapi

public Interface Client

extends AutoCloseable
Known Direct Implementers
com.mysql.cj.xdevapi.ClientImpl
X DevAPI class encapsulating a Session pooling functionality.

The Client object is obtained via ClientFactory#getClient(String, java.util.Properties) or ClientFactory#getClient(String, String) methods.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Client.ClientProperty

Method Summary

Modifier and TypeMethod and Description
public void
close()

Redeclares java.lang.AutoCloseable.close.

Close Client.

public Session

Returns:

Session
getSession()

Get Session from pool or the new one.

Method Detail

closeback to summary
public void close()

Redeclares java.lang.AutoCloseable.close.

Close Client. Closes all Sessions it has created, and destroys the managed pool.

Calling the method close on a Client object that is already closed is a no-op.

Annotations
@Override
getSessionback to summary
public Session getSession()

Get Session from pool or the new one.

Returns:Session

Session

com.mysql.cj.xdevapi back to summary

public final Enum Client.ClientProperty

extends Enum<Client.ClientProperty>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private String
keyName

public static final Client.ClientProperty
POOLING_ENABLED

public static final Client.ClientProperty
POOLING_MAX_IDLE_TIME

public static final Client.ClientProperty
POOLING_MAX_SIZE

public static final Client.ClientProperty
POOLING_QUEUE_TIMEOUT

Constructor Summary

AccessConstructor and Description
private
ClientProperty(String keyName)

Method Summary

Modifier and TypeMethod and Description
public String
getKeyName()

public static Client.ClientProperty
valueOf(String name)

public static Client.ClientProperty[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

keyNameback to summary
private String keyName
POOLING_ENABLEDback to summary
public static final Client.ClientProperty POOLING_ENABLED
POOLING_MAX_IDLE_TIMEback to summary
public static final Client.ClientProperty POOLING_MAX_IDLE_TIME
POOLING_MAX_SIZEback to summary
public static final Client.ClientProperty POOLING_MAX_SIZE
POOLING_QUEUE_TIMEOUTback to summary
public static final Client.ClientProperty POOLING_QUEUE_TIMEOUT

Constructor Detail

ClientPropertyback to summary
private ClientProperty(String keyName)

Method Detail

getKeyNameback to summary
public String getKeyName()
valueOfback to summary
public static Client.ClientProperty valueOf(String name)
valuesback to summary
public static Client.ClientProperty[] values()