summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java
diff options
context:
space:
mode:
authorAde Lee <alee@redhat.com>2011-12-07 16:58:12 -0500
committerAde Lee <alee@redhat.com>2011-12-07 16:58:12 -0500
commit32150d3ee32f8ac27118af7c792794b538c78a2f (patch)
tree52dd96f664a6fa51be25b28b6f10adc5f2c9f660 /pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java
parentf05d58a46795553beb8881039cc922974b40db34 (diff)
downloadpki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.gz
pki-32150d3ee32f8ac27118af7c792794b538c78a2f.tar.xz
pki-32150d3ee32f8ac27118af7c792794b538c78a2f.zip
Formatting
Formatted project according to eclipse project settings
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java117
1 files changed, 58 insertions, 59 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java b/pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java
index 350a29c4..37eed352 100644
--- a/pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java
+++ b/pki/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java
@@ -17,7 +17,6 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.dbs;
-
import java.math.BigInteger;
import netscape.ldap.LDAPConnection;
@@ -25,22 +24,19 @@ import netscape.ldap.LDAPConnection;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.ISubsystem;
-
/**
- * An interface represents certificate server
- * backend database.
+ * An interface represents certificate server backend database.
* <P>
- * This interface separate the database subsystem
- * functionalities from internal implementation.
+ * This interface separate the database subsystem functionalities from internal
+ * implementation.
* <P>
- *
- * @version $Revision$, $Date$
+ *
+ * @version $Revision$, $Date$
*/
public interface IDBSubsystem extends ISubsystem {
public static final String SUB_ID = "dbs";
-
// values for repos
public static final int CERTS = 0;
public static final int REQUESTS = 1;
@@ -49,21 +45,21 @@ public interface IDBSubsystem extends ISubsystem {
/**
* Retrieves the base DN.
- *
+ *
* @return base DN of the subsystem
*/
public String getBaseDN();
/**
* Retrieves the registry.
- *
+ *
* @return registry
*/
public IDBRegistry getRegistry();
/**
* Creates a database session.
- *
+ *
* @return database session
* @exception EDBException failed to create session
*/
@@ -71,145 +67,148 @@ public interface IDBSubsystem extends ISubsystem {
/**
* Avoids losing serial number.
- *
+ *
* @return true if serial number recovery option is enabled
*/
public boolean enableSerialNumberRecovery();
/**
* Records next serial number in config file
- *
+ *
* @param serial next serial number
- * @exception EBaseException failed to set
+ * @exception EBaseException failed to set
*/
public void setNextSerialConfig(BigInteger serial) throws EBaseException;
/**
* Gets the next serial number in config file
- *
+ *
* @return next serial number
*/
public BigInteger getNextSerialConfig();
/**
* Records maximum serial number limit in config file
- *
+ *
* @param serial max serial number
- * @param repo repo identifier
- * @exception EBaseException failed to set
+ * @param repo repo identifier
+ * @exception EBaseException failed to set
*/
- public void setMaxSerialConfig(int repo, String serial) throws EBaseException;
+ public void setMaxSerialConfig(int repo, String serial)
+ throws EBaseException;
/**
* Records minimum serial number limit in config file
- *
+ *
* @param serial min serial number
- * @param repo repo identifier
- * @exception EBaseException failed to set
+ * @param repo repo identifier
+ * @exception EBaseException failed to set
*/
- public void setMinSerialConfig(int repo, String serial) throws EBaseException;
+ public void setMinSerialConfig(int repo, String serial)
+ throws EBaseException;
/**
* Records maximum serial number limit for the next range in config file
- *
+ *
* @param serial max serial number
- * @param repo repo identifier
- * @exception EBaseException failed to set
+ * @param repo repo identifier
+ * @exception EBaseException failed to set
*/
- public void setNextMaxSerialConfig(int repo, String serial) throws EBaseException;
+ public void setNextMaxSerialConfig(int repo, String serial)
+ throws EBaseException;
/**
* Records minimum serial number limit for the next range in config file
- *
+ *
* @param serial min serial number
- * @param repo repo identifier
- * @exception EBaseException failed to set
+ * @param repo repo identifier
+ * @exception EBaseException failed to set
*/
- public void setNextMinSerialConfig(int repo, String serial) throws EBaseException;
+ public void setNextMinSerialConfig(int repo, String serial)
+ throws EBaseException;
/**
* Gets minimum serial number limit in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return min serial number
*/
public String getMinSerialConfig(int repo);
/**
* Gets the maximum serial number limit in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return max serial number
*/
public String getMaxSerialConfig(int repo);
/**
* Gets the maximum serial number limit for next range in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return max serial number
*/
public String getNextMaxSerialConfig(int repo);
/**
* Gets minimum serial number limit for next range in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return min serial number
*/
public String getNextMinSerialConfig(int repo);
-
+
/**
* Gets low water mark limit in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return low water mark
*/
public String getLowWaterMarkConfig(int repo);
-
+
/**
* Gets range increment limit for next range in config file
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return range increment
*/
public String getIncrementConfig(int repo);
-
+
/**
* Gets number corresponding to start of next range from database
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return start of next range
*/
public String getNextRange(int repo);
/**
* Determines if a range conflict has been observed in database
- *
- * @param repo repo identifier
+ *
+ * @param repo repo identifier
* @return true if range conflict, false otherwise
*/
public boolean hasRangeConflict(int repo);
/**
* Determines if serial number management has been enabled
- *
+ *
* @return true if enabled, false otherwise
*/
public boolean getEnableSerialMgmt();
- /**
- * Sets whether serial number management is enabled for certs
- * and requests.
- *
- * @param value true/false
- * @exception EBaseException failed to set
+ /**
+ * 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;
/**
* Returns LDAP connection to connection pool.
- *
+ *
* @param conn connection to be returned
*/
public void returnConn(LDAPConnection conn);