diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/connector')
8 files changed, 33 insertions, 33 deletions
diff --git a/base/common/src/com/netscape/certsrv/connector/IConnector.java b/base/common/src/com/netscape/certsrv/connector/IConnector.java index 202fb0794..61001be5b 100644 --- a/base/common/src/com/netscape/certsrv/connector/IConnector.java +++ b/base/common/src/com/netscape/certsrv/connector/IConnector.java @@ -23,12 +23,12 @@ import com.netscape.certsrv.request.IRequest; /** * This interface represents a connector that forwards * CMS requests to a remote authority. - * + * * To register a connector, one can add the following * to the CMS.cfg: - * + * * <pre> - * + * * Example for KRA type connector. * ca.connector.KRA.enable=true * ca.connector.KRA.host=thehost.netscape.com #Remote host. @@ -36,17 +36,17 @@ import com.netscape.certsrv.request.IRequest; * ca.connector.KRA.nickName="cert-kra" #Nickname of connector for identity purposes. * ca.connector.KRA.uri="/kra/connector" #Uri of the KRA server. * ca.connector.KRA.id="kra" - * ca.connector.KRA.minHttpConns=1 #Min connection pool connections. + * ca.connector.KRA.minHttpConns=1 #Min connection pool connections. * ca.connector.KRA.maxHttpConns=10 #Max connection pool connections. * </pre> - * + * * @version $Revision$, $Date$ */ public interface IConnector { /** * Sends the request to a remote authority. - * + * * @param req Request to be forwarded to remote authority. * @return true for success, otherwise false. * @exception EBaseException Failure to send request to remote authority. diff --git a/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java b/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java index 27a94a57f..55c537cff 100644 --- a/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java +++ b/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java @@ -25,14 +25,14 @@ import com.netscape.certsrv.base.EBaseException; * Multiple threads use this interface to utilize and release * the Ldap connection resources. This factory will maintain a * list of Http type connections to the remote host. - * + * * @version $Revision$, $Date$ */ public interface IHttpConnFactory { /** * Request access to a Ldap connection from the pool. - * + * * @exception EBaseException if any error occurs, such as a * @return Ldap connection object. * connection is not available @@ -42,7 +42,7 @@ public interface IHttpConnFactory { /** * Return connection to the factory. mandatory after a getConn(). - * + * * @param conn Ldap connection object to be returned to the free list of the pool. * @exception EBaseException On any failure to return the connection. */ diff --git a/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java b/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java index d1652dc90..8adc7da72 100644 --- a/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java +++ b/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java @@ -25,14 +25,14 @@ import com.netscape.certsrv.base.EBaseException; * PKI messages to a remote authority. The remote authority * will reply with a PKI message as well. An example would * be the communication between a CA and a KRA. - * + * * @version $Revision$, $Date$ */ public interface IHttpConnection { /** * Sends the PKI message to the remote authority. - * + * * @param tomsg Message to forward to authority. * @exception EBaseException Failed to send message. */ diff --git a/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java b/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java index efa49126e..14b4b8648 100644 --- a/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java +++ b/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java @@ -23,35 +23,35 @@ import com.netscape.certsrv.request.IRequest; * This represents a Http PKI message. It contains * simple name/value pair values. Also maintains information * about the status and type of the message. - * + * * @version $Revision$, $Date$ */ public interface IHttpPKIMessage extends IPKIMessage { /** * Retrieves the request type. - * + * * @return String with the type of request. */ public String getReqType(); /** * Retrieves the request identifier. - * + * * @return String of name of request. */ public String getReqId(); /** * Copies contents of request to make a simple name/value message. - * + * * @param r Instance of IRequest to be copied from. */ public void fromRequest(IRequest r); /** * Copies contents to request. - * + * * @param r Instance of IRequest to be copied to. */ public void toRequest(IRequest r); diff --git a/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java b/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java index 787dd8385..ca352aa82 100644 --- a/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java +++ b/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java @@ -25,29 +25,29 @@ import com.netscape.certsrv.request.IRequest; * Messages that are serialized and go over the wire. * It must be serializable, and * later will be inherited by CRMF message. - * + * * @version $Revision$, $Date$ */ public interface IPKIMessage extends Serializable { /** - * + * * Returns status of request. - * + * * @return String of request status. */ public String getReqStatus(); /** * Retrieves the request type. - * + * * @return String of type of request. */ public String getReqType(); /** * Retrieves the request identifer. - * + * * @return String of name of request. */ public String getReqId(); @@ -55,7 +55,7 @@ public interface IPKIMessage extends Serializable { /** * Makes a PKIMessage from a request * PKIMessage will be sent to wire. - * + * * @param r Request to copy from. */ public void fromRequest(IRequest r); @@ -63,7 +63,7 @@ public interface IPKIMessage extends Serializable { /** * Copies contents of PKIMessage to the request * PKIMessage is from the wire. - * + * * @param r Request to copy to. */ public void toRequest(IRequest r); diff --git a/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java b/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java index 50a3aea5f..f02154021 100644 --- a/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java +++ b/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java @@ -21,35 +21,35 @@ package com.netscape.certsrv.connector; * This represents a remote authority that can be * a certificate manager, or key recovery manager or * some other manager. - * + * * @version $Revision$, $Date$ */ public interface IRemoteAuthority { /** * Retrieves the host name of the remote Authority. - * + * * @return String with the name of host of remote Authority. */ public String getHost(); /** * Retrieves the port number of the remote Authority. - * + * * @return Int with port number of remote Authority. */ public int getPort(); /** * Retrieves the URI of the remote Authority. - * + * * @return String with URI of remote Authority. */ public String getURI(); /** * Retrieves the timeout value for the connection to the remote Authority. - * + * * @return In with remote Authority timeout value. */ public int getTimeout(); diff --git a/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java b/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java index 478af4174..c390f7ac3 100644 --- a/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java +++ b/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java @@ -23,14 +23,14 @@ import java.io.IOException; * This represents a rquest encoder that serializes and * deserializes a request to a Remote Authority so that it can be sent through * the connector. - * + * * @version $Revision$, $Date$ */ public interface IRequestEncoder { /** * Encodes a request object. - * + * * @param r Object to serve as the source of the message. * @return String containing encoded message. * @exception IOException Failure of the encoding operation due to IO error. @@ -40,7 +40,7 @@ public interface IRequestEncoder { /** * Dncodes a String into an object. - * + * * @return Object which is the result of the decoded message. * @exception IOException Failure of the decoding operation due to IO error. */ diff --git a/base/common/src/com/netscape/certsrv/connector/IResender.java b/base/common/src/com/netscape/certsrv/connector/IResender.java index 85d3e364c..b1cd6149e 100644 --- a/base/common/src/com/netscape/certsrv/connector/IResender.java +++ b/base/common/src/com/netscape/certsrv/connector/IResender.java @@ -24,14 +24,14 @@ import com.netscape.certsrv.request.IRequest; * Default interval is 5 minutes. The need to resend a message could arise * due to an error or the fact that the message could not be serviced * immediately. - * + * * @version $Revision$, $Date$ */ public interface IResender extends Runnable { /** * Adds the request to the resend queue. - * + * * @param r Request to be placed on the resend queue. */ public void addRequest(IRequest r); |