diff options
| author | Endi Sukma Dewata <edewata@redhat.com> | 2012-04-05 14:49:11 -0500 |
|---|---|---|
| committer | Endi Sukma Dewata <edewata@redhat.com> | 2012-04-09 10:03:25 -0500 |
| commit | 7c7b9d023cd466c1771068badc020dab36beb553 (patch) | |
| tree | 178877eb83e25336be7577953945fbdb0b9e1a15 /base/common/src/com/netscape/certsrv/request | |
| parent | da1e6e2f49f66fd46c8039ff1aa4386309fba8f4 (diff) | |
| download | pki-7c7b9d023cd466c1771068badc020dab36beb553.tar.gz pki-7c7b9d023cd466c1771068badc020dab36beb553.tar.xz pki-7c7b9d023cd466c1771068badc020dab36beb553.zip | |
Removed whitespaces from Java code.
Whitespaces in Java code have been removed with the following command:
find . -not -path .git -name *.java -exec sed -i 's/[[:blank:]]\+$//' {} \;
Ticket #134
Diffstat (limited to 'base/common/src/com/netscape/certsrv/request')
21 files changed, 200 insertions, 200 deletions
diff --git a/base/common/src/com/netscape/certsrv/request/ARequestNotifier.java b/base/common/src/com/netscape/certsrv/request/ARequestNotifier.java index a50996f2b..98338601a 100644 --- a/base/common/src/com/netscape/certsrv/request/ARequestNotifier.java +++ b/base/common/src/com/netscape/certsrv/request/ARequestNotifier.java @@ -32,7 +32,7 @@ import com.netscape.certsrv.publish.IPublisherProcessor; /** * The ARequestNotifier class implements the IRequestNotifier interface, * which notifies all registered request listeners. - * + * * @version $Revision$, $Date$ */ public class ARequestNotifier implements IRequestNotifier { @@ -106,18 +106,18 @@ public class ARequestNotifier implements IRequestNotifier { /** * Registers a request listener. - * + * * @param listener listener to be registered */ public void registerListener(IRequestListener listener) { // XXX should check for duplicates here or allow listeners - // to register twice and call twice ? + // to register twice and call twice ? mListeners.put(listener.getClass().getName(), listener); } /** * Registers a request listener. - * + * * @param name listener name * @param listener listener to be registered */ @@ -127,18 +127,18 @@ public class ARequestNotifier implements IRequestNotifier { /** * Removes listener from the list of registered listeners. - * + * * @param listener listener to be removed from the list */ public void removeListener(IRequestListener listener) { // XXX should check for duplicates here or allow listeners - // to register twice and call twice ? + // to register twice and call twice ? mListeners.remove(listener.getClass().getName()); } /** * Gets list of listener names. - * + * * @return enumeration of listener names */ public Enumeration<String> getListenerNames() { @@ -147,7 +147,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Removes listener from the list of registered listeners. - * + * * @param name listener name to be removed from the list */ public void removeListener(String name) { @@ -156,7 +156,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Gets listener from the list of registered listeners. - * + * * @param name listener name * @return listener */ @@ -166,7 +166,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Gets list of listeners. - * + * * @return enumeration of listeners */ public Enumeration<IRequestListener> getListeners() { @@ -196,7 +196,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Gets request from publishing queue. - * + * * @return request */ public synchronized IRequest getRequest() { @@ -232,7 +232,7 @@ public class ARequestNotifier implements IRequestNotifier { if (!(requestType.equals(IRequest.ENROLLMENT_REQUEST) || requestType.equals(IRequest.RENEWAL_REQUEST) || requestType.equals(IRequest.REVOCATION_REQUEST) || - requestType.equals(IRequest.CMCREVOKE_REQUEST) || + requestType.equals(IRequest.CMCREVOKE_REQUEST) || requestType.equals(IRequest.UNREVOCATION_REQUEST))) { continue; } @@ -287,7 +287,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Gets number of requests in publishing queue. - * + * * @return number of requests in publishing queue */ public int getNumberOfRequests() { @@ -296,7 +296,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Checks if publishing queue is enabled. - * + * * @return true if publishing queue is enabled, false otherwise */ public boolean isPublishingQueueEnabled() { @@ -305,7 +305,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Removes a notifier thread from the pool of publishing queue threads. - * + * * @param notifierThread Thread */ public void removeNotifierThread(Thread notifierThread) { @@ -320,7 +320,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Notifies all registered listeners about request. - * + * * @param r request */ public void notify(IRequest r) { @@ -345,7 +345,7 @@ public class ARequestNotifier implements IRequestNotifier { /* CMS.getLogger().log( - ILogger.EV_SYSTEM, ILogger.S_REQQUEUE, ILogger.LL_FAILURE, + ILogger.EV_SYSTEM, ILogger.S_REQQUEUE, ILogger.LL_FAILURE, "Could not run listeners for request " + r.getRequestId() + ". Error " + e + ";" + e.getMessage()); */ @@ -355,7 +355,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Checks for available publishing connections - * + * * @return true if there are available publishing connections, false otherwise */ private boolean checkAvailablePublishingConnections() { @@ -390,7 +390,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Checks if more publishing threads can be added. - * + * * @return true if more publishing threads can be added, false otherwise */ private boolean morePublishingThreads() { @@ -417,7 +417,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Notifies all registered listeners about request. - * + * * @param r request */ public synchronized void addToNotify(IRequest r) { @@ -449,7 +449,7 @@ public class ARequestNotifier implements IRequestNotifier { /** * Recovers publishing queue. - * + * * @param id request request */ public void recoverPublishingQueue(String id) { @@ -490,7 +490,7 @@ class RunListeners implements Runnable { /** * RunListeners class constructor. - * + * * @param r request * @param listeners list of listeners */ @@ -501,7 +501,7 @@ class RunListeners implements Runnable { /** * RunListeners class constructor. - * + * * @param r request * @param listeners list of listeners */ diff --git a/base/common/src/com/netscape/certsrv/request/AgentApproval.java b/base/common/src/com/netscape/certsrv/request/AgentApproval.java index eb3ca06a8..cfe52b3b0 100644 --- a/base/common/src/com/netscape/certsrv/request/AgentApproval.java +++ b/base/common/src/com/netscape/certsrv/request/AgentApproval.java @@ -23,7 +23,7 @@ import java.util.Date; /** * The AgentApproval class contains the record of a * single agent approval. - * + * * @version $Revision$, $Date$ */ public class AgentApproval @@ -36,7 +36,7 @@ public class AgentApproval /** * Returns the approving agent's user name. - * + * * @return an identifier for the agent */ public String getUserName() { @@ -45,7 +45,7 @@ public class AgentApproval /** * Returns the date of the approval - * + * * @return date and time of the approval */ public Date getDate() { @@ -54,7 +54,7 @@ public class AgentApproval /** * AgentApproval class constructor - * + * * @param userName user name of the approving agent */ AgentApproval(String userName) { diff --git a/base/common/src/com/netscape/certsrv/request/AgentApprovals.java b/base/common/src/com/netscape/certsrv/request/AgentApprovals.java index d6fa41b8f..2c957b6ee 100644 --- a/base/common/src/com/netscape/certsrv/request/AgentApprovals.java +++ b/base/common/src/com/netscape/certsrv/request/AgentApprovals.java @@ -25,7 +25,7 @@ import java.util.Vector; /** * A collection of AgentApproval objects. * <single-threaded> - * + * * @version $Revision$, $Date$ */ public class AgentApprovals @@ -41,7 +41,7 @@ public class AgentApprovals * <p> * If an approval is already present for this user, it is updated with a new date. Otherwise a new value is * inserted. - * + * * @param userName user name of the approving agent */ public void addApproval(String userName) { @@ -61,7 +61,7 @@ public class AgentApprovals * Removes an approval from approval's list. * <p> * If there is no approval for this userName, this call does nothing. - * + * * @param userName user name of the approving agent */ public void removeApproval(String userName) { @@ -73,7 +73,7 @@ public class AgentApprovals /** * Finds an existing AgentApproval for the named user. - * + * * @param userName user name of the approving agent * @return an AgentApproval object */ @@ -93,7 +93,7 @@ public class AgentApprovals /** * Returns an enumeration of the agent approvals - * + * * @return an enumeration of the agent approvals */ public Enumeration<AgentApproval> elements() { @@ -107,7 +107,7 @@ public class AgentApprovals * where epoch is the date.getTime() * <p> * This is used for serialization in Request.setExtData(). - * + * * @return The string vector. */ public Vector<String> toStringVector() { @@ -123,7 +123,7 @@ public class AgentApprovals /** * Recreates an AgentApprovals instance from a Vector of strings that * was created by toStringVector(). - * + * * @param stringVector The vector of strings to translate * @return the AgentApprovals instance or null if it can't be translated. */ diff --git a/base/common/src/com/netscape/certsrv/request/IEnrollmentRequest.java b/base/common/src/com/netscape/certsrv/request/IEnrollmentRequest.java index 32c3f53a9..f63fc0076 100644 --- a/base/common/src/com/netscape/certsrv/request/IEnrollmentRequest.java +++ b/base/common/src/com/netscape/certsrv/request/IEnrollmentRequest.java @@ -22,7 +22,7 @@ package com.netscape.certsrv.request; * This version (currently) doesn't supply any additional * data, but is implementated only for testing and * demonstration purposes. - * + * * @version $Revision$, $Date$ */ public interface IEnrollmentRequest diff --git a/base/common/src/com/netscape/certsrv/request/INotify.java b/base/common/src/com/netscape/certsrv/request/INotify.java index 938cd855b..aaeb44051 100644 --- a/base/common/src/com/netscape/certsrv/request/INotify.java +++ b/base/common/src/com/netscape/certsrv/request/INotify.java @@ -23,7 +23,7 @@ package com.netscape.certsrv.request; * this interface may be registered with a IRequestQueue. * The interface will be invoked when a request is completely * serviced by the IService object. - * + * * @version $Revision$ $Date$ */ public interface INotify { @@ -33,7 +33,7 @@ public interface INotify { * The implementation may use values stored in the IRequest * object, and may implement any type publishing (such as email * or writing values into a directory) - * + * * @param request the request that is completed. */ public void notify(IRequest request); diff --git a/base/common/src/com/netscape/certsrv/request/IPolicy.java b/base/common/src/com/netscape/certsrv/request/IPolicy.java index 9998abee7..647d8f0c8 100644 --- a/base/common/src/com/netscape/certsrv/request/IPolicy.java +++ b/base/common/src/com/netscape/certsrv/request/IPolicy.java @@ -28,7 +28,7 @@ package com.netscape.certsrv.request; * of agents allowed to perform further processing. If none * is set, a default value ("defaultAgentGroup") will be * set instead. - * + * * @version $Revision$, $Date$ */ public interface IPolicy { @@ -41,7 +41,7 @@ public interface IPolicy { * The policy can update fields in the request, to add additional values or to restrict the values to pre-determined * ranges. * <p> - * + * * @param request * the request to check * @return diff --git a/base/common/src/com/netscape/certsrv/request/IRequest.java b/base/common/src/com/netscape/certsrv/request/IRequest.java index 8759c1490..ded0145ab 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequest.java +++ b/base/common/src/com/netscape/certsrv/request/IRequest.java @@ -37,7 +37,7 @@ import com.netscape.certsrv.base.IAttrSet; /** * An interface that defines abilities of request objects, - * + * * @version $Revision$, $Date$ */ public interface IRequest { @@ -75,7 +75,7 @@ public interface IRequest { public static final String REQUESTOR_EMAIL = "csrRequestorEmail"; public static final String REQUESTOR_COMMENTS = "csrRequestorComments"; - // request attributes for all + // request attributes for all public static final String AUTH_TOKEN = "AUTH_TOKEN"; public static final String HTTP_PARAMS = "HTTP_PARAMS"; public static final String HTTP_HEADERS = "HTTP_HEADERS"; @@ -111,7 +111,7 @@ public interface IRequest { public static final String REQUEST_TRUSTEDMGR_PRIVILEGE = "requestTrustedManagerPrivilege"; public static final String FINGERPRINTS = "fingerprints"; - // enrollment request values + // enrollment request values public static final String SERVER_CERT = "server"; public static final String CLIENT_CERT = "client"; public static final String CA_CERT = "ca"; @@ -185,14 +185,14 @@ public interface IRequest { /** * Gets the primary identifier for this request. - * + * * @return request id */ RequestId getRequestId(); /** * Gets the current state of this request. - * + * * @return request status */ RequestStatus getRequestStatus(); @@ -205,7 +205,7 @@ public interface IRequest { * The sourceId should be unique so that it can be used to retrieve request later without knowing the locally * assigned primary id (RequestID) * <p> - * + * * @return * the sourceId value (or null if none has been set) */ @@ -216,21 +216,21 @@ public interface IRequest { * in the database for this change to take effect. This can be done * by calling IRequestQueue.update() or by performing one of the * other operations like processRequest or approveRequest. - * + * * @param id source id for this request */ public void setSourceId(String id); /** * Gets the current owner of this request. - * + * * @return request owner */ public String getRequestOwner(); /** * Sets the current owner of this request. - * + * * @param owner * The new owner of this request. If this value is set to null * there will be no current owner @@ -239,28 +239,28 @@ public interface IRequest { /** * Gets the type of this request. - * + * * @return request type */ public String getRequestType(); /** * Sets the type or this request. - * + * * @param type request type */ public void setRequestType(String type); /** * Gets the version of this request. - * + * * @return request version */ public String getRequestVersion(); /** * Gets the time this request was created. - * + * * @return request creation time */ Date getCreationTime(); @@ -268,7 +268,7 @@ public interface IRequest { /** * Gets the time this request was last modified (defined * as updated in the queue) (See IRequestQueue.update) - * + * * @return request last modification time */ Date getModificationTime(); @@ -291,42 +291,42 @@ public interface IRequest { /** * Copies meta attributes (excluding request Id, etc.) of another request * to this request. - * + * * @param req another request */ public void copyContents(IRequest req); /** * Gets context of this request. - * + * * @return request context */ public String getContext(); /** * Sets context of this request. - * + * * @param ctx request context */ public void setContext(String ctx); /** * Sets status of this request. - * + * * @param s request status */ public void setRequestStatus(RequestStatus s); /** * Gets status of connector transfer. - * + * * @return status of connector transfer */ public boolean isSuccess(); /** * Gets localized error message from connector transfer. - * + * * @param locale request locale * @return error message from connector transfer */ @@ -334,15 +334,15 @@ public interface IRequest { /************************************************************** * ExtData data methods: - * + * * These methods should be used in place of the mAttrData methods * deprecated above. - * + * * These methods all store Strings in LDAP. This means they can no longer * be used as a garbage dump for all sorts of objects. A limited number * of helper methods are provided for Vectors/Arrays/Hashtables but the * keys and values for all of these should be Strings. - * + * * The keys are used in the LDAP attribute names, and so much obey LDAP * key syntax rules: A-Za-z0-9 and hyphen. */ @@ -350,7 +350,7 @@ public interface IRequest { /** * Sets an Extended Data string-key string-value pair. * All keys are lower cased because LDAP does not preserve case. - * + * * @param key The extended data key * @param value The extended data value * @return false if key is invalid. @@ -361,7 +361,7 @@ public interface IRequest { * Sets an Extended Data string-key string-value pair. * The key and hashtable keys are all lowercased because LDAP does not * preserve case. - * + * * @param key The extended data key * @param value The extended data value * the Hashtable contains an illegal key. @@ -372,7 +372,7 @@ public interface IRequest { /** * Checks whether the key is storing a simple String value, or a complex * (Vector/hashtable) structure. - * + * * @param key The key to check for. * @return True if the key maps to a string. False if it maps to a * hashtable. @@ -383,7 +383,7 @@ public interface IRequest { * Returns the String value stored for the String key. Returns null * if not found. Throws exception if key stores a complex data structure * (Vector/Hashtable). - * + * * @param key The key to lookup (case-insensitive) * @return The value associated with the key. null if not found or if the * key is associated with a non-string value. @@ -393,12 +393,12 @@ public interface IRequest { /** * Returns the Hashtable value for the String key. Returns null if not * found. Throws exception if the key stores a String value. - * + * * The Hashtable returned is actually a subclass of Hashtable that * lowercases all keys used to access the hashtable. Its purpose is to * to make lookups seemless, but be aware it is not a normal hashtable and * might behave strangely in some cases (e.g., iterating keys) - * + * * @param key The key to lookup (case-insensitive) * @return The hashtable value associated with the key. null if not found * or if the key is associated with a string-value. @@ -407,7 +407,7 @@ public interface IRequest { /** * Returns all the keys stored in ExtData - * + * * @return Enumeration of all the keys. */ public Enumeration<String> getExtDataKeys(); @@ -415,7 +415,7 @@ public interface IRequest { /** * Stores an array of Strings in ExtData. * The indices of the array are used as subkeys. - * + * * @param key the ExtData key * @param values the array of string values to store * @return False if the key is invalid @@ -426,7 +426,7 @@ public interface IRequest { * Retrieves an array of Strings stored with the key. * This only works if the data was stored as an array. If the data * is not correct, this method will return null. - * + * * @param key The ExtData key * @return The value. Null if not found or the data isn't an array. */ @@ -434,7 +434,7 @@ public interface IRequest { /** * Removes the value of an extdata attribute. - * + * * @param type key to delete */ void deleteExtData(String type); @@ -447,9 +447,9 @@ public interface IRequest { * Helper method to add subkey/value pair to a ExtData hashtable. * If the hashtable it exists, the subkey/value are added to it. Otherwise * a new hashtable is created. - * + * * The key and subkey are lowercased because LDAP does not preserve case. - * + * * @param key The top level key * @param subkey The hashtable data key * @param value The hashtable value @@ -459,7 +459,7 @@ public interface IRequest { /** * Helper method to retrieve an individual value from a Hashtable value. - * + * * @param key the ExtData key * @param subkey the key in the Hashtable value (case insensitive) * @return the value corresponding to the key/subkey @@ -469,7 +469,7 @@ public interface IRequest { /** * Helper method to store an Integer value. It converts the integer value * to a String and stores it. - * + * * @param key the ExtData key * @param value the Integer to store (as a String) * @return False if the key or value are invalid @@ -479,7 +479,7 @@ public interface IRequest { /** * Retrieves an integer value. Returns null if not found or * the value can't be represented as an Integer. - * + * * @param key The ExtData key to lookup * @return The integer value or null if not possible. */ @@ -487,7 +487,7 @@ public interface IRequest { /** * Stores an array of Integers - * + * * @param key The extdata key * @param values The array of Integers to store * @return false if the key is invalid @@ -496,7 +496,7 @@ public interface IRequest { /** * Retrieves an array of Integers - * + * * @param key The extdata key * @return The array of Integers or null on error. */ @@ -505,7 +505,7 @@ public interface IRequest { /** * Helper method to store a BigInteger value. It converts the integer value * to a String and stores it. - * + * * @param key the ExtData key * @param value the BigInteger to store (as a String) * @return False if the key or value are invalid @@ -515,7 +515,7 @@ public interface IRequest { /** * Retrieves a BigInteger value. Returns null if not found or * the value can't be represented as a BigInteger. - * + * * @param key The ExtData key to lookup * @return The integer value or null if not possible. */ @@ -523,7 +523,7 @@ public interface IRequest { /** * Stores an array of BigIntegers - * + * * @param key The extdata key * @param values The array of BigIntegers to store * @return false if the key is invalid @@ -532,7 +532,7 @@ public interface IRequest { /** * Retrieves an array of BigIntegers - * + * * @param key The extdata key * @return The array of BigIntegers or null on error. */ @@ -541,7 +541,7 @@ public interface IRequest { /** * Helper method to store an exception. * It actually stores the e.toString() value. - * + * * @param key The ExtData key to store under * @param e The throwable to store * @return False if the key is invalid. @@ -550,7 +550,7 @@ public interface IRequest { /** * Stores a byte array as base64 encoded text - * + * * @param key The ExtData key * @param data The byte array to store * @return False if the key is invalid. @@ -559,7 +559,7 @@ public interface IRequest { /** * Retrieves the data, which should be base64 encoded as a byte array. - * + * * @param key The ExtData key * @return The data, or null if an error occurs. */ @@ -568,7 +568,7 @@ public interface IRequest { /** * Stores a X509CertImpl as base64 encoded text using the getEncode() * method. - * + * * @param key The ExtData key * @param data certificate * @return False if the key is invalid. @@ -577,7 +577,7 @@ public interface IRequest { /** * Retrieves the data, which should be base64 encoded as a byte array. - * + * * @param key The ExtData key * @return The data, or null if an error occurs. */ @@ -585,7 +585,7 @@ public interface IRequest { /** * Stores an array of X509CertImpls as a base64 encoded text. - * + * * @param key The ExtData key * @param data The array of certs to store * @return False if the key or data is invalid. @@ -594,7 +594,7 @@ public interface IRequest { /** * Retrieves an array of X509CertImpl. - * + * * @param key The ExtData key * @return Array of certs, or null if not found or invalid data. */ @@ -603,7 +603,7 @@ public interface IRequest { /** * Stores a X509CertInfo as base64 encoded text using the getEncodedInfo() * method. - * + * * @param key The ExtData key * @param data certificate * @return False if the key is invalid. @@ -612,7 +612,7 @@ public interface IRequest { /** * Retrieves the data, which should be base64 encoded as a byte array. - * + * * @param key The ExtData key * @return The data, or null if an error occurs. */ @@ -620,7 +620,7 @@ public interface IRequest { /** * Stores an array of X509CertInfos as a base64 encoded text. - * + * * @param key The ExtData key * @param data The array of cert infos to store * @return False if the key or data is invalid. @@ -629,7 +629,7 @@ public interface IRequest { /** * Retrieves an array of X509CertInfo. - * + * * @param key The ExtData key * @return Array of cert infos, or null if not found or invalid data. */ @@ -637,7 +637,7 @@ public interface IRequest { /** * Stores an array of RevokedCertImpls as a base64 encoded text. - * + * * @param key The ExtData key * @param data The array of cert infos to store * @return False if the key or data is invalid. @@ -646,7 +646,7 @@ public interface IRequest { /** * Retrieves an array of RevokedCertImpl. - * + * * @param key The ExtData key * @return Array of cert infos, or null if not found or invalid data. */ @@ -656,10 +656,10 @@ public interface IRequest { * Stores the contents of the String Vector in ExtData. * TODO - as soon as we're allowed to use JDK5 this should be changed * to use Vector<String> data. - * + * * Note that modifications to the Vector are not automatically reflected * after it is stored. You must call set() again to make the changes. - * + * * @param key The extdata key to store * @param data A vector of Strings to store * @return False on key error or invalid data. @@ -671,7 +671,7 @@ public interface IRequest { * Note that the returned vector, if modified, does not make changes * in ExtData. You must call setExtData() to propogate changes back * into ExtData. - * + * * @param key The extdata key * @return A Vector of strings, or null on error. */ @@ -680,7 +680,7 @@ public interface IRequest { /** * Gets boolean value for given type or default value * if attribute is absent. - * + * * @param type attribute type * @param defVal default attribute value * @return attribute value @@ -690,7 +690,7 @@ public interface IRequest { /** * Gets extdata boolean value for given type or default value * if attribute is absent for this request with this prefix. - * + * * @param prefix request prefix * @param type attribute type * @param defVal default attribute value @@ -700,7 +700,7 @@ public interface IRequest { /** * Stores an AuthToken the same as a Hashtable. - * + * * @param key The ExtData key * @param data The authtoken to store * @return False if the key or data is invalid. @@ -709,7 +709,7 @@ public interface IRequest { /** * Retrieves an authtoken. - * + * * @param key The ExtData key * @return AuthToken, or null if not found or invalid data. */ @@ -717,7 +717,7 @@ public interface IRequest { /** * Stores a CertificateExtensions in extdata. - * + * * @param key The ExtData key * @param data The CertificateExtensions to store * @return False if the key or data is invalid. @@ -726,7 +726,7 @@ public interface IRequest { /** * Retrieves the CertificateExtensions associated with the key. - * + * * @param key The ExtData key * @return the object, or null if not found or invalid data. */ @@ -734,7 +734,7 @@ public interface IRequest { /** * Stores a CertificateSubjectName in extdata. - * + * * @param key The ExtData key * @param data The CertificateSubjectName to store * @return False if the key or data is invalid. @@ -743,7 +743,7 @@ public interface IRequest { /** * Retrieves the CertificateSubjectName associated with the key. - * + * * @param key The ExtData key * @return the object, or null if not found or invalid data. */ diff --git a/base/common/src/com/netscape/certsrv/request/IRequestList.java b/base/common/src/com/netscape/certsrv/request/IRequestList.java index 5f265941a..6c3d113ea 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestList.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestList.java @@ -23,7 +23,7 @@ import java.util.Enumeration; * An interface providing a list of RequestIds that match * some criteria. It could be a list of all elements in a * queue, or just some defined sub-set. - * + * * @version $Revision$, $Date$ */ public interface IRequestList @@ -35,21 +35,21 @@ public interface IRequestList * <p> * Callers should be sure there is another element in the list by calling hasMoreElements first. * <p> - * + * * @return next request id */ RequestId nextRequestId(); /** * Gets next request from the list. - * + * * @return next request */ public Object nextRequest(); /** * Gets next request Object from the list. - * + * * @return next request */ public IRequest nextRequestObject(); diff --git a/base/common/src/com/netscape/certsrv/request/IRequestListener.java b/base/common/src/com/netscape/certsrv/request/IRequestListener.java index 8dc8a42a9..9afe0cd73 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestListener.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestListener.java @@ -23,7 +23,7 @@ import com.netscape.certsrv.base.ISubsystem; /** * An interface that defines abilities of request listener, - * + * * @version $Revision$, $Date$ */ public interface IRequestListener { @@ -31,7 +31,7 @@ public interface IRequestListener { /** * Initializes request listener for the specific subsystem * and configuration store. - * + * * @param sub subsystem * @param config configuration store */ @@ -39,14 +39,14 @@ public interface IRequestListener { /** * Accepts request. - * + * * @param request request */ public void accept(IRequest request); /** * Sets attribute. - * + * * @param name attribute name * @param val attribute value */ diff --git a/base/common/src/com/netscape/certsrv/request/IRequestNotifier.java b/base/common/src/com/netscape/certsrv/request/IRequestNotifier.java index 66bd35432..02e0e814a 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestNotifier.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestNotifier.java @@ -21,21 +21,21 @@ import java.util.Enumeration; /** * IRequestNotifier interface defines methods to register listeners, - * + * * @version $Revision$, $Date$ */ public interface IRequestNotifier extends INotify { /** * Registers a request listener. - * + * * @param listener listener to be registered */ public void registerListener(IRequestListener listener); /** * Registers a request listener. - * + * * @param name listener name * @param listener listener to be registered */ @@ -43,28 +43,28 @@ public interface IRequestNotifier extends INotify { /** * Removes listener from the list of registered listeners. - * + * * @param listener listener to be removed from the list */ public void removeListener(IRequestListener listener); /** * Removes listener from the list of registered listeners. - * + * * @param name listener name to be removed from the list */ public void removeListener(String name); /** * Gets list of listener names. - * + * * @return enumeration of listener names */ public Enumeration<String> getListenerNames(); /** * Gets listener from the list of registered listeners. - * + * * @param name listener name * @return listener */ @@ -72,49 +72,49 @@ public interface IRequestNotifier extends INotify { /** * Gets list of listeners. - * + * * @return enumeration of listeners */ public Enumeration<IRequestListener> getListeners(); /** * Gets request from publishing queue. - * + * * @return request */ public IRequest getRequest(); /** * Gets number of requests in publishing queue. - * + * * @return number of requests in publishing queue */ public int getNumberOfRequests(); /** * Checks if publishing queue is enabled. - * + * * @return true if publishing queue is enabled, false otherwise */ public boolean isPublishingQueueEnabled(); /** * Removes a notifier thread from the pool of publishing queue threads. - * + * * @param notifierThread Thread */ public void removeNotifierThread(Thread notifierThread); /** * Notifies all registered listeners about request. - * + * * @param r request */ public void addToNotify(IRequest r); /** * Sets publishing queue parameters. - * + * * @param isPublishingQueueEnabled publishing queue switch * @param publishingQueuePriorityLevel publishing queue priority level * @param maxNumberOfPublishingThreads maximum number of publishing threads diff --git a/base/common/src/com/netscape/certsrv/request/IRequestQueue.java b/base/common/src/com/netscape/certsrv/request/IRequestQueue.java index a8f5f7332..844f90f18 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestQueue.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestQueue.java @@ -32,7 +32,7 @@ import com.netscape.certsrv.dbs.repository.IRepository; * provides an interface for creating and viewing requests, * as well as performing operations on them. * <p> - * + * * @version $Revision$ $Date$ */ public interface IRequestQueue { @@ -45,7 +45,7 @@ public interface IRequestQueue { * The request is LOCKED. The caller MUST release the request object by calling releaseRequest(). * <p> * TODO: provide other required values (such as type and sourceId) - * + * * @param requestType request type * @return new request * @exception EBaseException failed to create new request @@ -61,7 +61,7 @@ public interface IRequestQueue { * <p> * The cloned request that is returned is LOCKED. The caller MUST release the request object by calling * releaseRequest(). - * + * * @param r request to be cloned * @return cloned request * @exception EBaseException failed to clone request @@ -75,7 +75,7 @@ public interface IRequestQueue { * to a valid request id. * <p> * Errors may be generated for other conditions. - * + * * @param id request id * @return found request * @exception EBaseException failed to access request queue @@ -87,7 +87,7 @@ public interface IRequestQueue { * Begins processing for this request. This call * is valid only on requests with status BEGIN * An error is generated for other cases. - * + * * @param req request to be processed * @exception EBaseException failed to process request */ @@ -96,14 +96,14 @@ public interface IRequestQueue { /** * Sets request scheduler. - * + * * @param scheduler request scheduler */ public void setRequestScheduler(IRequestScheduler scheduler); /** * Gets request scheduler. - * + * * @return request scheduler */ public IRequestScheduler getRequestScheduler(); @@ -115,7 +115,7 @@ public interface IRequestQueue { * <p> * This call might be used by agent servlets that want to copy a previous request, and resubmit it. By putting it * into PENDING state, the normal agent screens can be used for further processing. - * + * * @param req * the request to mark PENDING * @exception EBaseException failed to mark request as pending @@ -131,7 +131,7 @@ public interface IRequestQueue { * <p> * The cloned request that is returned is LOCKED. The caller MUST release the request object by calling * releaseRequest(). - * + * * @param r request to be cloned * @return cloned request mark PENDING * @exception EBaseException failed to clone or mark request @@ -149,7 +149,7 @@ public interface IRequestQueue { * <p> * The request processing code adds an AgentApproval to this request that contains the authentication id of the * agent. This data is retrieved from the Session object (qv). - * + * * @param request * the request that is being approved * @exception EBaseException failed to approve request @@ -164,7 +164,7 @@ public interface IRequestQueue { * <p> * The agent servlet (or other application) may wish to store AgentMessage values to indicate the reason for the * action - * + * * @param request * the request that is being rejected * @exception EBaseException failed to reject request @@ -179,7 +179,7 @@ public interface IRequestQueue { * <p> * The agent servlet (or other application) may wish to store AgentMessage values to indicate the reason for the * action - * + * * @param request * the request that is being canceled * @exception EBaseException failed to cancel request @@ -193,7 +193,7 @@ public interface IRequestQueue { * This call can be made after changing a value like source id or owner, to force the new value to be written. * <p> * The request must be locked to make this call. - * + * * @param request * the request that is being updated * @exception EBaseException failed to update request @@ -208,7 +208,7 @@ public interface IRequestQueue { * <p> * NOTE: This interface will not be useful for large databases. This needs to be replace by a VLV (paged) search * object. - * + * * @return request list */ public IRequestList listRequests(); @@ -221,7 +221,7 @@ public interface IRequestQueue { * <p> * NOTE: This interface will not be useful for large databases. This needs to be replace by a VLV (paged) search * object. - * + * * @param status request status * @return request list */ @@ -233,7 +233,7 @@ public interface IRequestQueue { * <p> * NOTE: This interface will not be useful for large databases. This needs to be replace by a VLV (paged) search * object. - * + * * @param filter search filter * @return request list */ @@ -245,7 +245,7 @@ public interface IRequestQueue { * <p> * NOTE: This interface will not be useful for large databases. This needs to be replace by a VLV (paged) search * object. - * + * * @param filter search filter * @param maxSize max size to return * @return request list @@ -258,7 +258,7 @@ public interface IRequestQueue { * <p> * NOTE: This interface will not be useful for large databases. This needs to be replace by a VLV (paged) search * object. - * + * * @param filter search filter * @param maxSize max size to return * @param timeLimit timeout value for the search @@ -269,14 +269,14 @@ public interface IRequestQueue { /** * Gets requests that are pending on handling by the service * <p> - * + * * @return list of pending requests */ // public IRequestList listServicePendingRequests(); /** * Locates a request from the SourceId. - * + * * @param id * a unique identifier for the record that is based on the source * of the request, and possibly an identify assigned by the source. @@ -289,7 +289,7 @@ public interface IRequestQueue { /** * Locates all requests with a particular SourceId. * <p> - * + * * @param id * an identifier for the record that is based on the source * of the request @@ -303,7 +303,7 @@ public interface IRequestQueue { * Releases the LOCK on a request obtained from findRequest() or * newRequest() * <p> - * + * * @param r request */ public void releaseRequest(IRequest r); @@ -311,7 +311,7 @@ public interface IRequestQueue { /** * Marks as serviced after destination authority has serviced request. * Used by connector. - * + * * @param r request */ public void markAsServiced(IRequest r); @@ -323,7 +323,7 @@ public interface IRequestQueue { /** * Gets a pageable list of IRequest entries in this queue. - * + * * @param pageSize page size * @return request list */ @@ -331,7 +331,7 @@ public interface IRequestQueue { /** * Gets a pageable list of IRequest entries in this queue. - * + * * @param filter search filter * @param pageSize page size * @param sortKey the attributes to sort by @@ -343,7 +343,7 @@ public interface IRequestQueue { /** * Gets a pageable list of IRequest entries in this queue. - * + * * @param fromId request id to start with * @param filter search filter * @param pageSize page size @@ -358,7 +358,7 @@ public interface IRequestQueue { /** * Gets a pageable list of IRequest entries in this queue. This * jumps right to the end of the list - * + * * @param fromId request id to start with * @param jumpToEnd jump to end of list (set fromId to null) * @param filter search filter @@ -373,7 +373,7 @@ public interface IRequestQueue { /** * Retrieves the notifier for pending request. - * + * * @return notifier for pending request */ public INotify getPendingNotify(); @@ -392,7 +392,7 @@ public interface IRequestQueue { /** * Gets request repository. - * + * * @return request repository */ public IRepository getRequestRepository(); diff --git a/base/common/src/com/netscape/certsrv/request/IRequestRecord.java b/base/common/src/com/netscape/certsrv/request/IRequestRecord.java index 53531b133..eba6cabb8 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestRecord.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestRecord.java @@ -27,7 +27,7 @@ import com.netscape.certsrv.dbs.IDBObj; * It has a set of attributes that are mapped into LDAP * attributes for actual directory operations. * <p> - * + * * @version $Revision$ $Date$ */ public interface IRequestRecord @@ -63,21 +63,21 @@ public interface IRequestRecord /** * Gets the request id. - * + * * @return request id */ public RequestId getRequestId(); /** * Gets attribute names of the request. - * + * * @return list of attribute names */ public Enumeration<String> getAttrNames(); /** * Gets the request attribute value by the name. - * + * * @param name attribute name * @return attribute value */ @@ -85,7 +85,7 @@ public interface IRequestRecord /** * Sets new attribute for the request. - * + * * @param name attribute name * @param o attribute value */ @@ -93,7 +93,7 @@ public interface IRequestRecord /** * Removes attribute from the request. - * + * * @param name attribute name */ public void delete(String name) @@ -101,7 +101,7 @@ public interface IRequestRecord /** * Gets attribute list of the request. - * + * * @return attribute list */ public Enumeration<String> getElements(); diff --git a/base/common/src/com/netscape/certsrv/request/IRequestScheduler.java b/base/common/src/com/netscape/certsrv/request/IRequestScheduler.java index 5012f5b0c..72216fcd3 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestScheduler.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestScheduler.java @@ -24,21 +24,21 @@ package com.netscape.certsrv.request; * the threads based on the request processing order. * The request that enters the request queue first should * be processed first. - * + * * @version $Revision$ $Date$ */ public interface IRequestScheduler { /** * Request entered the request queue processing. - * + * * @param r request */ public void requestIn(IRequest r); /** * Request exited the request queue processing. - * + * * @param r request */ public void requestOut(IRequest r); diff --git a/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java b/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java index 164e84a37..969be8713 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestSubsystem.java @@ -23,7 +23,7 @@ import com.netscape.certsrv.base.EBaseException; * This interface defines storage of request objects * in the local database. * <p> - * + * * @version $Revision$, $Date$ */ public interface IRequestSubsystem { @@ -34,7 +34,7 @@ public interface IRequestSubsystem { * (Currently unimplemented. Just use getRequestQueue to create * an in-memory queue.) * <p> - * + * * @param name The name of the queue object. This name can be used * in getRequestQueue to retrieve the queue later. * @exception EBaseException failed to create request queue @@ -50,7 +50,7 @@ public interface IRequestSubsystem { * <p> * WARNING: retrieving the same queue twice with result in multi-thread race conditions. * <p> - * + * * @param name * the name of the request queue. (Ex: "ca" "ra") * @param p @@ -78,7 +78,7 @@ public interface IRequestSubsystem { * <p> * WARNING: retrieving the same queue twice with result in multi-thread race conditions. * <p> - * + * * @param name * the name of the request queue. (Ex: "ca" "ra") * @param p diff --git a/base/common/src/com/netscape/certsrv/request/IRequestVirtualList.java b/base/common/src/com/netscape/certsrv/request/IRequestVirtualList.java index 540ec679c..23bfd2732 100644 --- a/base/common/src/com/netscape/certsrv/request/IRequestVirtualList.java +++ b/base/common/src/com/netscape/certsrv/request/IRequestVirtualList.java @@ -20,7 +20,7 @@ package com.netscape.certsrv.request; /** * This interface defines access to request virtual list. * <p> - * + * * @version $Revision$, $Date$ */ public interface IRequestVirtualList { @@ -28,14 +28,14 @@ public interface IRequestVirtualList { /** * Gets the total size of the result set. Elements of the * list are numbered from 0..(size-1) - * + * * @return size of the result set */ int getSize(); /** * Gets the element at the specified index - * + * * @param index index of the element * @return specified request */ @@ -43,7 +43,7 @@ public interface IRequestVirtualList { /** * Gets the current index - * + * * @return current index */ int getCurrentIndex(); diff --git a/base/common/src/com/netscape/certsrv/request/IService.java b/base/common/src/com/netscape/certsrv/request/IService.java index adf2c5095..0756be893 100644 --- a/base/common/src/com/netscape/certsrv/request/IService.java +++ b/base/common/src/com/netscape/certsrv/request/IService.java @@ -24,7 +24,7 @@ import com.netscape.certsrv.base.EBaseException; * This covers certificate generation, revocation, renewals, * revocation checking, and much more. * <p> - * + * * @version $Revision$, $Date$ */ public interface IService { @@ -33,7 +33,7 @@ public interface IService { * Performs the service (such as certificate generation) * represented by this request. * <p> - * + * * @param request * The request that needs service. The service may use * attributes stored in the request, and may update the diff --git a/base/common/src/com/netscape/certsrv/request/PolicyMessage.java b/base/common/src/com/netscape/certsrv/request/PolicyMessage.java index c21b8ca4d..396603f50 100644 --- a/base/common/src/com/netscape/certsrv/request/PolicyMessage.java +++ b/base/common/src/com/netscape/certsrv/request/PolicyMessage.java @@ -23,7 +23,7 @@ import com.netscape.certsrv.base.EBaseException; * A (localizable) message recorded by a policy module that describes * the reason for rejecting a request. * <p> - * + * * @version $Revision$, $Date$ */ public class PolicyMessage @@ -37,7 +37,7 @@ public class PolicyMessage /** * Class constructor that registers policy message. * <p> - * + * * @param message message string */ public PolicyMessage(String message) { diff --git a/base/common/src/com/netscape/certsrv/request/PolicyResult.java b/base/common/src/com/netscape/certsrv/request/PolicyResult.java index c7cad94f2..79b378390 100644 --- a/base/common/src/com/netscape/certsrv/request/PolicyResult.java +++ b/base/common/src/com/netscape/certsrv/request/PolicyResult.java @@ -19,7 +19,7 @@ package com.netscape.certsrv.request; /** * This class defines results for policy actions. - * + * * @version $Revision$, $Date$ */ public final class PolicyResult { diff --git a/base/common/src/com/netscape/certsrv/request/RequestId.java b/base/common/src/com/netscape/certsrv/request/RequestId.java index b643fa30d..795fdaa2a 100644 --- a/base/common/src/com/netscape/certsrv/request/RequestId.java +++ b/base/common/src/com/netscape/certsrv/request/RequestId.java @@ -24,7 +24,7 @@ import java.math.BigInteger; * request within a request queue. This identifier may be used to * retrieve the request object itself from the request queue. * <p> - * + * * @version $Revision$ $Date$ */ public class RequestId { @@ -34,7 +34,7 @@ public class RequestId { /** * Creates a new RequestId from its string representation. * <p> - * + * * @param id * a string containing the decimal or hex value for the identifier. */ @@ -86,7 +86,7 @@ public class RequestId { * Converts the RequestId into its string representation. The string * form can be stored in a database (such as the LDAP directory) * <p> - * + * * @return * a string containing the decimal (base 10) value for the identifier. */ diff --git a/base/common/src/com/netscape/certsrv/request/RequestStatus.java b/base/common/src/com/netscape/certsrv/request/RequestStatus.java index f58a568d8..fd501ef0f 100644 --- a/base/common/src/com/netscape/certsrv/request/RequestStatus.java +++ b/base/common/src/com/netscape/certsrv/request/RequestStatus.java @@ -21,16 +21,16 @@ package com.netscape.certsrv.request; * The RequestStatus class represents the current state of a request * in a request queue. The state of the request changes as actions * are performed on it. - * + * * The request is created in the BEGIN state, then general progresses * through the PENDING, APPROVED, SVC_PENDING, and COMPLETE states. * Some requests may bypass the PENDING state if no agent action is * required. - * + * * Requests may be CANCELED (not implemented) or REJECTED. These are * error conditions, and usually result because the request was invalid * or was not approved by an agent. - * + * * @version $Revision$ $Date$ */ public final class RequestStatus { @@ -45,7 +45,7 @@ public final class RequestStatus { /** * The initial state of a request. Requests in this state have not * been review by policy. - * + * * While in this state the source of the request (usually the servlet, * but it could be some other protocol module, such as email) * should populate the request with data need to service it. @@ -56,7 +56,7 @@ public final class RequestStatus { * The state of a request that is waiting for action by an agent. * When the agent approves or rejects the request, process will * continue as appropriate. - * + * * In this state there may be PolicyMessages present that indicate * the reason for the pending status. */ @@ -66,7 +66,7 @@ public final class RequestStatus { * The state of a request that has been approved by an agent, or * automatically by the policy engine, but have not been successfully * transmitted to the service module. - * + * * These requests are resent to the service during the recovery * process that runs at server startup. */ @@ -91,7 +91,7 @@ public final class RequestStatus { * The state of a request after it is rejected. When a request is * rejected, the notifier is called prior to making the finl status * change. - * + * * Rejected requests may have PolicyMessages indicating the reason for * the rejection, or AgentMessages, which allow the agent to give * reasons for the action. @@ -110,7 +110,7 @@ public final class RequestStatus { * Converts a string name for a request status into the * request status enum object. * <p> - * + * * @param s * The string representation of the state. * @return @@ -138,7 +138,7 @@ public final class RequestStatus { /** * Returns the string form of the RequestStatus, which may be used * to record the status in a database. - * + * * @return request status */ public String toString() { @@ -147,7 +147,7 @@ public final class RequestStatus { /** * Class constructor. Creates request status from the string. - * + * * @param string string describing request status */ private RequestStatus(String string) { @@ -158,7 +158,7 @@ public final class RequestStatus { /** * Compares request status with specified string. - * + * * @param string string describing request status */ public boolean equals(String string) { @@ -170,7 +170,7 @@ public final class RequestStatus { /** * Compares current request status with request status. - * + * * @param rs request status */ public boolean equals(RequestStatus rs) { diff --git a/base/common/src/com/netscape/certsrv/request/ldap/IRequestMod.java b/base/common/src/com/netscape/certsrv/request/ldap/IRequestMod.java index c1e153a81..9da90e774 100644 --- a/base/common/src/com/netscape/certsrv/request/ldap/IRequestMod.java +++ b/base/common/src/com/netscape/certsrv/request/ldap/IRequestMod.java @@ -25,13 +25,13 @@ import com.netscape.certsrv.request.RequestStatus; /** * This interface defines how to update request record. * <p> - * + * * @version $Revision$, $Date$ */ public interface IRequestMod { /** * Modifies request status. - * + * * @param r request * @param s request status */ @@ -39,7 +39,7 @@ public interface IRequestMod { /** * Modifies request creation time. - * + * * @param r request * @param d date */ @@ -47,7 +47,7 @@ public interface IRequestMod { /** * Modifies request modification time. - * + * * @param r request * @param d date */ |