FileDocCategorySizeDatePackage
Server.javaAPI DocGlassfish v2 API10627Tue May 22 16:54:54 BST 2007oracle.toplink.essentials.threetier

Server

public interface Server implements DatabaseSession

Purpose: A single session that supports multiple user/clients connection at the same time.

Description: This session supports a shared session that can be used by multiple users or clients in a three-tiered application. It brokers client sessions to allow read and write access through a unified object cache. The server session provides a shared read only database connection that is used by all of its client for reads. All changes to objects and the database must be done through a unit of work acquired from the client session, this allows the changes to occur in a transactional object space and under a exclusive database connection.

Responsibilities:

  • Connecting/disconnecting the default reading login.
  • Reading objects and maintaining the object cache.
  • Brokering client sessions.
  • Disabling database modification through the shared connection.
see
ClientSession
see
oracle.toplink.essentials.sessions.UnitOfWork UnitOfWork

Fields Summary
Constructors Summary
Methods Summary
public oracle.toplink.essentials.threetier.ClientSessionacquireClientSession()
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.

public oracle.toplink.essentials.threetier.ClientSessionacquireClientSession(java.lang.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.

public oracle.toplink.essentials.threetier.ClientSessionacquireClientSession(oracle.toplink.essentials.sessions.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.

public oracle.toplink.essentials.threetier.ClientSessionacquireClientSession(oracle.toplink.essentials.threetier.ConnectionPolicy connectionPolicy)
PUBLIC: Return a client session for this server session. The connection policy specifies how the client session's connection will be acquired.

public voidaddConnectionPool(java.lang.String poolName, oracle.toplink.essentials.sessions.Login login, int minNumberOfConnections, int maxNumberOfConnections)
PUBLIC: Add the connection pool. Connections are pooled to share and restrict the number of database connections.

public voidaddConnectionPool(oracle.toplink.essentials.threetier.ConnectionPool pool)
PUBLIC: Connection are pooled to share and restrict the number of database connections.

public oracle.toplink.essentials.threetier.ConnectionPoolgetConnectionPool(java.lang.String poolName)
PUBLIC: Return the pool by name.

public oracle.toplink.essentials.threetier.ConnectionPolicygetDefaultConnectionPolicy()
PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol. By default it is a connection pool with min 5 and max 10 lazy pooled connections.

public oracle.toplink.essentials.threetier.ConnectionPoolgetDefaultConnectionPool()
PUBLIC: Return the default connection pool.

public intgetMaxNumberOfNonPooledConnections()
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.

public oracle.toplink.essentials.threetier.ConnectionPoolgetReadConnectionPool()
PUBLIC: Handles allocating connections for read queries.

By default a read connection pool is created and configured automatically in the constructor. A default read connection pool is one with two connections, and does not support concurrent reads.

The read connection pool is not used while in transaction.

see
#setReadConnectionPool(ConnectionPool)
see
#useExclusiveReadConnectionPool
see
#useExternalReadConnectionPool
see
#useReadConnectionPool

public voidsetDatasourceLogin(oracle.toplink.essentials.sessions.Login login)
PUBLIC: Set the login.

public voidsetDefaultConnectionPolicy(oracle.toplink.essentials.threetier.ConnectionPolicy defaultConnectionPolicy)
PUBLIC: The default connection policy is used by default by the acquireClientConnection() protocol. By default it is a connection pool with min 5 and max 10 lazy pooled connections.

public voidsetMaxNumberOfNonPooledConnections(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.

public voidsetReadConnectionPool(oracle.toplink.essentials.threetier.ConnectionPool readConnectionPool)
PUBLIC: Sets the read connection pool directly.

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

throws
ValidationException if already connected

public voiduseExclusiveReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections)
PUBLIC: Sets the read connection pool to be a standard ConnectionPool.

Minimum and maximum number of connections is determined from the ConnectionPolicy. The defaults are 2 for both.

Since the same type of connection pool is used as for writing, no two users will use the same connection for reading at the same time.

This read connection pool is the default as some JDBC drivers do not support concurrent reading.

Unless this {@link oracle.toplink.essentials.sessions.Session#hasExternalTransactionController hasExternalTransactionController()} a read connection pool of this type will be setup in the constructor.

see
#getReadConnectionPool
see
#setReadConnectionPool(ConnectionPool)
see
#useReadConnectionPool
see
#useExternalReadConnectionPool

public voiduseExternalReadConnectionPool()
PUBLIC: Sets the read connection pool to be an ExternalConnectionPool.

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

see
oracle.toplink.essentials.sessions.Session#hasExternalTransactionController
see
#getReadConnectionPool
see
#setReadConnectionPool(ConnectionPool)
see
#useReadConnectionPool
see
#useExclusiveReadConnectionPool

public voiduseReadConnectionPool(int minNumberOfConnections, int maxNumberOfConnections)
PUBLIC: Sets the read connection pool to be a ReadConnectionPool.

Since read connections are not used for writing, multiple users can theoretically use the same connection at the same time. Most JDBC drivers have concurrent reading which supports this.

Use this read connection pool to take advantage of concurrent reading.

param
minNumberOfConnections
param
maxNumberOfConnections As multiple readers can use the same connection concurrently fewer connections are needed.
see
#getReadConnectionPool
see
#setReadConnectionPool(ConnectionPool)
see
#useExternalReadConnectionPool
see
#useExclusiveReadConnectionPool