/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* // Copyright (c) 1998, 2007, Oracle. All rights reserved.
*
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package oracle.toplink.essentials.sequencing;
import oracle.toplink.essentials.sessions.Login;
/**
* <p>
* <b>Purpose</b>: Define an interface to control sequencing functionality.
* <p>
* <b>Description</b>: This interface is accessed through DatabaseSession.getSequencingControl().
* It allows to create, re-create, customize Sequencing object
* which is available through DatabaseSession.getSequencing()
* and provides sequencing values for all descriptors that use sequencing.
*
* Here's the lifecycle of Sequencing object used by DatabaseSession:
* 1. DatabaseSession created - sequencing object doesn't yet exist;
* 2. DatabaseSession.login() causes creation of Sequencing object;
* 3. DatabaseSession.logout() causes destruction of Sequencing object.
*
* In case sequencing object doesn't yet exist all the set parameters' values will be used
* during its creation.
*
* In case sequencing object already exists:
* 1. The following methods don't alter sequencing object - the corresponding parameters will only
* be used in case a new sequencing object is created:
* setShouldUseSeparateConnection;
* setLogin;
* setMinPoolSize;
* setMaxPoolSize.
* 2. The following methods cause immediate destruction of the sequencing object and creation of a new one:
* setValueGenerationPolicy;
* setShouldUseNativeSequencing;
* setShouldUseTableSequencing;
* resetSequencing;
* 3. The following methods cause change immediately:
* setPreallocationSize (next sequencing preallocation will use the set parameter's value).
* <p>
* <b>Responsibilities</b>:
* <ul>
* <li> Define the APIs for controlling sequencing.
* </ul>
* @see Sequence
* @see oracle.toplink.essentials.publicinterface.DatabaseSession
*/
public interface SequencingControl {
/**
* ADVANCED:
* Immediately re-create sequencing object.
* The only reason to use this method is to pick up all parameters'
* values that were changed after the original sequencing object has been created.
*/
public void resetSequencing();
/**
* PUBLIC:
* Indicate whether separate connection(s) for sequencing could be used
* (by default it couldn't).
* If this flag is set to true then separate connection(s) for sequencing
* will be used in case getSequence().shouldUseSeparateConnection()
* returns true.
* @see Sequence
*/
public boolean shouldUseSeparateConnection();
/**
* PUBLIC:
* Set whether separate connection(s) for sequencing could be used
* (by default it couldn't).
* If this flag is set to true then separate connection(s) for sequencing
* will be used in case getSequence().shouldUseSeparateConnection()
* returns true.
* @see Sequence
*/
public void setShouldUseSeparateConnection(boolean shouldUseSeparateConnection);
/**
* PUBLIC:
* Indicates whether sequencing actually uses separate connection(s).
* Returns true if sequencing is connected and uses separate connection(s).
* Returns false if sequencing is not connected (getSequencing()==null).
* Note that if shouldUseSeparateConnection() returns false this method also returns false.
* However if shouldUseSeparateConnection() returns true this method
* returns false in the following two cases:
* sequencing is not connected;
* getSequence().shouldUseSeparateConnection() == false.
* @see Sequence
*/
public boolean isConnectedUsingSeparateConnection();
/**
* ADVANCED:
* Return a DatabaseLogin to be used by separate sequencing connection(s).
* @see oracle.toplink.essentials.sessions.DatabaseLogin
*/
public Login getLogin();
/**
* ADVANCED:
* Returns a DatabaseLogin to be used by separate sequencing connection(s)
* The set value is ignored if shouldUseSeparateConnection() returns false.
* The DatabaseLogin *MUST*:
* 1. specify *NON-JTS* connections (such as NON_JTS driver or read-only datasource);
* 2. sequenceLogin.shouldUseExternalTransactionController()==false
* In case this method is not called, but separate connection should be used,
* sequencing will use a clone of login owned by the DatabaseSession,
* or a clone of read login owned by ServerSession.
* @see oracle.toplink.essentials.sessions.DatabaseLogin
*/
public void setLogin(Login login);
/**
* PUBLIC:
* Returns a minimum number of connections in sequencing connection pool.
* @see oracle.toplink.essentials.threetier.ConnectionPool
* @see oracle.toplink.essentials.threetier.ServerSession
*/
public int getMinPoolSize();
/**
* PUBLIC:
* Sets a minimum number of connections in sequencing connection pool
* The set value is ignored if shouldUseSeparateConnection() returns false.
* The set value is ignored if SequencingControl has been obtained not from ServerSession.
* By default is 2.
* @see oracle.toplink.essentials.threetier.ConnectionPool
* @see oracle.toplink.essentials.threetier.ServerSession
*/
public void setMinPoolSize(int size);
/**
* PUBLIC:
* Returns a maximum number of connections in sequencing connection pool
* @see oracle.toplink.essentials.threetier.ConnectionPool
* @see oracle.toplink.essentials.threetier.ServerSession
*/
public int getMaxPoolSize();
/**
* PUBLIC:
* Sets a maximum number of connections in sequencing connection pool
* The set value is ignored if shouldUseSeparateConnection() returns false.
* The set value is ignored if SequencingControl has been obtained not from ServerSession.
* By default is 2.
* @see oracle.toplink.essentials.threetier.ConnectionPool
* @see oracle.toplink.essentials.threetier.ServerSession
*/
public void setMaxPoolSize(int size);
/**
* ADVANCED:
* Removes all preallocated sequencing objects.
* Ignored if getSequencingValueGenarationPolicy().shouldUsePreallocation() returns false.
* This method is called internally after Sequencing object is destructed.
* @see Sequence
*/
public void initializePreallocated();
/**
* ADVANCED:
* Removes all preallocated sequencing objects for the given sequence name.
* Ignored if getSequencingValueGenarationPolicy().shouldUsePreallocation() returns false.
* @see Sequence
*/
public void initializePreallocated(String seqName);
}
|
