From 7c7b9d023cd466c1771068badc020dab36beb553 Mon Sep 17 00:00:00 2001 From: Endi Sukma Dewata Date: Thu, 5 Apr 2012 14:49:11 -0500 Subject: Removed whitespaces from Java code. Whitespaces in Java code have been removed with the following command: find . -not -path .git -name *.java -exec sed -i 's/[[:blank:]]\+$//' {} \; Ticket #134 --- .../src/com/netscape/certsrv/dbs/DBResources.java | 2 +- .../src/com/netscape/certsrv/dbs/EDBException.java | 10 +-- .../netscape/certsrv/dbs/EDBNotAvailException.java | 4 +- .../certsrv/dbs/EDBRecordNotFoundException.java | 4 +- .../com/netscape/certsrv/dbs/IDBAttrMapper.java | 10 +-- .../com/netscape/certsrv/dbs/IDBDynAttrMapper.java | 4 +- .../src/com/netscape/certsrv/dbs/IDBObj.java | 4 +- .../src/com/netscape/certsrv/dbs/IDBRegistry.java | 30 ++++---- .../src/com/netscape/certsrv/dbs/IDBSSession.java | 36 ++++----- .../com/netscape/certsrv/dbs/IDBSearchResults.java | 6 +- .../src/com/netscape/certsrv/dbs/IDBSubsystem.java | 44 +++++------ .../com/netscape/certsrv/dbs/IDBVirtualList.java | 26 +++---- .../netscape/certsrv/dbs/IElementProcessor.java | 4 +- .../com/netscape/certsrv/dbs/IFilterConverter.java | 6 +- .../src/com/netscape/certsrv/dbs/Modification.java | 10 +-- .../com/netscape/certsrv/dbs/ModificationSet.java | 6 +- .../netscape/certsrv/dbs/certdb/ICertRecord.java | 24 +++--- .../certsrv/dbs/certdb/ICertRecordList.java | 16 ++-- .../certsrv/dbs/certdb/ICertificateRepository.java | 90 +++++++++++----------- .../certsrv/dbs/certdb/IRevocationInfo.java | 6 +- .../certsrv/dbs/crldb/ICRLIssuingPointRecord.java | 32 ++++---- .../netscape/certsrv/dbs/crldb/ICRLRepository.java | 26 +++---- .../com/netscape/certsrv/dbs/keydb/IKeyRecord.java | 22 +++--- .../netscape/certsrv/dbs/keydb/IKeyRecordList.java | 6 +- .../netscape/certsrv/dbs/keydb/IKeyRepository.java | 26 +++---- .../com/netscape/certsrv/dbs/keydb/KeyState.java | 10 +-- .../dbs/replicadb/IReplicaIDRepository.java | 2 +- .../certsrv/dbs/repository/IRepository.java | 14 ++-- .../certsrv/dbs/repository/IRepositoryRecord.java | 4 +- 29 files changed, 242 insertions(+), 242 deletions(-) (limited to 'base/common/src/com/netscape/certsrv/dbs') diff --git a/base/common/src/com/netscape/certsrv/dbs/DBResources.java b/base/common/src/com/netscape/certsrv/dbs/DBResources.java index a2201b8e6..b06959bbc 100644 --- a/base/common/src/com/netscape/certsrv/dbs/DBResources.java +++ b/base/common/src/com/netscape/certsrv/dbs/DBResources.java @@ -22,7 +22,7 @@ import java.util.ListResourceBundle; /** * A class represents a resource bundle for DBS subsystem. *

