EclipseLink Core 4.0.2 · org.eclipse.persistence.sessions.server.Server

Method Summary

Modifier and Type	Method and Description
public ClientSession	acquireClientSession() PUBLIC: Return a client session for this server session.
public ClientSession	acquireClientSession(String poolName) PUBLIC: Return a client session for this server session.
public ClientSession	acquireClientSession(Login login) PUBLIC: Return a client session for this server session.
public ClientSession	acquireClientSession(ConnectionPolicy connectionPolicy) PUBLIC: Return a client session for this server session.
public void	addConnectionPool(String poolName, Login login, int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Add the connection pool.
public void	addConnectionPool(ConnectionPool pool) PUBLIC: Connection are pooled to share and restrict the number of database connections.
public ConnectionPool	getConnectionPool(String poolName) PUBLIC: Return the pool by name.
public ConnectionPolicy	getDefaultConnectionPolicy() PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol.
public ConnectionPool	getDefaultConnectionPool() PUBLIC: Return the default connection pool.
public int	getMaxNumberOfNonPooledConnections() PUBLIC: Return the number of non-pooled database connections allowed.
public ConnectionPool	getReadConnectionPool() PUBLIC: Handles allocating connections for read queries.
public void	setDatasourceLogin(Login login) Redeclares org.eclipse.persistence.sessions.DatabaseSession.setDatasourceLogin. PUBLIC: Set the login.
public void	setDefaultConnectionPolicy(ConnectionPolicy defaultConnectionPolicy) PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol.
public void	setMaxNumberOfNonPooledConnections(int maxNumberOfNonPooledConnections) PUBLIC: Set the number of non-pooled database connections allowed.
public void	setReadConnectionPool(ConnectionPool readConnectionPool) PUBLIC: Sets the read connection pool directly.
public void	useExclusiveReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate exclusive `ConnectionPool` with the minimum and maximum number of connections.
public void	useExclusiveReadConnectionPool(int initialNumberOfConnections, int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate exclusive `ConnectionPool` with the initial, minimum and maximum number of connections.
public void	useExternalReadConnectionPool() PUBLIC: Sets the read connection pool to be an `ExternalConnectionPool`.
public void	useReadConnectionPool(int minNumberOfConnections, int As multiple readers can use the same connection concurrently fewer connections are needed. maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate shared `ConnectionPool` with the minimum and maximum number of connections.
public void	useReadConnectionPool(int connections connected at startup initialNumberOfConnections, int connections that are pooled minNumberOfConnections, int As multiple readers can use the same connection concurrently fewer connections are needed. maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate shared `ConnectionPool` with the minimum and maximum number of connections.

Method Detail

acquireClientSession	back to summary
public ClientSession acquireClientSession() throws DatabaseException PUBLIC: Return a client session for this server session. Each user/client connected to this server session must acquire there own client session to communicate to the server through. This method allows for a client session to be acquired sharing the same login as the server session.

acquireClientSession	back to summary
public ClientSession acquireClientSession(String poolName) PUBLIC: Return a client session for this server session. Each user/client connected to this server session must acquire there own client session to communicate to the server through. This method allows for a client session to be acquired sharing its connection from a pool of connection allocated on the server session. By default this uses a lazy connection policy.

acquireClientSession

back to summary

public ClientSession acquireClientSession(String poolName)

PUBLIC: Return a client session for this server session. Each user/client connected to this server session must acquire there own client session to communicate to the server through. This method allows for a client session to be acquired sharing its connection from a pool of connection allocated on the server session. By default this uses a lazy connection policy.

acquireClientSession	back to summary
public ClientSession acquireClientSession(Login login) PUBLIC: Return a client session for this server session. Each user/client connected to this server session must acquire there own client session to communicate to the server through. The client must provide its own login to use, and the client session returned will have its own exclusive database connection. This connection will be used to perform all database modification for all units of work acquired from the client session. By default this does not use a lazy connection policy.

acquireClientSession

back to summary

public ClientSession acquireClientSession(Login login)

PUBLIC: Return a client session for this server session. Each user/client connected to this server session must acquire there own client session to communicate to the server through. The client must provide its own login to use, and the client session returned will have its own exclusive database connection. This connection will be used to perform all database modification for all units of work acquired from the client session. By default this does not use a lazy connection policy.

acquireClientSession	back to summary
public ClientSession acquireClientSession(ConnectionPolicy connectionPolicy) PUBLIC: Return a client session for this server session. The connection policy specifies how the client session's connection will be acquired.

addConnectionPool	back to summary
public void addConnectionPool(String poolName, Login login, int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Add the connection pool. Connections are pooled to share and restrict the number of database connections.

addConnectionPool	back to summary
public void addConnectionPool(ConnectionPool pool) PUBLIC: Connection are pooled to share and restrict the number of database connections.

getConnectionPool	back to summary
public ConnectionPool getConnectionPool(String poolName) PUBLIC: Return the pool by name.

getDefaultConnectionPolicy	back to summary
public ConnectionPolicy getDefaultConnectionPolicy() PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol. By default it uses the default connection pool.

getDefaultConnectionPool	back to summary
public ConnectionPool getDefaultConnectionPool() PUBLIC: Return the default connection pool.

getMaxNumberOfNonPooledConnections	back to summary
public int getMaxNumberOfNonPooledConnections() PUBLIC: Return the number of non-pooled database connections allowed. This can be enforced to make up for the resource limitation of most JDBC drivers and database clients. By default this is 50.

getReadConnectionPool back to summary

getReadConnectionPool	back to summary
public ConnectionPool getReadConnectionPool() PUBLIC: Handles allocating connections for read queries. By default a read connection pool is not used, the default connection pool is used for reading. The read connection pool is not used while in transaction. See Also `setReadConnectionPool(ConnectionPool)`, `useExclusiveReadConnectionPool`, `useExternalReadConnectionPool`, `useReadConnectionPool`

public ConnectionPool getReadConnectionPool()

PUBLIC: Handles allocating connections for read queries.

By default a read connection pool is not used, the default connection pool is used for reading.

The read connection pool is not used while in transaction.

See Also: setReadConnectionPool(ConnectionPool), useExclusiveReadConnectionPool, useExternalReadConnectionPool, useReadConnectionPool

setDatasourceLogin	back to summary
public void setDatasourceLogin(Login login) Redeclares org.eclipse.persistence.sessions.DatabaseSession.setDatasourceLogin. PUBLIC: Set the login. Annotations @Override

setDatasourceLogin

back to summary

public void setDatasourceLogin(Login login)

Redeclares org.eclipse.persistence.sessions.DatabaseSession.setDatasourceLogin.

PUBLIC: Set the login.

Annotations

@Override

setDefaultConnectionPolicy	back to summary
public void setDefaultConnectionPolicy(ConnectionPolicy defaultConnectionPolicy) PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol. By default it uses the default connection pool.

setMaxNumberOfNonPooledConnections	back to summary
public void setMaxNumberOfNonPooledConnections(int maxNumberOfNonPooledConnections) PUBLIC: Set the number of non-pooled database connections allowed. This can be enforced to make up for the resource limitation of most JDBC drivers and database clients. By default this is 50.

setReadConnectionPool back to summary

setReadConnectionPool	back to summary
public void setReadConnectionPool(ConnectionPool readConnectionPool) PUBLIC: Sets the read connection pool directly. Either `useExclusiveReadConnectionPool` or `useExternalReadConnectionPool` is called in the constructor. For a connection pool using concurrent reading `useReadConnectionPool` should be called on a new instance of `this`. Exceptions ValidationException: if already connected

public void setReadConnectionPool(ConnectionPool readConnectionPool)

PUBLIC: Sets the read connection pool directly.

Either useExclusiveReadConnectionPool or useExternalReadConnectionPool is called in the constructor. For a connection pool using concurrent reading useReadConnectionPool should be called on a new instance of this.

Exceptions

ValidationException:: if already connected

useExclusiveReadConnectionPool back to summary

useExclusiveReadConnectionPool	back to summary
public void useExclusiveReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate exclusive `ConnectionPool` with the minimum and maximum number of connections. A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading. See Also `getReadConnectionPool`, `setReadConnectionPool(ConnectionPool)`, `useReadConnectionPool`, `useExternalReadConnectionPool`

public void useExclusiveReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections)

PUBLIC: Sets the read connection pool to be a separate exclusive ConnectionPool with the minimum and maximum number of connections.

A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading.

See Also: getReadConnectionPool, setReadConnectionPool(ConnectionPool), useReadConnectionPool, useExternalReadConnectionPool

useExclusiveReadConnectionPool back to summary

useExclusiveReadConnectionPool	back to summary
public void useExclusiveReadConnectionPool(int initialNumberOfConnections, int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate exclusive `ConnectionPool` with the initial, minimum and maximum number of connections. A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading. See Also `getReadConnectionPool`, `setReadConnectionPool(ConnectionPool)`, `useReadConnectionPool`, `useExternalReadConnectionPool`

public void useExclusiveReadConnectionPool(int initialNumberOfConnections, int minNumberOfConnections, int maxNumberOfConnections)

PUBLIC: Sets the read connection pool to be a separate exclusive ConnectionPool with the initial, minimum and maximum number of connections.

See Also: getReadConnectionPool, setReadConnectionPool(ConnectionPool), useReadConnectionPool, useExternalReadConnectionPool

useExternalReadConnectionPool back to summary

useExternalReadConnectionPool	back to summary
public void useExternalReadConnectionPool() PUBLIC: Sets the read connection pool to be an `ExternalConnectionPool`. This type of connection pool will be created and configured automatically if an external connection pooling is used. See Also `getReadConnectionPool`, `setReadConnectionPool(ConnectionPool)`, `useReadConnectionPool`, `useExclusiveReadConnectionPool`

public void useExternalReadConnectionPool()

PUBLIC: Sets the read connection pool to be an ExternalConnectionPool.

This type of connection pool will be created and configured automatically if an external connection pooling is used.

See Also: getReadConnectionPool, setReadConnectionPool(ConnectionPool), useReadConnectionPool, useExclusiveReadConnectionPool

useReadConnectionPool back to summary

useReadConnectionPool	back to summary
public void useReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate shared `ConnectionPool` with the minimum and maximum number of connections. A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading. Since read connections are not used for writing, multiple users can theoretically use the same connection at the same time. However some JDBC drivers do not allow this, or have poor concurrency when this is done. Use this read connection pool to take advantage of concurrent reading. Parameters maxNumberOfConnections:int As multiple readers can use the same connection concurrently fewer connections are needed. See Also `getReadConnectionPool`, `setReadConnectionPool(ConnectionPool)`, `useExternalReadConnectionPool`, `useExclusiveReadConnectionPool`

public void useReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections)

PUBLIC: Sets the read connection pool to be a separate shared ConnectionPool with the minimum and maximum number of connections.
A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading.
Since read connections are not used for writing, multiple users can theoretically use the same connection at the same time. However some JDBC drivers do not allow this, or have poor concurrency when this is done.
Use this read connection pool to take advantage of concurrent reading.

Parameters

maxNumberOfConnections:int: As multiple readers can use the same connection concurrently fewer connections are needed.

useReadConnectionPool back to summary

useReadConnectionPool	back to summary
public void useReadConnectionPool(int initialNumberOfConnections, int minNumberOfConnections, int maxNumberOfConnections) PUBLIC: Sets the read connection pool to be a separate shared `ConnectionPool` with the minimum and maximum number of connections. A separate read connection pool is not used by default, by default the default connection pool is used for reading. A separate read connection pool can be used to dedicate a pool of connections only for reading. It can also be used to use a non-JTA DataSource for reading to avoid JTA overhead, or to use a different user login for reading. Since read connections are not used for writing, multiple users can theoretically use the same connection at the same time. However some JDBC drivers do not allow this, or have poor concurrency when this is done. Use this read connection pool to take advantage of concurrent reading. Parameters initialNumberOfConnections:int connections connected at startup minNumberOfConnections:int connections that are pooled maxNumberOfConnections:int As multiple readers can use the same connection concurrently fewer connections are needed. See Also `getReadConnectionPool`, `setReadConnectionPool(ConnectionPool)`, `useExternalReadConnectionPool`, `useExclusiveReadConnectionPool`

public void useReadConnectionPool(int initialNumberOfConnections, int minNumberOfConnections, int maxNumberOfConnections)

Parameters

initialNumberOfConnections:int: connections connected at startup
minNumberOfConnections:int: connections that are pooled
maxNumberOfConnections:int: As multiple readers can use the same connection concurrently fewer connections are needed.

public Interface Server

Method Summary

Method Detail