diff options
author | Ade Lee <alee@redhat.com> | 2011-12-08 21:15:59 -0500 |
---|---|---|
committer | Ade Lee <alee@redhat.com> | 2011-12-08 21:15:59 -0500 |
commit | 171aaece4f23709d33d180cf36eb3af5e454b0c9 (patch) | |
tree | 1485f9f0a7bd10de4ff25030db575dbb8dafae74 /pki/base/common/src/com/netscape/certsrv/ldap | |
parent | adad2fcee8a29fdb82376fbce07dedb11fccc182 (diff) | |
download | pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.gz pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.xz pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.zip |
Revert "Formatting"
This reverts commit 32150d3ee32f8ac27118af7c792794b538c78a2f.
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/ldap')
8 files changed, 107 insertions, 106 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ELdapException.java b/pki/base/common/src/com/netscape/certsrv/ldap/ELdapException.java index 0e0813ace..ab2d361ba 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ELdapException.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ELdapException.java @@ -17,13 +17,15 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import com.netscape.certsrv.base.EBaseException; + /** - * A class that represents a Ldap exception. Various errors can occur when - * interacting with a Ldap directory server. + * A class that represents a Ldap exception. Various + * errors can occur when interacting with a Ldap directory server. * <P> - * + * * @version $Revision$, $Date$ */ public class ELdapException extends EBaseException { @@ -35,25 +37,23 @@ public class ELdapException extends EBaseException { /** * Ldap resource class name. */ - private static final String LDAP_RESOURCES = LdapResources.class.getName(); + private static final String LDAP_RESOURCES = LdapResources.class.getName(); /** - * Constructs a Ldap exception. - * + * Constructs a Ldap exception. * @param msgFormat Resource Key, if key not present, serves as the message. - * <P> + * <P> */ public ELdapException(String msgFormat) { super(msgFormat); } /** - * Constructs a Ldap exception. - * + * Constructs a Ldap exception. * @param msgFormat Resource Key, if key not present, serves as the message. - * Include a message string parameter for variable content. + * Include a message string parameter for variable content. * @param param Message string parameter. - * <P> + * <P> */ public ELdapException(String msgFormat, String param) { super(msgFormat, param); @@ -61,21 +61,19 @@ public class ELdapException extends EBaseException { /** * Constructs a Ldap exception. - * * @param msgFormat Resource Key, if key not present, serves as the message. - * @param e Common exception. - * <P> + * @param e Common exception. + * <P> */ public ELdapException(String msgFormat, Exception e) { super(msgFormat, e); } /** - * Constructs a Ldap exception. - * + * Constructs a Ldap exception. * @param msgFormat Resource Key, if key not present, serves as the message. * @param params Array of Message string parameters. - * <P> + * <P> */ public ELdapException(String msgFormat, Object params[]) { super(msgFormat, params); @@ -83,9 +81,8 @@ public class ELdapException extends EBaseException { /** * Gets the resource bundle name - * * @return Name of the Ldap Exception resource bundle name. - * <p> + * <p> */ protected String getBundleName() { return LDAP_RESOURCES; diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ELdapServerDownException.java b/pki/base/common/src/com/netscape/certsrv/ldap/ELdapServerDownException.java index f347b1714..ead1a0201 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ELdapServerDownException.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ELdapServerDownException.java @@ -17,9 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + /** * This represents exception which indicates Ldap server is down. - * + * * @version $Revision$, $Date$ */ public class ELdapServerDownException extends ELdapException { @@ -31,7 +32,6 @@ public class ELdapServerDownException extends ELdapException { /** * Constructs a ldap server down exception with host & port info. - * * @param errorString Detailed error message. */ public ELdapServerDownException(String errorString) { diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java index b62cf20b8..46082c73a 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java @@ -17,9 +17,11 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; + /** * Class for obtaining ldap authentication info from the configuration store. * Two types of authentication is basic and SSL client authentication. @@ -37,30 +39,28 @@ public interface ILdapAuthInfo { static public final String LDAP_BASICAUTH_STR = "BasicAuth"; static public final String LDAP_SSLCLIENTAUTH_STR = "SslClientAuth"; - static public final int LDAP_AUTHTYPE_NONE = 0; // illegal + static public final int LDAP_AUTHTYPE_NONE = 0; // illegal static public final int LDAP_AUTHTYPE_BASICAUTH = 1; static public final int LDAP_AUTHTYPE_SSLCLIENTAUTH = 2; /** * Initialize this class from the config store. - * * @param config The config store from which to initialize. * @exception EBaseException Due to failure of the initialization process. - * + * */ public void init(IConfigStore config) throws EBaseException; /** - * Initialize this class from the config store. Based on host, port, and - * secure boolean info. which allows an actual attempt on the server to - * verify credentials. - * + * Initialize this class from the config store. + * Based on host, port, and secure boolean info. + * which allows an actual attempt on the server to verify credentials. * @param config The config store from which to initialize. * @exception EBaseException Due to failure of the initialization process. - * + * */ public void init(IConfigStore config, String host, int port, boolean secure) - throws EBaseException; + throws EBaseException; /** * Reset the connection to the host @@ -68,33 +68,28 @@ public interface ILdapAuthInfo { public void reset(); /** - * Get authentication type. - * + * Get authentication type. * @return one of: <br> - * LdapAuthInfo.LDAP_AUTHTYPE_BASICAUTH or - * LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH + * LdapAuthInfo.LDAP_AUTHTYPE_BASICAUTH or + * LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH */ public int getAuthType(); /** * Get params for authentication. - * - * @return array of parameters for this authentication as an array of - * Strings. + * @return array of parameters for this authentication as an array of Strings. */ public String[] getParms(); /** * Add password to private password data structure. - * * @param prompt Password prompt. - * @param pw Password itself. + * @param pw Password itself. */ public void addPassword(String prompt, String pw); /** * Remove password from private password data structure. - * * @param prompt Identify password to remove with prompt. */ public void removePassword(String prompt); diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapBoundConnFactory.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapBoundConnFactory.java index 0fac8d358..ef3e17424 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapBoundConnFactory.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapBoundConnFactory.java @@ -17,14 +17,18 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + + + /** - * Maintains a pool of connections to the LDAP server. CMS requests are - * processed on a multi threaded basis. A pool of connections then must be be - * maintained so this access to the Ldap server can be easily managed. The min - * and max size of this connection pool should be configurable. Once the maximum - * limit of connections is exceeded, the factory should provide proper - * synchronization to resolve contention issues. - * + * Maintains a pool of connections to the LDAP server. + * CMS requests are processed on a multi threaded basis. + * A pool of connections then must be be maintained so this + * access to the Ldap server can be easily managed. The min and + * max size of this connection pool should be configurable. Once + * the maximum limit of connections is exceeded, the factory + * should provide proper synchronization to resolve contention issues. + * * @version $Revision$, $Date$ */ public interface ILdapBoundConnFactory extends ILdapConnFactory { diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java index 35a074047..f706c2ecf 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnFactory.java @@ -17,75 +17,76 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import netscape.ldap.LDAPConnection; import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; + /** - * Maintains a pool of connections to the LDAP server. Multiple threads use this - * interface to utilize and release the Ldap connection resources. - * + * Maintains a pool of connections to the LDAP server. + * Multiple threads use this interface to utilize and release + * the Ldap connection resources. + * * @version $Revision$, $Date$ */ public interface ILdapConnFactory { - /** + /** * Initialize the poll from the config store. - * * @param config The configuration substore. * @exception EBaseException On configuration error. - * @exception ELdapException On all other errors. + * @exception ELdapException On all other errors. */ - public void init(IConfigStore config) throws EBaseException, ELdapException; + public void init(IConfigStore config) + throws EBaseException, ELdapException; /** - * - * Used for disconnecting all connections. Used just before a subsystem + * + * Used for disconnecting all connections. + * Used just before a subsystem * shutdown or process exit. - * * @exception EldapException on Ldap failure when closing connections. */ - public void reset() throws ELdapException; + public void reset() + throws ELdapException; /** * Returns the number of free connections available from this pool. - * - * @return Integer number of free connections. - */ + * @return Integer number of free connections. + */ public int freeConn(); /** * Returns the number of total connections available from this pool. * Includes sum of free and in use connections. - * * @return Integer number of total connections. */ public int totalConn(); /** * Returns the maximum number of connections available from this pool. - * * @return Integer maximum number of connections. */ public int maxConn(); - /** - * Request access to a Ldap connection from the pool. - * - * @exception ELdapException if any error occurs, such as a - * @return Ldap connection object. connection is not available + /** + * Request access to a Ldap connection from the pool. + * @exception ELdapException if any error occurs, such as a + * @return Ldap connection object. + * connection is not available */ - public LDAPConnection getConn() throws ELdapException; + public LDAPConnection getConn() + throws ELdapException; /** * Return connection to the factory. mandatory after a getConn(). - * - * @param conn Ldap connection object to be returned to the free list of the - * pool. + * @param conn Ldap connection object to be returned to the free list of the pool. * @exception ELdapException On any failure to return the connection. */ - public void returnConn(LDAPConnection conn) throws ELdapException; + public void returnConn(LDAPConnection conn) + throws ELdapException; } diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnInfo.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnInfo.java index 4eec994aa..4cffbe458 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnInfo.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnInfo.java @@ -17,14 +17,15 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; + /** - * Class for reading ldap connection information from the config store. Ldap - * connection info: host name, port number,whether of not it is a secure - * connection. - * + * Class for reading ldap connection information from the config store. + * Ldap connection info: host name, port number,whether of not it is a secure connection. + * * @version $Revision$, $Date$ */ public interface ILdapConnInfo { @@ -41,24 +42,23 @@ public interface ILdapConnInfo { /** * Initializes an instance from a config store. - * * @param config Configuration store. * @exception ELdapException Ldap related error found. - * @exception EBaseException Other errors and errors with params included in - * the config store. + * @exception EBaseException Other errors and errors with params included in the config store. */ public void init(IConfigStore config) throws EBaseException, ELdapException; /** - * Return the name of the Host. - * + * Return the name of the Host. + * */ + public String getHost(); /** * Return the port number of the host. - * + * */ public int getPort(); @@ -74,8 +74,8 @@ public interface ILdapConnInfo { public boolean getSecure(); /** - * Return whether or not the server is to follow referrals to other servers - * when servicing a query. + * Return whether or not the server is to follow referrals + * to other servers when servicing a query. */ public boolean getFollowReferrals(); diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnModule.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnModule.java index 601bfde8d..8d912fc55 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnModule.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapConnModule.java @@ -17,44 +17,45 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import com.netscape.certsrv.base.EBaseException; import com.netscape.certsrv.base.IConfigStore; import com.netscape.certsrv.base.ISubsystem; + /** - * Class on behalf of the Publishing system that controls an instance of an - * ILdapConnFactory. Allows a factory to be intialized and grants access to the - * factory to other interested parties. - * + * Class on behalf of the Publishing system that controls an instance of an ILdapConnFactory. + * Allows a factory to be intialized and grants access + * to the factory to other interested parties. + * * @version $Revision$, $Date$ */ - + public interface ILdapConnModule { /** * Initialize ldap publishing module with config store. - * * @param owner Entity that is interested in this instance of Publishing. - * @param config Config store containing the info needed to set up - * Publishing. + * @param config Config store containing the info needed to set up Publishing. * @exception ELdapException Due to Ldap error. - * @exception EBaseException Due to config value errors and all other - * errors. + * @exception EBaseException Due to config value errors and all other errors. */ - public void init(ISubsystem owner, IConfigStore config) - throws EBaseException, ELdapException; + public void init(ISubsystem owner, IConfigStore config) + throws EBaseException, ELdapException; /** - * Returns the internal ldap connection factory. This can be useful to get a - * ldap connection to the ldap publishing directory without having to get it - * again from the config file. Note that this means sharing a ldap - * connection pool with the ldap publishing module so be sure to return - * connections to pool. Use ILdapConnFactory.getConn() to get a Ldap - * connection to the ldap publishing directory. Use - * ILdapConnFactory.returnConn() to return the connection. - * + * Returns the internal ldap connection factory. + * This can be useful to get a ldap connection to the + * ldap publishing directory without having to get it again from the + * config file. Note that this means sharing a ldap connection pool + * with the ldap publishing module so be sure to return connections to pool. + * Use ILdapConnFactory.getConn() to get a Ldap connection to the ldap + * publishing directory. + * Use ILdapConnFactory.returnConn() to return the connection. + * * @return Instance of ILdapConnFactory. */ public ILdapConnFactory getLdapConnFactory(); } + diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/LdapResources.java b/pki/base/common/src/com/netscape/certsrv/ldap/LdapResources.java index ee2d307cc..261497380 100644 --- a/pki/base/common/src/com/netscape/certsrv/ldap/LdapResources.java +++ b/pki/base/common/src/com/netscape/certsrv/ldap/LdapResources.java @@ -17,8 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.ldap; + import java.util.ListResourceBundle; + /** * A resource bundle for ldap subsystem. * @@ -34,7 +36,8 @@ public class LdapResources extends ListResourceBundle { } /** - * Constants. The suffix represents the number of possible parameters. + * Constants. The suffix represents the number of + * possible parameters. */ static final Object[][] contents = {}; |