- * + * * @version $Revision$, $Date$ */ public class DBResources extends ListResourceBundle { diff --git a/base/common/src/com/netscape/certsrv/dbs/EDBException.java b/base/common/src/com/netscape/certsrv/dbs/EDBException.java index 77508dca4..1908bdf7e 100644 --- a/base/common/src/com/netscape/certsrv/dbs/EDBException.java +++ b/base/common/src/com/netscape/certsrv/dbs/EDBException.java @@ -22,7 +22,7 @@ import com.netscape.certsrv.base.EBaseException; /** * A class represents a database exception. *

- * + * * @version $Revision$, $Date$ */ public class EDBException extends EBaseException { @@ -39,7 +39,7 @@ public class EDBException extends EBaseException { /** * Constructs a database exception. *

- * + * * @param msgFormat message format */ public EDBException(String msgFormat) { @@ -49,7 +49,7 @@ public class EDBException extends EBaseException { /** * Constructs a database exception. *

- * + * * @param msgFormat message format * @param param parameter */ @@ -60,7 +60,7 @@ public class EDBException extends EBaseException { /** * Constructs a database exception. *

- * + * * @param msgFormat message format * @param e exception as parameter */ @@ -71,7 +71,7 @@ public class EDBException extends EBaseException { /** * Constructs a database exception. *

- * + * * @param msgFormat message format * @param params list of parameters */ diff --git a/base/common/src/com/netscape/certsrv/dbs/EDBNotAvailException.java b/base/common/src/com/netscape/certsrv/dbs/EDBNotAvailException.java index 6afb2dcc3..a7df8bac7 100644 --- a/base/common/src/com/netscape/certsrv/dbs/EDBNotAvailException.java +++ b/base/common/src/com/netscape/certsrv/dbs/EDBNotAvailException.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.dbs; /** * Indicates internal db is down. - * + * * @version $Revision$, $Date$ */ public class EDBNotAvailException extends EDBException { @@ -31,7 +31,7 @@ public class EDBNotAvailException extends EDBException { /** * Constructs a ldap server down exception with host & port info. - * + * * @param errorString Detailed error message. */ public EDBNotAvailException(String errorString) { diff --git a/base/common/src/com/netscape/certsrv/dbs/EDBRecordNotFoundException.java b/base/common/src/com/netscape/certsrv/dbs/EDBRecordNotFoundException.java index dd3880c12..05b1085f0 100644 --- a/base/common/src/com/netscape/certsrv/dbs/EDBRecordNotFoundException.java +++ b/base/common/src/com/netscape/certsrv/dbs/EDBRecordNotFoundException.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.dbs; /** * Indicates internal db is down. - * + * * @version $Revision$, $Date$ */ public class EDBRecordNotFoundException extends EDBException { @@ -31,7 +31,7 @@ public class EDBRecordNotFoundException extends EDBException { /** * Constructs a ldap server down exception with host & port info. - * + * * @param errorString Detailed error message. */ public EDBRecordNotFoundException(String errorString) { diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBAttrMapper.java b/base/common/src/com/netscape/certsrv/dbs/IDBAttrMapper.java index 27e15bd7d..a5a603ec3 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBAttrMapper.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBAttrMapper.java @@ -28,7 +28,7 @@ import com.netscape.certsrv.base.EBaseException; * has knowledge on how to convert a db attribute into * zero or more LDAP attribute, and vice versa. *

- * + * * @version $Revision$, $Date$ */ public interface IDBAttrMapper { @@ -37,14 +37,14 @@ public interface IDBAttrMapper { * Retrieves a list of LDAP attributes that are used * in the mapper. By having this, the framework can * provide search on selective attributes. - * + * * @return a list of supported attribute names */ public Enumeration getSupportedLDAPAttributeNames(); /** * Maps object attribute into LDAP attributes. - * + * * @param parent parent object where the object comes from * @param name name of db attribute * @param obj object itself @@ -58,7 +58,7 @@ public interface IDBAttrMapper { /** * Maps LDAP attributes into object, and puts the object * into 'parent'. - * + * * @param attrs LDAP attribute set * @param name name of db attribute to be processed * @param parent parent object where the object should be added @@ -69,7 +69,7 @@ public interface IDBAttrMapper { /** * Maps search filters into LDAP search filter. - * + * * @param name name of db attribute * @param op filte operation (i.e. "=", ">=") * @param value attribute value diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBDynAttrMapper.java b/base/common/src/com/netscape/certsrv/dbs/IDBDynAttrMapper.java index 5684dd4d7..c1c8c3b39 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBDynAttrMapper.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBDynAttrMapper.java @@ -6,7 +6,7 @@ package com.netscape.certsrv.dbs; * assigned db attribute into zero or more dynamically assigned LDAP * attributes, and vice versa. *

- * + * * @version $Revision$, $Date$ */ public interface IDBDynAttrMapper extends IDBAttrMapper { @@ -14,7 +14,7 @@ public interface IDBDynAttrMapper extends IDBAttrMapper { /** * Returns true if the LDAP attribute can be mapped by this * dynamic mapper. - * + * * @param attrName LDAP attribute name to check * @return a list of supported attribute names */ diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBObj.java b/base/common/src/com/netscape/certsrv/dbs/IDBObj.java index 5c634beeb..f59fe2195 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBObj.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBObj.java @@ -24,7 +24,7 @@ import com.netscape.certsrv.base.IAttrSet; /** * An interface represents a database object * that is serializable. - * + * * @version $Revision$, $Date$ */ public interface IDBObj extends IAttrSet { @@ -34,7 +34,7 @@ public interface IDBObj extends IAttrSet { * names. This method should return the * attribute name even if there is no attribute * value for the attribute. - * + * * @return a list of serializable attribute names */ public Enumeration getSerializableAttrNames(); diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java b/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java index 241f3af9f..badf4d054 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java @@ -26,21 +26,21 @@ import com.netscape.certsrv.base.ISubsystem; * A class represents a registry where all the * schema (object classes and attribute) information * is stored. - * + * * Attribute mappers can be registered with this * registry. - * + * * Given the schema information stored, this registry * has knowledge to convert a Java object into a * LDAPAttributeSet or vice versa. - * + * * @version $Revision$, $Date$ */ public interface IDBRegistry extends ISubsystem { /** * Registers object class. - * + * * @param className java class to create for the object classes * @param ldapNames a list of LDAP object classes * @exception EDBException failed to register @@ -50,7 +50,7 @@ public interface IDBRegistry extends ISubsystem { /** * See if an object class is registered. - * + * * @param className java class to create * @return true if object class is registered already */ @@ -58,7 +58,7 @@ public interface IDBRegistry extends ISubsystem { /** * Registers attribute mapper. - * + * * @param ufName LDAP attribute name * @param mapper mapper to invoke for the attribute * @exception EDBException failed to register @@ -68,7 +68,7 @@ public interface IDBRegistry extends ISubsystem { /** * See if an attribute is registered. - * + * * @param ufName attribute name * @return true if attribute is registered already */ @@ -76,7 +76,7 @@ public interface IDBRegistry extends ISubsystem { /** * Registers a dynamic attribute mapper. - * + * * @param mapper The dynamic mapper to register */ public void registerDynamicMapper(IDBDynAttrMapper mapper); @@ -85,7 +85,7 @@ public interface IDBRegistry extends ISubsystem { * Creates LDAP-based search filters with help of * registered mappers. * Parses filter from filter string specified in RFC1558. - * + * * 

      *  ::= '('  ')'
      *  ::=  |  |  | 
@@ -107,7 +107,7 @@ public interface IDBRegistry extends ISubsystem {
      *  ::= NULL |  '*' 
      *  ::= NULL | 
      *
- * + * * @param filter CMS-based filter * @return LDAP-based filter string * @exception EBaseException failed to convert filter @@ -117,7 +117,7 @@ public interface IDBRegistry extends ISubsystem { /** * Creates LDAP-based search filters with help of * registered mappers. - * + * * @param filter CMS-based filter * @param c filter converter * @return LDAP-based filter string @@ -128,7 +128,7 @@ public interface IDBRegistry extends ISubsystem { /** * Maps object into LDAP attribute set. - * + * * @param parent object's parent * @param name name of the object * @param obj object to be mapped @@ -141,7 +141,7 @@ public interface IDBRegistry extends ISubsystem { /** * Retrieves a list of LDAP attributes that are associated * with the given attributes. - * + * * @param attrs attributes * @return LDAP-based attributes * @exception EBaseException failed to map attributes @@ -151,7 +151,7 @@ public interface IDBRegistry extends ISubsystem { /** * Creates attribute set from object. - * + * * @param obj database object * @return LDAP attribute set * @exception EBaseException failed to create set @@ -161,7 +161,7 @@ public interface IDBRegistry extends ISubsystem { /** * Creates object from attribute set. - * + * * @param attrs LDAP attribute set * @return database object * @exception EBaseException failed to create object diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java b/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java index c186d1145..a4c05f40a 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java @@ -25,36 +25,36 @@ import com.netscape.certsrv.base.ISubsystem; /** * An interface represents the database session. Operations * can be performed with a session. - * + * * Transaction and Caching support can be integrated * into session. - * + * * @version $Revision$, $Date$ */ public interface IDBSSession { /** * Returns database subsystem. - * + * * @return subsystem */ public ISubsystem getDBSubsystem(); /** * Closes this session. - * + * * @exception EDBException failed to close session */ public void close() throws EDBException; /** * Adds object to backend database. For example, - * + * * 
      * session.add("cn=123459,o=certificate repository,o=airius.com",
      *             certRec);
      *
- * + * * @param name name of the object * @param obj object to be added * @exception EDBException failed to add object @@ -63,7 +63,7 @@ public interface IDBSSession { /** * Reads an object from the database. - * + * * @param name name of the object that is to be read * @return database object * @exception EBaseException failed to read object @@ -73,7 +73,7 @@ public interface IDBSSession { /** * Reads an object from the database, and only populates * the selected attributes. - * + * * @param name name of the object that is to be read * @param attrs selected attributes * @return database object @@ -84,7 +84,7 @@ public interface IDBSSession { /** * Deletes object from database. - * + * * @param name name of the object that is to be deleted * @exception EBaseException failed to delete object */ @@ -92,7 +92,7 @@ public interface IDBSSession { /** * Modify an object in the database. - * + * * @param name name of the object that is to be modified * @param mods modifications * @exception EBaseException failed to modify @@ -103,7 +103,7 @@ public interface IDBSSession { /** * Searchs for a list of objects that match the * filter. - * + * * @param base starting point of the search * @param filter search filter * @return search results @@ -115,7 +115,7 @@ public interface IDBSSession { /** * Searchs for a list of objects that match the * filter. - * + * * @param base starting point of the search * @param filter search filter * @param maxSize max number of entries @@ -128,7 +128,7 @@ public interface IDBSSession { /** * Searchs for a list of objects that match the * filter. - * + * * @param base starting point of the search * @param filter search filter * @param maxSize max number of entries @@ -142,7 +142,7 @@ public interface IDBSSession { /** * Retrieves a list of object that satifies the given * filter. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -154,7 +154,7 @@ public interface IDBSSession { /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -167,7 +167,7 @@ public interface IDBSSession { /** * Sets persistent search to retrieve modified * certificate records. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -181,7 +181,7 @@ public interface IDBSSession { /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -196,7 +196,7 @@ public interface IDBSSession { /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBSearchResults.java b/base/common/src/com/netscape/certsrv/dbs/IDBSearchResults.java index 04736cf32..dd5a41186 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBSearchResults.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBSearchResults.java @@ -23,21 +23,21 @@ import java.util.Enumeration; * A class represents the search results. A search * results object contain a enumeration of * Java objects that are just read from the database. - * + * * @version $Revision$, $Date$ */ public interface IDBSearchResults extends Enumeration { /** * Checks if any element is available. - * + * * @return true if there is more elements */ public boolean hasMoreElements(); /** * Retrieves next element. - * + * * @return next element */ public Object nextElement(); diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java b/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java index fec6e6afa..dfa5312e5 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBSubsystem.java @@ -30,7 +30,7 @@ import com.netscape.certsrv.base.ISubsystem; *

* This interface separate the database subsystem functionalities from internal implementation. *

- * + * * @version $Revision$, $Date$ */ public interface IDBSubsystem extends ISubsystem { @@ -45,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 */ @@ -67,14 +67,14 @@ 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 */ @@ -82,14 +82,14 @@ public interface IDBSubsystem extends ISubsystem { /** * 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 @@ -98,7 +98,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Records minimum serial number limit in config file - * + * * @param serial min serial number * @param repo repo identifier * @exception EBaseException failed to set @@ -107,7 +107,7 @@ public interface IDBSubsystem extends ISubsystem { /** * 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 @@ -116,7 +116,7 @@ public interface IDBSubsystem extends ISubsystem { /** * 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 @@ -125,7 +125,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets minimum serial number limit in config file - * + * * @param repo repo identifier * @return min serial number */ @@ -133,7 +133,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets the maximum serial number limit in config file - * + * * @param repo repo identifier * @return max serial number */ @@ -141,7 +141,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets the maximum serial number limit for next range in config file - * + * * @param repo repo identifier * @return max serial number */ @@ -149,7 +149,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets minimum serial number limit for next range in config file - * + * * @param repo repo identifier * @return min serial number */ @@ -157,7 +157,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets low water mark limit in config file - * + * * @param repo repo identifier * @return low water mark */ @@ -165,7 +165,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets range increment limit for next range in config file - * + * * @param repo repo identifier * @return range increment */ @@ -173,7 +173,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Gets number corresponding to start of next range from database - * + * * @param repo repo identifier * @return start of next range */ @@ -181,7 +181,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Determines if a range conflict has been observed in database - * + * * @param repo repo identifier * @return true if range conflict, false otherwise */ @@ -189,7 +189,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Determines if serial number management has been enabled - * + * * @return true if enabled, false otherwise */ public boolean getEnableSerialMgmt(); @@ -197,7 +197,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Sets whether serial number management is enabled for certs * and requests. - * + * * @param value true/false * @exception EBaseException failed to set */ @@ -205,7 +205,7 @@ public interface IDBSubsystem extends ISubsystem { /** * Returns LDAP connection to connection pool. - * + * * @param conn connection to be returned */ public void returnConn(LDAPConnection conn); diff --git a/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java b/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java index 919a82efb..23b73fe60 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java +++ b/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java @@ -22,7 +22,7 @@ import com.netscape.certsrv.base.EBaseException; /** * A interface represents a virtual list of search results. * Note that this class must be used with DS4.0. - * + * * @version $Revision$, $Date$ */ public interface IDBVirtualList { @@ -33,14 +33,14 @@ public interface IDBVirtualList { * that is three times as large as the number of visible entries. * That way, you can scroll up/down several items(up to a page-full) * without refetching entries from the directory. - * + * * @param size the page size */ public void setPageSize(int size); /** * Sets the sort key - * + * * @param sortKey the attribute to sort by * @exception EBaseException failed to set */ @@ -48,7 +48,7 @@ public interface IDBVirtualList { /** * Sets the sort key - * + * * @param sortKeys the attributes to sort by * @exception EBaseException failed to set */ @@ -58,14 +58,14 @@ public interface IDBVirtualList { * Retrieves the size of this virtual list. * Recommend to call getSize() before getElementAt() or getElements() * since you'd better check if the index is out of bound first. - * + * * @return current size in list */ public int getSize(); /** * Returns current index. - * + * * @return current index */ @@ -80,7 +80,7 @@ public interface IDBVirtualList { * some preceding entries) * Recommend to call getSize() before getElementAt() or getElements() * since you'd better check if the index is out of bound first. - * + * * @param first the index of the first entry of the page you want to fetch */ public boolean getPage(int first); @@ -92,7 +92,7 @@ public interface IDBVirtualList { * of an entry. * If no entries match, the one just before(or after, if none before) * will be returned as mSelectedIndex - * + * * @param text the prefix of the first entry of the page you want to fetch */ public boolean getPage(String text); @@ -103,14 +103,14 @@ public interface IDBVirtualList { * since you'd better check if the index is out of bound first. * If the index is out of range of the virtual list, an exception * will be thrown and return null - * + * * @param index the index of the element to fetch */ public E getElementAt(int index); /** * Retrieves and jumps to element in the given position. - * + * * @param i position * @return object */ @@ -119,7 +119,7 @@ public interface IDBVirtualList { /** * Processes elements as soon as it arrives. It is * more memory-efficient. - * + * * @param startidx starting index * @param endidx ending index * @param ep object to call @@ -130,14 +130,14 @@ public interface IDBVirtualList { /** * Gets the virutal selected index - * + * * @return selected index */ public int getSelectedIndex(); /** * Gets the top of the buffer - * + * * @return first index */ public int getFirstIndex(); diff --git a/base/common/src/com/netscape/certsrv/dbs/IElementProcessor.java b/base/common/src/com/netscape/certsrv/dbs/IElementProcessor.java index 648a13aef..25388b15f 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IElementProcessor.java +++ b/base/common/src/com/netscape/certsrv/dbs/IElementProcessor.java @@ -21,14 +21,14 @@ import com.netscape.certsrv.base.EBaseException; /** * Processor handles object read from the session. - * + * * @version $Revision$, $Date$ */ public interface IElementProcessor { /** * Handles object - * + * * @param o object to be processed * @exception EBaseException failed to process object */ diff --git a/base/common/src/com/netscape/certsrv/dbs/IFilterConverter.java b/base/common/src/com/netscape/certsrv/dbs/IFilterConverter.java index 2c0ccb89f..c78cbebef 100644 --- a/base/common/src/com/netscape/certsrv/dbs/IFilterConverter.java +++ b/base/common/src/com/netscape/certsrv/dbs/IFilterConverter.java @@ -22,7 +22,7 @@ package com.netscape.certsrv.dbs; * that understands how to convert a attribute * type from one defintion to another. * For example, - * + * * 

  * (1) database layer need to convert
  *     registered attribute type to ldap attribute
@@ -31,14 +31,14 @@ package com.netscape.certsrv.dbs;
  *     locale specific attribute type to registered
  *     attribute type.
  *
- * + * * @version $Revision$, $Date$ */ public interface IFilterConverter { /** * Converts attribute into LDAP attribute. - * + * * @param attr attribute name * @param op attribute operation * @param value attribute value diff --git a/base/common/src/com/netscape/certsrv/dbs/Modification.java b/base/common/src/com/netscape/certsrv/dbs/Modification.java index 6c61bdb1f..685917cff 100644 --- a/base/common/src/com/netscape/certsrv/dbs/Modification.java +++ b/base/common/src/com/netscape/certsrv/dbs/Modification.java @@ -21,7 +21,7 @@ package com.netscape.certsrv.dbs; * A class represents a modification. This is used by the * database (dbs) framework for modification operations. * It specifices the modification type and values. - * + * * @version $Revision$, $Date$ */ public class Modification { @@ -47,7 +47,7 @@ public class Modification { /** * Constructs a role modification. - * + * * @param name attribute name * @param op attribute operation (i.e. MOD_ADD, MOD_DELETE, or MOD_REPLACE) * @param value attribute value @@ -60,7 +60,7 @@ public class Modification { /** * Retrieves attribute name. - * + * * @return attribute name */ public String getName() { @@ -69,7 +69,7 @@ public class Modification { /** * Retrieves modification operation type. - * + * * @return modification type */ public int getOp() { @@ -78,7 +78,7 @@ public class Modification { /** * Retrieves attribute value. - * + * * @return attribute value */ public Object getValue() { diff --git a/base/common/src/com/netscape/certsrv/dbs/ModificationSet.java b/base/common/src/com/netscape/certsrv/dbs/ModificationSet.java index 70e9b377d..1f4a5133b 100644 --- a/base/common/src/com/netscape/certsrv/dbs/ModificationSet.java +++ b/base/common/src/com/netscape/certsrv/dbs/ModificationSet.java @@ -23,7 +23,7 @@ import java.util.Vector; /** * A class represents a modification set. A modification * set contains zero or more modifications. - * + * * @version $Revision$, $Date$ */ public class ModificationSet { @@ -41,7 +41,7 @@ public class ModificationSet { /** * Adds modification to this set. - * + * * @param name attribute name * @param op modification operation * @param value attribute value @@ -52,7 +52,7 @@ public class ModificationSet { /** * Retrieves a list of modifications. - * + * * @return a list of Modifications */ public Enumeration getModifications() { diff --git a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecord.java b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecord.java index d05c9ed5f..76101d9b7 100644 --- a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecord.java +++ b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecord.java @@ -27,7 +27,7 @@ import com.netscape.certsrv.dbs.IDBObj; /** * An interface contains constants for certificate record. - * + * * @version $Revision$, $Date$ */ public interface ICertRecord extends IDBObj { @@ -99,77 +99,77 @@ public interface ICertRecord extends IDBObj { /** * Retrieves serial number from stored certificate. - * + * * @return certificate serial number */ public BigInteger getCertificateSerialNumber(); /** * Retrieves serial number from certificate record. - * + * * @return certificate serial number */ public BigInteger getSerialNumber(); /** * Retrieves certificate from certificate record. - * + * * @return certificate */ public X509CertImpl getCertificate(); /** * Retrieves name of who issued this certificate. - * + * * @return name of who issued this certificate */ public String getIssuedBy(); /** * Retrieves name of who revoked this certificate. - * + * * @return name of who revoked this certificate */ public String getRevokedBy(); /** * Retrieves date when this certificate was revoked. - * + * * @return date when this certificate was revoked */ public Date getRevokedOn(); /** * Retrieves meta info. - * + * * @return meta info */ public MetaInfo getMetaInfo(); /** * Retrieves certificate status. - * + * * @return certificate status */ public String getStatus(); /** * Retrieves time of creation of this certificate record. - * + * * @return time of creation of this certificate record */ public Date getCreateTime(); /** * Retrieves time of modification of this certificate record. - * + * * @return time of modification of this certificate record */ public Date getModifyTime(); /** * Retrieves revocation info. - * + * * @return revocation info */ public IRevocationInfo getRevocationInfo(); diff --git a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecordList.java b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecordList.java index 59a826ee2..152ec98ad 100644 --- a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecordList.java +++ b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertRecordList.java @@ -25,42 +25,42 @@ import com.netscape.certsrv.dbs.IElementProcessor; /** * A class represents a list of certificate records. *

- * + * * @version $Revision$, $Date$ */ public interface ICertRecordList { /** * Gets the current index. - * + * * @return current index */ public int getCurrentIndex(); /** * Retrieves the size of request list. - * + * * @return size */ public int getSize(); /** * Gets size before jump to index. - * + * * @return size */ public int getSizeBeforeJumpTo(); /** * Gets size after jump to index. - * + * * @return size */ public int getSizeAfterJumpTo(); /** * Process certificate record as soon as it is returned. - * + * * @param startidx starting index * @param endidx ending index * @param ep element processor @@ -73,7 +73,7 @@ public interface ICertRecordList { * Retrieves requests. * It's no good to call this if you didnt check * if the startidx, endidx are valid. - * + * * @param startidx starting index * @param endidx ending index * @exception EBaseException failed to retrieve @@ -84,7 +84,7 @@ public interface ICertRecordList { /** * Gets one single record at a time similar to * processCertRecords but no extra class needed. - * + * * @param index position of the record to be retrieved * @return object * @exception EBaseException failed to retrieve diff --git a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertificateRepository.java b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertificateRepository.java index a8505c2a2..d44280237 100644 --- a/base/common/src/com/netscape/certsrv/dbs/certdb/ICertificateRepository.java +++ b/base/common/src/com/netscape/certsrv/dbs/certdb/ICertificateRepository.java @@ -37,7 +37,7 @@ import com.netscape.cmscore.dbs.CertificateRepository.RenewableCertificateCollec * An interface represents a CMS certificate repository. * It stores all the issued certificate. *

- * + * * @version $Revision$, $Date$ */ public interface ICertificateRepository extends IRepository { @@ -47,7 +47,7 @@ public interface ICertificateRepository extends IRepository { * record contains four parts: certificate, meta-attributes, * issue information and reovcation information. *

- * + * * @param record X.509 certificate * @exception EBaseException failed to add new certificate to * the repository @@ -57,7 +57,7 @@ public interface ICertificateRepository extends IRepository { /** * Reads the certificate identified by the given serial no. - * + * * @param serialNo serial number of certificate * @return certificate * @exception EBaseException failed to retrieve certificate @@ -67,7 +67,7 @@ public interface ICertificateRepository extends IRepository { /** * Reads certificate from repository. - * + * * @param serialNo serial number of certificate * @return certificate record * @exception EBaseException failed to retrieve certificate @@ -77,7 +77,7 @@ public interface ICertificateRepository extends IRepository { /** * Sets certificate status update internal - * + * * @param requestRepo request repository * @param interval update interval * @param listenToCloneModifications enable listening to clone modifications @@ -88,14 +88,14 @@ public interface ICertificateRepository extends IRepository { /** * Updates certificate status now. This is a blocking method. - * + * * @exception EBaseException failed to update */ public void updateCertStatus() throws EBaseException; /** * Modifies certificate record. - * + * * @param serialNo serial number of record * @param mods modifications * @exception EBaseException failed to modify @@ -105,7 +105,7 @@ public interface ICertificateRepository extends IRepository { /** * Checks if the certificate exists in this repository. - * + * * @param serialNo serial number of certificate * @return true if it exists * @exception EBaseException failed to check @@ -115,7 +115,7 @@ public interface ICertificateRepository extends IRepository { /** * Deletes certificate from this repository. - * + * * @param serialNo serial number of certificate * @exception EBaseException failed to delete */ @@ -124,7 +124,7 @@ public interface ICertificateRepository extends IRepository { /** * Marks certificate as revoked. - * + * * @param id serial number * @param info revocation information * @exception EBaseException failed to mark @@ -134,7 +134,7 @@ public interface ICertificateRepository extends IRepository { /** * Updates certificate status. - * + * * @param id serial number * @param status certificate status * @exception EBaseException failed to update status @@ -144,7 +144,7 @@ public interface ICertificateRepository extends IRepository { /** * Marks certificate as renewable. - * + * * @param record certificate record to modify * @exception EBaseException failed to update */ @@ -153,7 +153,7 @@ public interface ICertificateRepository extends IRepository { /** * Marks certificate as not renewable. - * + * * @param record certificate record to modify * @exception EBaseException failed to update */ @@ -162,7 +162,7 @@ public interface ICertificateRepository extends IRepository { /** * Marks certificate as renewed. - * + * * @param serialNo certificate record to modify * @exception EBaseException failed to update */ @@ -171,7 +171,7 @@ public interface ICertificateRepository extends IRepository { /** * Marks certificate as renewed and notified. - * + * * @param serialNo certificate record to modify * @exception EBaseException failed to update */ @@ -183,7 +183,7 @@ public interface ICertificateRepository extends IRepository { * the filter. * Here is a list of filter * attribute can be used: - * + * * 

      *   certRecordId
      *   certMetaInfo
@@ -194,14 +194,14 @@ public interface ICertificateRepository extends IRepository {
      *   x509Cert.notAfter
      *   x509Cert.subject
      *
- * + * * The filter should follow RFC1558 LDAP filter syntax. * For example, - * + * * 
      *   (&(certRecordId=5)(x509Cert.notBefore=934398398))
      *
- * + * * @param filter search filter * @param maxSize max size to return * @return a list of certificates @@ -213,7 +213,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds a list of certificate records that satisifies * the filter. - * + * * @param filter search filter * @param maxSize max size to return * @param timeLimit timeout value @@ -226,7 +226,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds a list of certificate records that satisifies * the filter. - * + * * @param filter search filter * @param attrs selected attribute * @param pageSize page size @@ -239,7 +239,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds a list of certificate records that satisifies * the filter. - * + * * @param filter search filter * @param attrs selected attribute * @param sortKey key to use for sorting the returned elements @@ -254,7 +254,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds a list of certificate records that satisifies * the filter. - * + * * @param filter search filter * @param attrs selected attribute * @param jumpTo jump to index @@ -274,7 +274,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds a list of certificate records that satisifies * the filter. - * + * * @param filter search filter * @param attrs selected attribute * @param jumpTo jump to index @@ -294,7 +294,7 @@ public interface ICertificateRepository extends IRepository { /** * Gets all valid and unexpired certificates pertaining * to a subject DN. - * + * * @param subjectDN The distinguished name of the subject. * @param validityType The type of certificatese to retrieve. * @return An array of certificates. @@ -305,7 +305,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves all the revoked certificates that have not expired. - * + * * @param asOfDate as of date * @return a list of revoked certificates * @exception EBaseException failed to retrieve @@ -316,7 +316,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves all revoked certificates including ones that have expired * or that are not yet valid. - * + * * @return a list of revoked certificates * @exception EBaseException failed to search */ @@ -325,7 +325,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves all revoked but not expired certificates. - * + * * @return a list of revoked certificates * @exception EBaseException failed to search */ @@ -334,7 +334,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds all certificates given a filter. - * + * * @param filter search filter * @return a list of certificates * @exception EBaseException failed to search @@ -344,7 +344,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds all certificate records given a filter. - * + * * @param filter search filter * @return a list of certificates * @exception EBaseException failed to search @@ -355,7 +355,7 @@ public interface ICertificateRepository extends IRepository { /** * Gets Revoked certs orderes by noAfter date, jumps to records * where notAfter date is greater than current. - * + * * @param date reference date * @param pageSize page size * @return a list of certificate records @@ -367,7 +367,7 @@ public interface ICertificateRepository extends IRepository { /** * Gets Invalid certs orderes by noAfter date, jumps to records * where notAfter date is greater than current. - * + * * @param date reference date * @param pageSize page size * @return a list of certificate records @@ -379,7 +379,7 @@ public interface ICertificateRepository extends IRepository { /** * Gets valid certs orderes by noAfter date, jumps to records * where notAfter date is greater than current. - * + * * @param date reference date * @param pageSize page size * @return a list of certificate records @@ -390,7 +390,7 @@ public interface ICertificateRepository extends IRepository { /** * Creates certificate record. - * + * * @param id serial number * @param cert certificate * @param meta meta information @@ -401,7 +401,7 @@ public interface ICertificateRepository extends IRepository { /** * Finds certificate records. - * + * * @param filter search filter * @return a list of certificate records * @exception EBaseException failed to retrieve cert records @@ -411,7 +411,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves renewable certificates. - * + * * @param renewalTime renewal time * @return certificates * @exception EBaseException failed to retrieve @@ -421,7 +421,7 @@ public interface ICertificateRepository extends IRepository { /** * Unmark a revoked certificates. - * + * * @param id serial number * @param info revocation information * @param revokedOn revocation date @@ -434,7 +434,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves valid and not published certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -445,7 +445,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves expired and published certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -456,7 +456,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves revoked and published certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -467,7 +467,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves valid certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -478,7 +478,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves expired certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -489,7 +489,7 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves revoked certificates. - * + * * @param from starting serial number * @param to ending serial number * @return a list of certificates @@ -500,14 +500,14 @@ public interface ICertificateRepository extends IRepository { /** * Retrieves modified certificate records. - * + * * @param entry LDAPEntry with modified data */ public void getModifications(LDAPEntry entry); /** * Removes certificate records with this repository. - * + * * @param beginS BigInteger with radix 16 * @param endS BigInteger with radix 16 */ diff --git a/base/common/src/com/netscape/certsrv/dbs/certdb/IRevocationInfo.java b/base/common/src/com/netscape/certsrv/dbs/certdb/IRevocationInfo.java index fb773576c..b24e6ca17 100644 --- a/base/common/src/com/netscape/certsrv/dbs/certdb/IRevocationInfo.java +++ b/base/common/src/com/netscape/certsrv/dbs/certdb/IRevocationInfo.java @@ -26,21 +26,21 @@ import netscape.security.x509.CRLExtensions; * object is written as an attribute of certificate record * which essentially signifies a revocation act. *

- * + * * @version $Revision$, $Date$ */ public interface IRevocationInfo { /** * Retrieves revocation date. - * + * * @return revocation date */ public Date getRevocationDate(); /** * Retrieves CRL entry extensions. - * + * * @return CRL entry extensions */ public CRLExtensions getCRLEntryExtensions(); diff --git a/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLIssuingPointRecord.java b/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLIssuingPointRecord.java index b990bbf57..26fd076fa 100644 --- a/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLIssuingPointRecord.java +++ b/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLIssuingPointRecord.java @@ -28,7 +28,7 @@ import com.netscape.certsrv.dbs.IDBObj; /** * An interface that defines abilities of * a CRL issuing point record. - * + * * @version $Revision$, $Date$ */ public interface ICRLIssuingPointRecord extends IDBObj { @@ -54,84 +54,84 @@ public interface ICRLIssuingPointRecord extends IDBObj { /** * Retrieve unique CRL identifier. - * + * * @return unique CRL identifier */ public String getId(); /** * Retrieves current CRL number out of CRL issuing point record. - * + * * @return current CRL number */ public BigInteger getCRLNumber(); /** * Retrieves CRL size measured by the number of entries. - * + * * @return CRL size */ public Long getCRLSize(); /** * Retrieves this update time. - * + * * @return time of this update */ public Date getThisUpdate(); /** * Retrieves next update time. - * + * * @return time of next update */ public Date getNextUpdate(); /** * Retrieves current delta CRL number out of CRL issuing point record. - * + * * @return current delta CRL number */ public BigInteger getDeltaCRLNumber(); /** * Retrieves delta CRL size measured by the number of entries. - * + * * @return delta CRL size */ public Long getDeltaCRLSize(); /** * Retrieve Retrieve reference to the first unsaved data. - * + * * @return reference to the first unsaved data */ public String getFirstUnsaved(); /** * Retrieves encoded CRL. - * + * * @return encoded CRL */ public byte[] getCRL(); /** * Retrieves encoded delta CRL. - * + * * @return encoded delta CRL */ public byte[] getDeltaCRL(); /** * Retrieves encoded CA certificate. - * + * * @return encoded CA certificate */ public byte[] getCACert(); /** * Retrieves cache information about CRL. - * + * * @return list of recently revoked certificates */ public Hashtable getCRLCacheNoClone(); @@ -140,21 +140,21 @@ public interface ICRLIssuingPointRecord extends IDBObj { /** * Retrieves cache information about revoked certificates. - * + * * @return list of recently revoked certificates */ public Hashtable getRevokedCerts(); /** * Retrieves cache information about certificates released from hold. - * + * * @return list of certificates recently released from hold */ public Hashtable getUnrevokedCerts(); /** * Retrieves cache information about expired certificates. - * + * * @return list of recently expired certificates */ public Hashtable getExpiredCerts(); diff --git a/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLRepository.java b/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLRepository.java index 806a2cb19..56cbe74d0 100644 --- a/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLRepository.java +++ b/base/common/src/com/netscape/certsrv/dbs/crldb/ICRLRepository.java @@ -30,14 +30,14 @@ import com.netscape.certsrv.dbs.ModificationSet; /** * An interface represents a CMS CRL repository. It stores * all the CRL issuing points. - * + * * @version $Revision$, $Date$ */ public interface ICRLRepository { /** * Adds CRL issuing point record. - * + * * @param rec issuing point record * @exception EBaseException failed to add new issuing point record */ @@ -46,7 +46,7 @@ public interface ICRLRepository { /** * Retrieves all the issuing points' names. - * + * * @return A list of issuing points' names. * @exception EBaseException failed to retrieve all the issuing points' names. */ @@ -54,7 +54,7 @@ public interface ICRLRepository { /** * Reads issuing point record. - * + * * @return issuing point record * @exception EBaseException failed to read issuing point record */ @@ -63,7 +63,7 @@ public interface ICRLRepository { /** * Deletes issuing point record. - * + * * @param id issuing point record id * @exception EBaseException failed to delete issuing point record */ @@ -72,7 +72,7 @@ public interface ICRLRepository { /** * Modifies issuing point record. - * + * * @param id issuing point record id * @param mods set of modifications * @exception EBaseException failed to modify issuing point record @@ -82,7 +82,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record. - * + * * @param id issuing point record id * @param newCRL encoded binary CRL * @param thisUpdate time of this update @@ -97,7 +97,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record. - * + * * @param id issuing point record id * @param newCRL encoded binary CRL * @param thisUpdate time of this update @@ -118,7 +118,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record. - * + * * @param id issuing point record id * @param revokedCerts list of revoked certificates * @param unrevokedCerts list of released from hold certificates @@ -129,7 +129,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record. - * + * * @param id issuing point record id * @param expiredCerts list of expired certificates * @exception EBaseException failed to update issuing point record @@ -139,7 +139,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record. - * + * * @param id issuing point record id * @param crlSize CRL size * @param revokedCerts list of revoked certificates @@ -155,7 +155,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record with delta-CRL. - * + * * @param id issuing point record id * @param deltaCRLNumber delta CRL number * @param deltaCRLSize delta CRL size @@ -171,7 +171,7 @@ public interface ICRLRepository { /** * Updates CRL issuing point record with reference to the first * unsaved data. - * + * * @param id issuing point record id * @param firstUnsaved reference to the first unsaved data * @exception EBaseException failed to update issuing point record diff --git a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecord.java b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecord.java index 6a02c612d..d1eb05f3d 100644 --- a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecord.java +++ b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecord.java @@ -25,7 +25,7 @@ import com.netscape.certsrv.base.EBaseException; /** * An interface contains constants for key record. - * + * * @version $Revision$, $Date$ */ public interface IKeyRecord { @@ -53,7 +53,7 @@ public interface IKeyRecord { /** * Retrieves the state of the key. - * + * * @return key state * @exception EBaseException failed to retrieve state of the key */ @@ -61,7 +61,7 @@ public interface IKeyRecord { /** * Retrieves key identifier. - * + * * @return key id * @exception EBaseException failed to retrieve key id */ @@ -69,7 +69,7 @@ public interface IKeyRecord { /** * Retrieves key owner name. - * + * * @return key owner name * @exception EBaseException failed to retrieve key owner name */ @@ -77,14 +77,14 @@ public interface IKeyRecord { /** * Retrieves key algorithm. - * + * * @return key algorithm */ public String getAlgorithm(); /** * Retrieves key length. - * + * * @return key length * @exception EBaseException failed to retrieve key length */ @@ -123,7 +123,7 @@ public interface IKeyRecord { /** * Retrieves archiver identifier. - * + * * @return archiver uid */ @@ -131,21 +131,21 @@ public interface IKeyRecord { /** * Retrieves creation time. - * + * * @return creation time */ public Date getCreateTime(); /** * Retrieves last modification time. - * + * * @return modification time */ public Date getModifyTime(); /** * Retrieves dates of recovery. - * + * * @return recovery history * @exception EBaseException failed to retrieve recovery history */ @@ -153,7 +153,7 @@ public interface IKeyRecord { /** * Retrieves public key data. - * + * * @return public key data * @exception EBaseException failed to retrieve public key data */ diff --git a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecordList.java b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecordList.java index 75f833892..d55fa2a98 100644 --- a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecordList.java +++ b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRecordList.java @@ -24,21 +24,21 @@ import com.netscape.certsrv.base.EBaseException; /** * A class represents a list of key records. *

- * + * * @version $Revision$, $Date$ */ public interface IKeyRecordList { /** * Retrieves the size of key list. - * + * * @return size of key list */ public int getSize(); /** * Retrieves key records. - * + * * @param startidx start index * @param endidx end index * @return key records diff --git a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java index 627844286..523642aa3 100644 --- a/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java +++ b/base/common/src/com/netscape/certsrv/dbs/keydb/IKeyRepository.java @@ -31,7 +31,7 @@ import com.netscape.certsrv.dbs.repository.IRepository; * An interface represents a Key repository. This is the * container of archived keys. *

- * + * * @version $Revision$, $Date$ */ public interface IKeyRepository extends IRepository { @@ -39,7 +39,7 @@ public interface IKeyRepository extends IRepository { /** * Archives a key to the repository. *

- * + * * @param record key record * @exception EBaseException failed to archive key */ @@ -48,7 +48,7 @@ public interface IKeyRepository extends IRepository { /** * Reads an archived key by serial number. *

- * + * * @param serialNo serial number * @return key record * @exception EBaseException failed to recover key @@ -59,7 +59,7 @@ public interface IKeyRepository extends IRepository { /** * Reads an archived key by b64 encoded cert. *

- * + * * @param cert b64 encoded cert * @return key record * @exception EBaseException failed to recover key @@ -70,7 +70,7 @@ public interface IKeyRepository extends IRepository { /** * Reads an archived key by owner name. *

- * + * * @param ownerName owner name * @return key record * @exception EBaseException failed to recover key @@ -80,7 +80,7 @@ public interface IKeyRepository extends IRepository { /** * Reads archived key using public key. - * + * * @param publicKey public key that is corresponding * to the private key * @return key record @@ -91,7 +91,7 @@ public interface IKeyRepository extends IRepository { /** * Searches for private keys. - * + * * @param filter LDAP filter for the search * @param maxSize maximium number of entries to be returned * @return a list of private key records @@ -102,7 +102,7 @@ public interface IKeyRepository extends IRepository { /** * Searches for private keys. - * + * * @param filter LDAP filter for the search * @param maxSize maximium number of entries to be returned * @param timeLimt timeout value @@ -114,7 +114,7 @@ public interface IKeyRepository extends IRepository { /** * Deletes a key record. - * + * * @param serialno key identifier * @exception EBaseException failed to delete key record */ @@ -123,7 +123,7 @@ public interface IKeyRepository extends IRepository { /** * Modifies key record in this repository. - * + * * @param serialNo key identifier * @param mods modification of key records * @exception EBaseException failed to modify key record @@ -134,7 +134,7 @@ public interface IKeyRepository extends IRepository { /** * Searchs for a list of key records. * Here is a list of supported filter attributes: - * + * * 

      *   keySerialNumber
      *   keyState
@@ -148,7 +148,7 @@ public interface IKeyRepository extends IRepository {
      *   keyModifyTime
      *   keyMetaInfo
      *
- * + * * @param filter search filter * @param attrs list of attributes to be returned * @param pageSize virtual list page size @@ -160,7 +160,7 @@ public interface IKeyRepository extends IRepository { /** * Searchs for a list of key records. - * + * * @param filter search filter * @param attrs list of attributes to be returned * @param sortKey name of attribute that the list should be sorted by diff --git a/base/common/src/com/netscape/certsrv/dbs/keydb/KeyState.java b/base/common/src/com/netscape/certsrv/dbs/keydb/KeyState.java index fa8a0d768..0a81698eb 100644 --- a/base/common/src/com/netscape/certsrv/dbs/keydb/KeyState.java +++ b/base/common/src/com/netscape/certsrv/dbs/keydb/KeyState.java @@ -23,7 +23,7 @@ import java.io.Serializable; * A class represents key state. This object is to * encapsulate the life cycle of a key. *

- * + * * @version $Revision$, $Date$ */ public final class KeyState implements Serializable { @@ -50,7 +50,7 @@ public final class KeyState implements Serializable { /** * Checks if the given object equals to this object. - * + * * @param other object to be compared * @return true if both objects are the same */ @@ -65,7 +65,7 @@ public final class KeyState implements Serializable { /** * Returns the hash code. - * + * * @return hash code */ public int hashCode() { @@ -74,7 +74,7 @@ public final class KeyState implements Serializable { /** * Return the string-representation of this object. - * + * * @return string value */ public String toString() { @@ -90,7 +90,7 @@ public final class KeyState implements Serializable { /** * Converts a string into a key state object. - * + * * @param state state in string-representation * @return key state object */ diff --git a/base/common/src/com/netscape/certsrv/dbs/replicadb/IReplicaIDRepository.java b/base/common/src/com/netscape/certsrv/dbs/replicadb/IReplicaIDRepository.java index 574adfae9..80ca18b08 100644 --- a/base/common/src/com/netscape/certsrv/dbs/replicadb/IReplicaIDRepository.java +++ b/base/common/src/com/netscape/certsrv/dbs/replicadb/IReplicaIDRepository.java @@ -23,7 +23,7 @@ import com.netscape.certsrv.dbs.repository.IRepository; * An interface represents a ReplicaID Repository. * It provides unique managed replica IDs. *

- * + * * @version $Revision$, $Date$ */ public interface IReplicaIDRepository extends IRepository { diff --git a/base/common/src/com/netscape/certsrv/dbs/repository/IRepository.java b/base/common/src/com/netscape/certsrv/dbs/repository/IRepository.java index 943d4a686..39744ac9b 100644 --- a/base/common/src/com/netscape/certsrv/dbs/repository/IRepository.java +++ b/base/common/src/com/netscape/certsrv/dbs/repository/IRepository.java @@ -25,7 +25,7 @@ import com.netscape.certsrv.base.EBaseException; * An interface represents a generic repository. It maintains unique * serial number within repository. *

- * + * * @version $Revision$, $Date$ */ public interface IRepository { @@ -33,7 +33,7 @@ public interface IRepository { /** * Retrieves the next serial number, and also increase the * serial number by one. - * + * * @return serial number * @exception EBaseException failed to retrieve next serial number */ @@ -46,7 +46,7 @@ public interface IRepository { /** * Retrieves the next serial number without increasing the serial number. - * + * * @return serial number * @exception EBaseException failed to retrieve next serial number */ @@ -54,7 +54,7 @@ public interface IRepository { /** * Set the maximum serial number. - * + * * @param serial maximum number * @exception EBaseException failed to set maximum serial number */ @@ -62,7 +62,7 @@ public interface IRepository { /** * Set the maximum serial number in next range. - * + * * @param serial maximum number * @exception EBaseException failed to set maximum serial number in next range */ @@ -71,7 +71,7 @@ public interface IRepository { /** * 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; @@ -79,7 +79,7 @@ public interface IRepository { /** * Sets whether serial number management is enabled for certs * and requests. - * + * * @param value true/false * @exception EBaseException failed to set */ diff --git a/base/common/src/com/netscape/certsrv/dbs/repository/IRepositoryRecord.java b/base/common/src/com/netscape/certsrv/dbs/repository/IRepositoryRecord.java index c46e8419c..12dc71c46 100644 --- a/base/common/src/com/netscape/certsrv/dbs/repository/IRepositoryRecord.java +++ b/base/common/src/com/netscape/certsrv/dbs/repository/IRepositoryRecord.java @@ -25,7 +25,7 @@ import com.netscape.certsrv.dbs.IDBObj; * An interface represents a generic repository record. * It maintains unique serial number within repository. *

- * + * * @version $Revision$, $Date$ */ public interface IRepositoryRecord extends IDBObj { @@ -35,7 +35,7 @@ public interface IRepositoryRecord extends IDBObj { /** * Retrieves serial number. - * + * * @return serial number */ public BigInteger getSerialNumber(); -- cgit