diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/connector')
8 files changed, 89 insertions, 73 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/connector/IConnector.java b/pki/base/common/src/com/netscape/certsrv/connector/IConnector.java index d14d948e..6dcca9d2 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IConnector.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IConnector.java @@ -17,17 +17,20 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + import com.netscape.certsrv.base.EBaseException; 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: - * + * 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,21 +39,21 @@ import com.netscape.certsrv.request.IRequest; * 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.maxHttpConns=10 #Max 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. + * @exception EBaseException Failure to send request to remote authority. */ - public boolean send(IRequest req) throws EBaseException; + public boolean send(IRequest req) + throws EBaseException; /** * Starts this connector. diff --git a/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java b/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java index 154d1e95..c53c6f09 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnFactory.java @@ -17,32 +17,35 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + import com.netscape.certsrv.base.EBaseException; /** - * Maintains a pool of connections to to a Remote Authority. Utilized by the - * IHttpConnector interface. 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. - * + * Maintains a pool of connections to to a Remote Authority. + * Utilized by the IHttpConnector interface. + * 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 + * @return Ldap connection object. + * connection is not available */ - public IHttpConnection getConn() throws EBaseException; + public IHttpConnection getConn() + throws EBaseException; /** * 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 EBaseException On any failure to return the connection. */ - public void returnConn(IHttpConnection conn) throws EBaseException; + public void returnConn(IHttpConnection conn) + throws EBaseException; } diff --git a/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java b/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java index 97c37fa3..6ee57059 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IHttpConnection.java @@ -17,23 +17,26 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + import com.netscape.certsrv.base.EBaseException; + /** - * This represents a HTTP connection to a remote authority. Http connection is - * used by the connector to send 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. - * + * This represents a HTTP connection to a remote authority. + * Http connection is used by the connector to send + * 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. */ - public IPKIMessage send(IPKIMessage tomsg) throws EBaseException; + public IPKIMessage send(IPKIMessage tomsg) + throws EBaseException; } diff --git a/pki/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java b/pki/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java index a6c47a86..5cb53e25 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IHttpPKIMessage.java @@ -17,40 +17,39 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + 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. - * + * 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/pki/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java b/pki/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java index 50b447a2..57ce9700 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IPKIMessage.java @@ -17,52 +17,53 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + import java.io.Serializable; 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. - * + * 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. - */ + * + * 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(); /** - * Makes a PKIMessage from a request PKIMessage will be sent to wire. - * + * Makes a PKIMessage from a request + * PKIMessage will be sent to wire. * @param r Request to copy from. */ public void fromRequest(IRequest r); /** - * Copies contents of PKIMessage to the request PKIMessage is from the wire. - * + * 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/pki/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java b/pki/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java index 8353ef27..a97936aa 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IRemoteAuthority.java @@ -17,38 +17,38 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + + + /** - * This represents a remote authority that can be a certificate manager, or key - * recovery manager or some other manager. - * + * 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/pki/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java b/pki/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java index f91d5eee..7838aa5e 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IRequestEncoder.java @@ -17,30 +17,34 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + 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. - * + * 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. */ - String encode(Object r) throws IOException; + String encode(Object r) + throws IOException; /** - * Dncodes a String into an object. - * + * 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. */ - Object decode(String s) throws IOException; + Object decode(String s) + throws IOException; } + diff --git a/pki/base/common/src/com/netscape/certsrv/connector/IResender.java b/pki/base/common/src/com/netscape/certsrv/connector/IResender.java index fad3c2a8..3574c3a5 100644 --- a/pki/base/common/src/com/netscape/certsrv/connector/IResender.java +++ b/pki/base/common/src/com/netscape/certsrv/connector/IResender.java @@ -17,22 +17,25 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.connector; + import com.netscape.certsrv.request.IRequest; + /** - * Resend requests at intervals to the server to ensure completion of requests. - * 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. - * + * Resend requests at intervals to the server to ensure completion of requests. + * 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); - + } + |