Class RequestRepository

java.lang.Object

com.netscape.cmscore.dbs.Repository

com.netscape.cmscore.request.RequestRepository

All Implemented Interfaces:

IRepository

public class RequestRepository
extends Repository

TODO: what does this class provide beyond the Repository base class??

Version:

$Revision$ $Date$

Author:

thayes

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filter
static org.slf4j.Logger	logger

Fields inherited from class Repository

dbSubsystem, maxSerialName, mBaseDN, mCounter, mEnableRandomSerialNumbers, mIncrementNo, minSerialName, mLowWaterMarkNo, mMaxSerialNo, mMinSerialNo, mNextMaxSerialNo, mNextMinSerialNo, mRadix, nextMaxSerialName, nextMinSerialName, rangeDN, repositoryConfig

Modifier and Type	Field	Description
protected DBSubsystem	dbSubsystem
protected String	maxSerialName
protected String	mBaseDN
protected BigInteger	mCounter
protected boolean	mEnableRandomSerialNumbers
protected BigInteger	mIncrementNo
protected String	minSerialName
protected BigInteger	mLowWaterMarkNo
protected BigInteger	mMaxSerialNo
protected BigInteger	mMinSerialNo
protected BigInteger	mNextMaxSerialNo
protected BigInteger	mNextMinSerialNo
protected int	mRadix
protected String	nextMaxSerialName
protected String	nextMinSerialName
protected String	rangeDN
protected Hashtable<String,String>	repositoryConfig

Constructor Summary

Constructors

Constructor	Description
RequestRepository(DBSubsystem dbSubsystem, String filter)	Create a request repository that uses the LDAP database
RequestRepository(DBSubsystem dbSubsystem, String filter, Hashtable<String,String> repositoryConfig)

Method Summary

Modifier and Type	Method	Description
void	addRequest(IRequest request)
IRequest	createRequest(RequestId requestID, String requestType)
IRequest	createRequest(String requestType)
RequestId	createRequestID()
RequestId	createRequestID(boolean ephemeral)
BigInteger	getLastSerialNumberInRange(BigInteger min, BigInteger max)
IRequestVirtualList	getPagedRequestsByFilter(RequestId fromID, boolean jumpToEnd, String filter, int pageSize, String sortKey)	Gets a pageable list of IRequest entries in this queue.
String	getPublishingStatus()
IRequestList	listRequestsByFilter(String filter)
IRequestList	listRequestsByFilter(String filter, int maxSize)
IRequestList	listRequestsByFilter(String filter, int maxSize, int timeLimit)
void	modifyRequest(IRequest request)
IRequest	readRequest(RequestId id)
void	removeAllObjects()	Removes all objects with this repository.
void	setPublishingStatus(String status)

Methods inherited from class Repository

checkRange, checkRanges, getBaseDN, getMaxSerial, getMinSerial, getNextMaxSerial, getNextRange, getNextSerialNumber, getRadix, hasRangeConflict, initCacheIfNeeded, peekNextSerialNumber, setEnableSerialMgmt, setLastSerialNo, setMaxSerial, setMaxSerialConfig, setMinSerialConfig, setNextMaxSerial, setNextMaxSerialConfig, setNextMinSerialConfig, setTheSerialNumber

Modifier and Type	Method	Description
protected void	checkRange()	Checks if the given number is in the current range.
void	checkRanges()	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.
String	getBaseDN()	Get the LDAP base DN for this repository.
BigInteger	getMaxSerial()	Get the maximum serial number.
BigInteger	getMinSerial()	Get the minimum serial number.
BigInteger	getNextMaxSerial()	Get the maximum serial number in next range.
String	getNextRange()	Gets start of next range from database.
BigInteger	getNextSerialNumber()	Retrieves the next serial number, and also increase the serial number by one.
int	getRadix()
boolean	hasRangeConflict()	Determines if a range conflict has been observed in database.
protected void	initCacheIfNeeded()
BigInteger	peekNextSerialNumber()	Peek at the next serial number in cache (does not consume the number).
void	setEnableSerialMgmt(boolean value)	Sets whether serial number management is enabled for certs and requests.
protected void	setLastSerialNo(BigInteger lastSN)
void	setMaxSerial(BigInteger serial)	Set the maximum serial number.
void	setMaxSerialConfig()	Sets maximum serial number limit in config file
void	setMinSerialConfig()	Sets minimum serial number limit in config file
void	setNextMaxSerial(BigInteger serial)	Set the maximum serial number in next range
void	setNextMaxSerialConfig()	Sets maximum serial number limit for next range in config file
void	setNextMinSerialConfig()	Sets minimum serial number limit for next range in config file
void	setTheSerialNumber(BigInteger num)	Updates the serial number to the specified in db and cache.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

filter

protected String filter

Constructor Details

RequestRepository

public RequestRepository(DBSubsystem dbSubsystem,
 String filter)
                  throws EBaseException

Create a request repository that uses the LDAP database

Parameters:

dbSubsystem - the LDAP database system.

Throws:

EBaseException

RequestRepository

public RequestRepository(DBSubsystem dbSubsystem,
 String filter,
 Hashtable<String,String> repositoryConfig)
                  throws EBaseException

Throws:

EBaseException

Method Details

createRequestID

public RequestId createRequestID()
                          throws EBaseException

Throws:

EBaseException

createRequestID

public RequestId createRequestID(boolean ephemeral)
                          throws EBaseException

Throws:

EBaseException

createRequest

public IRequest createRequest(RequestId requestID,
 String requestType)
                       throws EBaseException

Throws:

EBaseException

createRequest

public IRequest createRequest(String requestType)
                       throws EBaseException

Throws:

EBaseException

addRequest

public void addRequest(IRequest request)
                throws EBaseException

Throws:

EBaseException

readRequest

public IRequest readRequest(RequestId id)
                     throws EBaseException

Throws:

EBaseException

modifyRequest

public void modifyRequest(IRequest request)
                   throws EBaseException

Throws:

EBaseException

removeAllObjects

public void removeAllObjects()
                      throws EBaseException

Removes all objects with this repository.

Throws:

EBaseException

listRequestsByFilter

public IRequestList listRequestsByFilter(String filter)
                                  throws EBaseException

Throws:

EBaseException

listRequestsByFilter

public IRequestList listRequestsByFilter(String filter,
 int maxSize)
                                  throws EBaseException

Throws:

EBaseException

listRequestsByFilter

public IRequestList listRequestsByFilter(String filter,
 int maxSize,
 int timeLimit)
                                  throws EBaseException

Throws:

EBaseException

getPagedRequestsByFilter

public IRequestVirtualList getPagedRequestsByFilter(RequestId fromID,
 boolean jumpToEnd,
 String filter,
 int pageSize,
 String sortKey)
                                             throws EBaseException

Gets a pageable list of IRequest entries in this queue. This jumps right to the end of the list.

Parameters:

fromID - request id to start with

jumpToEnd - jump to end of list (set fromID to null)

filter - search filter

pageSize - page size

sortKey - the attributes to sort by

Returns:

request list

Throws:

EBaseException

getLastSerialNumberInRange

public BigInteger getLastSerialNumberInRange(BigInteger min,
 BigInteger max)
                                      throws EBaseException

Specified by:

getLastSerialNumberInRange in class Repository

Throws:

EBaseException

getPublishingStatus

public String getPublishingStatus()

setPublishingStatus

public void setPublishingStatus(String status)