diff options
author | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
---|---|---|
committer | Ade Lee <alee@redhat.com> | 2011-12-07 16:58:12 -0500 |
commit | 32150d3ee32f8ac27118af7c792794b538c78a2f (patch) | |
tree | 52dd96f664a6fa51be25b28b6f10adc5f2c9f660 /pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java | |
parent | f05d58a46795553beb8881039cc922974b40db34 (diff) | |
download | pki-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/IDBRegistry.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java | 81 |
1 files changed, 37 insertions, 44 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java b/pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java index 4270c9ced..fd6096b72 100644 --- a/pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java +++ b/pki/base/common/src/com/netscape/certsrv/dbs/IDBRegistry.java @@ -17,42 +17,37 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.dbs; - import netscape.ldap.LDAPAttributeSet; import com.netscape.certsrv.base.EBaseException; 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$ + * 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 */ public void registerObjectClass(String className, String ldapNames[]) - throws EDBException; + throws EDBException; /** * See if an object class is registered. - * + * * @param className java class to create * @return true if object class is registered already */ @@ -60,17 +55,17 @@ 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 */ - public void registerAttribute(String ufName, IDBAttrMapper mapper) - throws EDBException; + public void registerAttribute(String ufName, IDBAttrMapper mapper) + throws EDBException; /** * See if an attribute is registered. - * + * * @param ufName attribute name * @return true if attribute is registered already */ @@ -78,14 +73,15 @@ public interface IDBRegistry extends ISubsystem { /** * Registers a dynamic attribute mapper. + * * @param mapper The dynamic mapper to register */ public void registerDynamicMapper(IDBDynAttrMapper mapper); /** - * Creates LDAP-based search filters with help of - * registered mappers. - * Parses filter from filter string specified in RFC1558. + * Creates LDAP-based search filters with help of registered mappers. Parses + * filter from filter string specified in RFC1558. + * * <pre> * <filter> ::= '(' <filtercomp> ')' * <filtercomp> ::= <and> | <or> | <not> | <item> @@ -107,7 +103,7 @@ public interface IDBRegistry extends ISubsystem { * <starval> ::= NULL | <value> '*' <starval> * <final> ::= NULL | <value> * </pre> - * + * * @param filter CMS-based filter * @return LDAP-based filter string * @exception EBaseException failed to convert filter @@ -115,57 +111,54 @@ public interface IDBRegistry extends ISubsystem { public String getFilter(String filter) throws EBaseException; /** - * Creates LDAP-based search filters with help of - * registered mappers. - * + * Creates LDAP-based search filters with help of registered mappers. + * * @param filter CMS-based filter * @param c filter converter * @return LDAP-based filter string * @exception EBaseException failed to convert filter */ - public String getFilter(String filter, IFilterConverter c) - throws EBaseException; + public String getFilter(String filter, IFilterConverter c) + throws EBaseException; /** * Maps object into LDAP attribute set. - * + * * @param parent object's parent * @param name name of the object * @param obj object to be mapped * @param attrs LDAP attribute set * @exception EBaseException failed to map object */ - public void mapObject(IDBObj parent, String name, Object obj, - LDAPAttributeSet attrs) throws EBaseException; + public void mapObject(IDBObj parent, String name, Object obj, + LDAPAttributeSet attrs) throws EBaseException; /** - * Retrieves a list of LDAP attributes that are associated - * with the given attributes. - * + * 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 */ - public String[] getLDAPAttributes(String attrs[]) - throws EBaseException; + public String[] getLDAPAttributes(String attrs[]) throws EBaseException; /** * Creates attribute set from object. - * + * * @param obj database object * @return LDAP attribute set * @exception EBaseException failed to create set */ - public LDAPAttributeSet createLDAPAttributeSet(IDBObj obj) - throws EBaseException; + public LDAPAttributeSet createLDAPAttributeSet(IDBObj obj) + throws EBaseException; /** * Creates object from attribute set. - * + * * @param attrs LDAP attribute set * @return database object * @exception EBaseException failed to create object */ - public IDBObj createObject(LDAPAttributeSet attrs) - throws EBaseException; + public IDBObj createObject(LDAPAttributeSet attrs) throws EBaseException; } |