diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java')
| -rw-r--r-- | pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java | 108 |
1 files changed, 60 insertions, 48 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java b/pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java index 298c2811..34df47c9 100644 --- a/pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java +++ b/pki/base/common/src/com/netscape/certsrv/dbs/IDBSSession.java @@ -17,42 +17,45 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.dbs; + import netscape.ldap.LDAPSearchResults; import com.netscape.certsrv.base.EBaseException; 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$ + * 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, - * * <PRE> - * session.add("cn=123459,o=certificate repository,o=airius.com", certRec); + * session.add("cn=123459,o=certificate repository,o=airius.com", + * certRec); * </PRE> - * + * * @param name name of the object * @param obj object to be added * @exception EDBException failed to add object @@ -61,7 +64,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 @@ -69,19 +72,20 @@ public interface IDBSSession { public IDBObj read(String name) throws EBaseException; /** - * Reads an object from the database, and only populates the selected - * attributes. - * + * 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 * @exception EBaseException failed to read object */ - public IDBObj read(String name, String attrs[]) throws EBaseException; + public IDBObj read(String name, String attrs[]) + throws EBaseException; /** * Deletes object from database. - * + * * @param name name of the object that is to be deleted * @exception EBaseException failed to delete object */ @@ -89,39 +93,43 @@ 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 */ - public void modify(String name, ModificationSet mods) throws EBaseException; + public void modify(String name, ModificationSet mods) + throws EBaseException; /** - * Searchs for a list of objects that match the filter. - * + * Searchs for a list of objects that match the + * filter. + * * @param base starting point of the search * @param filter search filter * @return search results * @exception EBaseException failed to search */ - public IDBSearchResults search(String base, String filter) - throws EBaseException; + public IDBSearchResults search(String base, String filter) + throws EBaseException; /** - * Searchs for a list of objects that match the filter. - * + * 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 * @return search results * @exception EBaseException failed to search */ - public IDBSearchResults search(String base, String filter, int maxSize) - throws EBaseException; + public IDBSearchResults search(String base, String filter, int maxSize) + throws EBaseException; /** - * Searchs for a list of objects that match the filter. - * + * 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 @@ -129,36 +137,38 @@ public interface IDBSSession { * @return search results * @exception EBaseException failed to search */ - public IDBSearchResults search(String base, String filter, int maxSize, - int timeLimit) throws EBaseException; + public IDBSearchResults search(String base, String filter, int maxSize, + int timeLimit) throws EBaseException; /** - * Retrieves a list of object that satifies the given filter. - * + * 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 * @return search results * @exception EBaseException failed to search */ - public IDBSearchResults search(String base, String filter, String attrs[]) - throws EBaseException; + public IDBSearchResults search(String base, String filter, + String attrs[]) throws EBaseException; /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes * @return search results in virtual list * @exception EBaseException failed to search */ - public IDBVirtualList createVirtualList(String base, String filter, - String attrs[]) throws EBaseException; + public IDBVirtualList createVirtualList(String base, String filter, + String attrs[]) throws EBaseException; /** - * Sets persistent search to retrieve modified certificate records. - * + * Sets persistent search to retrieve modified + * certificate records. + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -166,11 +176,11 @@ public interface IDBSSession { * @exception EBaseException failed to search */ public LDAPSearchResults persistentSearch(String base, String filter, - String attrs[]) throws EBaseException; + String attrs[]) throws EBaseException; /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -179,12 +189,13 @@ public interface IDBSSession { * @return search results in virtual list * @exception EBaseException failed to search */ - public IDBVirtualList createVirtualList(String base, String filter, - String attrs[], String sortKey, int pageSize) throws EBaseException; + public IDBVirtualList createVirtualList(String base, String filter, + String attrs[], String sortKey, int pageSize) + throws EBaseException; /** * Retrieves a list of objects. - * + * * @param base starting point of the search * @param filter search filter * @param attrs selected attributes @@ -194,7 +205,8 @@ public interface IDBSSession { * @return search results in virtual list * @exception EBaseException failed to search */ - public IDBVirtualList createVirtualList(String base, String filter, - String attrs[], String startFrom, String sortKey, int pageSize) - throws EBaseException; + public IDBVirtualList createVirtualList(String base, String filter, + String attrs[], String startFrom, + String sortKey, int pageSize) + throws EBaseException; } |