diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/cmscore/dbs/Repository.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/cmscore/dbs/Repository.java | 497 |
1 files changed, 0 insertions, 497 deletions
diff --git a/pki/base/common/src/com/netscape/cmscore/dbs/Repository.java b/pki/base/common/src/com/netscape/cmscore/dbs/Repository.java deleted file mode 100644 index aadfb888a..000000000 --- a/pki/base/common/src/com/netscape/cmscore/dbs/Repository.java +++ /dev/null @@ -1,497 +0,0 @@ -// --- BEGIN COPYRIGHT BLOCK --- -// This program is free software; you can redistribute it and/or modify -// it under the terms of the GNU General Public License as published by -// the Free Software Foundation; version 2 of the License. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License along -// with this program; if not, write to the Free Software Foundation, Inc., -// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -// -// (C) 2007 Red Hat, Inc. -// All rights reserved. -// --- END COPYRIGHT BLOCK --- -package com.netscape.cmscore.dbs; - -import java.math.BigInteger; - -import com.netscape.certsrv.apps.CMS; -import com.netscape.certsrv.base.EBaseException; -import com.netscape.certsrv.dbs.EDBException; -import com.netscape.certsrv.dbs.IDBObj; -import com.netscape.certsrv.dbs.IDBSSession; -import com.netscape.certsrv.dbs.IDBSubsystem; -import com.netscape.certsrv.dbs.Modification; -import com.netscape.certsrv.dbs.ModificationSet; -import com.netscape.certsrv.dbs.certdb.ICertificateRepository; -import com.netscape.certsrv.dbs.keydb.IKeyRepository; -import com.netscape.certsrv.dbs.replicadb.IReplicaIDRepository; -import com.netscape.certsrv.dbs.repository.IRepository; -import com.netscape.certsrv.dbs.repository.IRepositoryRecord; - -/** - * A class represents a generic repository. It maintains unique - * serial number within repository. - * <P> - * To build domain specific repository, subclass should be created. - * <P> - * - * @author galperin - * @author thomask - * @version $Revision: 1.4 - * - * $, $Date$ - */ - -public abstract class Repository implements IRepository { - - private static final BigInteger BI_ONE = new BigInteger("1"); - private BigInteger BI_INCREMENT = null; - private static final BigInteger BI_ZERO = new BigInteger("0"); - // (the next serialNo to be issued) - 1 - private BigInteger mSerialNo = null; - // the serialNo attribute stored in db - private BigInteger mNext = null; - - private String mMaxSerial = null; - private String mMinSerial = null; - private String mNextMaxSerial = null; - private String mNextMinSerial = null; - - private BigInteger mMinSerialNo = null; - private BigInteger mMaxSerialNo = null; - private BigInteger mNextMinSerialNo = null; - private BigInteger mNextMaxSerialNo = null; - - private BigInteger mIncrementNo = null; - private BigInteger mLowWaterMarkNo = null; - - private IDBSubsystem mDB = null; - private String mBaseDN = null; - private boolean mInit = false; - private int mRadix = 10; - private int mRepo = -1; - - private BigInteger mLastSerialNo = null; - - /** - * Constructs a repository. - * <P> - */ - public Repository(IDBSubsystem db, int increment, String baseDN) - throws EDBException { - mDB = db; - mBaseDN = baseDN; - - BI_INCREMENT = new BigInteger(Integer.toString(increment)); - - /* - // register schema - IDBRegistry reg = db.getRegistry(); - if (!reg.isObjectClassRegistered(RepositoryRecord.class.getName())) { - String repRecordOC[] = new String[2]; - repRecordOC[0] = RepositorySchema.LDAP_OC_TOP; - repRecordOC[1] = RepositorySchema.LDAP_OC_REPOSITORY; - reg.registerObjectClass(RepositoryRecord.class.getName(), repRecordOC); - } - if (!reg.isAttributeRegistered(RepositoryRecord.ATTR_SERIALNO)) { - reg.registerAttribute(RepositoryRecord.ATTR_SERIALNO, - new BigIntegerMapper(RepositorySchema.LDAP_ATTR_SERIALNO)); - } - */ - } - - /** - * Resets serial number. - */ - public void resetSerialNumber(BigInteger serial) throws EBaseException { - IDBSSession s = mDB.createSession(); - - try { - String name = mBaseDN; - ModificationSet mods = new ModificationSet(); - mods.add(IRepositoryRecord.ATTR_SERIALNO, - Modification.MOD_REPLACE, serial); - s.modify(name, mods); - } finally { - if (s != null) - s.close(); - } - } - - /** - * Retrieves the next serial number attr in db. - * <P> - * - * @return next serial number - */ - protected BigInteger getSerialNumber() throws EBaseException { - IDBSSession s = mDB.createSession(); - - CMS.debug("Repository: getSerialNumber."); - RepositoryRecord rec = null; - - try { - if (s != null) - rec = (RepositoryRecord) s.read(mBaseDN); - } finally { - if (s != null) - s.close(); - } - - if (rec == null) { - CMS.debug("Repository::getSerialNumber() - " - + "- rec is null!"); - throw new EBaseException("rec is null"); - } - - BigInteger serial = rec.getSerialNumber(); - - if (!mInit) { - // cms may crash after issue a cert but before update - // the serial number record - try { - IDBObj obj = s.read("cn=" + - serial + "," + mBaseDN); - - if (obj != null) { - serial = serial.add(BI_ONE); - setSerialNumber(serial); - } - } catch (EBaseException e) { - // do nothing - } - mInit = true; - } - return serial; - } - - /** - * Updates the serial number to the specified in db. - * <P> - * - * @param num serial number - */ - protected void setSerialNumber(BigInteger num) throws EBaseException { - - CMS.debug("Repository:setSerialNumber " + num.toString()); - - return; - - } - - /** - * Get the maximum serial number. - * - * @return maximum serial number - */ - public String getMaxSerial() { - return mMaxSerial; - } - - /** - * Set the maximum serial number. - * - * @param serial maximum number - * @exception EBaseException failed to set maximum serial number - */ - public void setMaxSerial(String serial) throws EBaseException { - BigInteger maxSerial = null; - CMS.debug("Repository:setMaxSerial " + serial); - - maxSerial = new BigInteger(serial, mRadix); - if (maxSerial != null) { - mMaxSerial = serial; - mMaxSerialNo = maxSerial; - } - } - - /** - * Get the maximum serial number in next range. - * - * @return maximum serial number in next range - */ - public String getNextMaxSerial() { - return mNextMaxSerial; - } - - /** - * Set the maximum serial number in next range - * - * @param serial maximum number in next range - * @exception EBaseException failed to set maximum serial number in next range - */ - public void setNextMaxSerial(String serial) throws EBaseException { - BigInteger maxSerial = null; - CMS.debug("Repository:setNextMaxSerial " + serial); - - maxSerial = new BigInteger(serial, mRadix); - if (maxSerial != null) { - mNextMaxSerial = serial; - mNextMaxSerialNo = maxSerial; - } - - return; - } - - /** - * Get the minimum serial number. - * - * @return minimum serial number - */ - public String getMinSerial() { - return mMinSerial; - } - - /** - * init serial number cache - */ - private void initCache() throws EBaseException { - mNext = getSerialNumber(); - mRadix = 10; - - CMS.debug("Repository: in InitCache"); - - if (this instanceof ICertificateRepository) { - CMS.debug("Repository: Instance of Certificate Repository."); - mRadix = 16; - mRepo = IDBSubsystem.CERTS; - } else if (this instanceof IKeyRepository) { - // Key Repository uses the same configuration parameters as Certificate - // Repository. This is ok because they are on separate subsystems. - CMS.debug("Repository: Instance of Key Repository"); - mRadix = 16; - mRepo = IDBSubsystem.CERTS; - } else if (this instanceof IReplicaIDRepository) { - CMS.debug("Repository: Instance of Replica ID repository"); - mRepo = IDBSubsystem.REPLICA_ID; - } else { - // CRLRepository subclasses this too, but does not use serial number stuff - CMS.debug("Repository: Instance of Request Repository or CRLRepository."); - mRepo = IDBSubsystem.REQUESTS; - } - - mMinSerial = mDB.getMinSerialConfig(mRepo); - mMaxSerial = mDB.getMaxSerialConfig(mRepo); - mNextMinSerial = mDB.getNextMinSerialConfig(mRepo); - mNextMaxSerial = mDB.getNextMaxSerialConfig(mRepo); - String increment = mDB.getIncrementConfig(mRepo); - String lowWaterMark = mDB.getLowWaterMarkConfig(mRepo); - - CMS.debug("Repository: minSerial " + mMinSerial + " maxSerial: " + mMaxSerial); - - if (mMinSerial != null) - mMinSerialNo = new BigInteger(mMinSerial, mRadix); - - if (mMaxSerial != null) - mMaxSerialNo = new BigInteger(mMaxSerial, mRadix); - - if (mNextMinSerial != null) - mNextMinSerialNo = new BigInteger(mNextMinSerial, mRadix); - - if (mNextMaxSerial != null) - mNextMaxSerialNo = new BigInteger(mNextMaxSerial, mRadix); - - if (lowWaterMark != null) - mLowWaterMarkNo = new BigInteger(lowWaterMark, mRadix); - - if (increment != null) - mIncrementNo = new BigInteger(increment, mRadix); - - BigInteger theSerialNo = null; - theSerialNo = getLastSerialNumberInRange(mMinSerialNo, mMaxSerialNo); - - if (theSerialNo != null) { - - mLastSerialNo = new BigInteger(theSerialNo.toString()); - CMS.debug("Repository: mLastSerialNo: " + mLastSerialNo.toString()); - - } else { - - throw new EBaseException("Error in obtaining the last serial number in the repository!"); - - } - - } - - /** - * get the next serial number in cache - */ - public BigInteger getTheSerialNumber() throws EBaseException { - - CMS.debug("Repository:In getTheSerialNumber "); - if (mLastSerialNo == null) - initCache(); - BigInteger serial = new BigInteger((mLastSerialNo.add(BI_ONE)).toString()); - - if (mMaxSerialNo != null && serial.compareTo(mMaxSerialNo) > 0) - return null; - else - return serial; - } - - /** - * Updates the serial number to the specified in db and cache. - * <P> - * - * @param num serial number - */ - public void setTheSerialNumber(BigInteger num) throws EBaseException { - // mSerialNo is already set. But just in case - - CMS.debug("Repository:In setTheSerialNumber " + num.toString()); - if (mLastSerialNo == null) - initCache(); - - if (num.compareTo(mSerialNo) <= 0) { - throw new EDBException(CMS.getUserMessage("CMS_DBS_SETBACK_SERIAL", - mSerialNo.toString(16))); - } - // write the config parameter. It's needed in case the serialNum gap - // < BI_INCREMENT and server restart right afterwards. - mDB.setNextSerialConfig(num); - - mSerialNo = num.subtract(BI_ONE); - mNext = num.add(BI_INCREMENT); - setSerialNumber(mNext); - } - - /** - * Retrieves the next serial number, and also increase the - * serial number by one. - * <P> - * - * @return serial number - */ - public synchronized BigInteger getNextSerialNumber() throws - EBaseException { - - CMS.debug("Repository: in getNextSerialNumber. "); - - if (mLastSerialNo == null) { - initCache(); - - mLastSerialNo = mLastSerialNo.add(BI_ONE); - - } else { - mLastSerialNo = mLastSerialNo.add(BI_ONE); - } - - if (mLastSerialNo == null) { - CMS.debug("Repository::getNextSerialNumber() " + - "- mLastSerialNo is null!"); - throw new EBaseException("mLastSerialNo is null"); - } - - // check if we have reached the end of the range - // if so, move to next range - if (mLastSerialNo.compareTo(mMaxSerialNo) > 0) { - if (mDB.getEnableSerialMgmt()) { - CMS.debug("Reached the end of the range. Attempting to move to next range"); - mMinSerialNo = mNextMinSerialNo; - mMaxSerialNo = mNextMaxSerialNo; - mLastSerialNo = mMinSerialNo; - mNextMinSerialNo = null; - mNextMaxSerialNo = null; - if ((mMaxSerialNo == null) || (mMinSerialNo == null)) { - throw new EDBException(CMS.getUserMessage("CMS_DBS_LIMIT_REACHED", - mLastSerialNo.toString())); - } - - // persist the changes - mDB.setMinSerialConfig(mRepo, mMinSerialNo.toString()); - mDB.setMaxSerialConfig(mRepo, mMaxSerialNo.toString()); - mDB.setNextMinSerialConfig(mRepo, null); - mDB.setNextMaxSerialConfig(mRepo, null); - } else { - throw new EDBException(CMS.getUserMessage("CMS_DBS_LIMIT_REACHED", - mLastSerialNo.toString())); - } - } - - BigInteger retSerial = new BigInteger(mLastSerialNo.toString()); - - CMS.debug("Repository: getNextSerialNumber: returning retSerial " + retSerial); - return retSerial; - } - - /** - * Checks to see if a new range is needed, or if we have reached the end of the - * current range, or if a range conflict has occurred. - * - * @exception EBaseException failed to check next range for conflicts - */ - public void checkRanges() throws EBaseException { - if (!mDB.getEnableSerialMgmt()) { - CMS.debug("Serial Management not enabled. Returning .. "); - return; - } - if (CMS.getEESSLPort() == null) { - CMS.debug("Server not completely started. Returning .."); - return; - } - - if (mLastSerialNo == null) - initCache(); - - BigInteger numsInRange = mMaxSerialNo.subtract(mLastSerialNo); - BigInteger numsInNextRange = null; - BigInteger numsAvail = null; - CMS.debug("Serial numbers left in range: " + numsInRange.toString()); - CMS.debug("Last Serial Number: " + mLastSerialNo.toString()); - if ((mNextMaxSerialNo != null) && (mNextMinSerialNo != null)) { - numsInNextRange = mNextMaxSerialNo.subtract(mNextMinSerialNo); - numsAvail = numsInRange.add(numsInNextRange); - CMS.debug("Serial Numbers in next range: " + numsInNextRange.toString()); - CMS.debug("Serial Numbers available: " + numsAvail.toString()); - } else { - numsAvail = numsInRange; - CMS.debug("Serial Numbers available: " + numsAvail.toString()); - } - - if ((numsAvail.compareTo(mLowWaterMarkNo) < 0) && (!CMS.isPreOpMode())) { - CMS.debug("Low water mark reached. Requesting next range"); - mNextMinSerialNo = new BigInteger(mDB.getNextRange(mRepo), mRadix); - if (mNextMinSerialNo == null) { - CMS.debug("Next Range not available"); - } else { - CMS.debug("nNextMinSerialNo has been set to " + mNextMinSerialNo.toString(mRadix)); - mNextMaxSerialNo = mNextMinSerialNo.add(mIncrementNo); - numsAvail = numsAvail.add(mIncrementNo); - mDB.setNextMinSerialConfig(mRepo, mNextMinSerialNo.toString(mRadix)); - mDB.setNextMaxSerialConfig(mRepo, mNextMaxSerialNo.toString(mRadix)); - } - } - - if (numsInRange.compareTo(mLowWaterMarkNo) < 0) { - // check for a replication error - CMS.debug("Checking for a range conflict"); - if (mDB.hasRangeConflict(mRepo)) { - CMS.debug("Range Conflict found! Removing next range."); - mNextMaxSerialNo = null; - mNextMinSerialNo = null; - mDB.setNextMinSerialConfig(mRepo, null); - mDB.setNextMaxSerialConfig(mRepo, null); - } - } - } - - /** - * Sets whether serial number management is enabled for certs - * and requests. - * - * @param value true/false - * @exception EBaseException failed to set - */ - public void setEnableSerialMgmt(boolean value) throws EBaseException { - mDB.setEnableSerialMgmt(value); - } - - public abstract BigInteger getLastSerialNumberInRange(BigInteger serial_low_bound, BigInteger serial_upper_bound) - throws - EBaseException; -} |