diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/notification')
7 files changed, 45 insertions, 54 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/notification/ENotificationException.java b/pki/base/common/src/com/netscape/certsrv/notification/ENotificationException.java index 4e34ded30..34a8c7158 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/ENotificationException.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/ENotificationException.java @@ -17,14 +17,12 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import com.netscape.certsrv.base.EBaseException; - /** * A class represents a notification exception. * <P> - * + * * @version $Revision$, $Date$ */ public class ENotificationException extends EBaseException { @@ -36,7 +34,8 @@ public class ENotificationException extends EBaseException { /** * Identity resource class name. */ - private static final String NOTIFICATION_RESOURCES = NotificationResources.class.getName(); + private static final String NOTIFICATION_RESOURCES = NotificationResources.class + .getName(); /** * Constructs a notification exception diff --git a/pki/base/common/src/com/netscape/certsrv/notification/IEmailFormProcessor.java b/pki/base/common/src/com/netscape/certsrv/notification/IEmailFormProcessor.java index 9d7ee46f0..20bfb7a95 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/IEmailFormProcessor.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/IEmailFormProcessor.java @@ -17,17 +17,15 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import java.util.Hashtable; import java.util.Vector; - /** - * formulates the final email. Escape character '\' is understood. - * '$' is used preceeding a token name. A token name should not be a - * substring of any other token name + * formulates the final email. Escape character '\' is understood. '$' is used + * preceeding a token name. A token name should not be a substring of any other + * token name * <p> - * + * * @version $Revision$, $Date$ */ public interface IEmailFormProcessor { @@ -58,16 +56,18 @@ public interface IEmailFormProcessor { public final static String TOKEN_REVOCATION_DATE = "RevocationDate"; /* - * takes the form template, parse and replace all $tokens with the - * right values. It handles escape character '\' + * takes the form template, parse and replace all $tokens with the right + * values. It handles escape character '\' + * * @param form The locale specific form template, - * @param tok2vals a hashtable containing one to one mapping - * from $tokens used by the admins in the form template to the real - * values corresponding to the $tokens + * + * @param tok2vals a hashtable containing one to one mapping from $tokens + * used by the admins in the form template to the real values corresponding + * to the $tokens + * * @return mail content */ - public String getEmailContent(String form, - Hashtable tok2vals); + public String getEmailContent(String form, Hashtable tok2vals); /** * takes a vector of strings and concatenate them @@ -79,4 +79,3 @@ public interface IEmailFormProcessor { */ public void log(int level, String msg); } - diff --git a/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolver.java b/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolver.java index 49d0851ed..30c68be59 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolver.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolver.java @@ -17,25 +17,24 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import com.netscape.certsrv.base.EBaseException; - /** - * An email resolver that first checks the request email, if none, - * then follows by checking the subjectDN of the certificate + * An email resolver that first checks the request email, if none, then follows + * by checking the subjectDN of the certificate * <p> - * + * * @version $Revision$, $Date$ */ public interface IEmailResolver { /** - * returns an email address by using the resolver keys. The - * return value can possibly be null + * returns an email address by using the resolver keys. The return value can + * possibly be null + * * @param keys list of keys used for resolving the email address */ - public String getEmail(IEmailResolverKeys keys) - throws EBaseException, ENotificationException; + public String getEmail(IEmailResolverKeys keys) throws EBaseException, + ENotificationException; } diff --git a/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolverKeys.java b/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolverKeys.java index d1a6889cc..8ba95fa56 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolverKeys.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/IEmailResolverKeys.java @@ -17,16 +17,14 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import com.netscape.certsrv.base.IAttrSet; - /** - * An interface represents email resolver (ordered) keys for resolving - * emails - * e.g. request/cert, cert/request, request, request/cert/subjectalternatename etc. + * An interface represents email resolver (ordered) keys for resolving emails + * e.g. request/cert, cert/request, request, request/cert/subjectalternatename + * etc. * <P> - * + * * @version $Revision$, $Date$ */ public interface IEmailResolverKeys extends IAttrSet { diff --git a/pki/base/common/src/com/netscape/certsrv/notification/IEmailTemplate.java b/pki/base/common/src/com/netscape/certsrv/notification/IEmailTemplate.java index bcda466d1..5320761f1 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/IEmailTemplate.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/IEmailTemplate.java @@ -17,13 +17,10 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - - - /** - * Files to be processed and returned to the requested parties. It - * is a template with $tokens to be used by the form/template processor. - * + * Files to be processed and returned to the requested parties. It is a template + * with $tokens to be used by the form/template processor. + * * @version $Revision$, $Date$ */ @@ -36,7 +33,7 @@ public interface IEmailTemplate { */ public String getTemplateName(); - /** + /** * @return true if template is an html file, false otherwise */ public boolean isHTML(); diff --git a/pki/base/common/src/com/netscape/certsrv/notification/IMailNotification.java b/pki/base/common/src/com/netscape/certsrv/notification/IMailNotification.java index c5375caed..a19e5f694 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/IMailNotification.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/IMailNotification.java @@ -17,17 +17,14 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import java.io.IOException; import java.util.Vector; - /** - * This class handles mail notification via SMTP. - * This class uses <b>smtp.host</b> in the configuration for smtp - * host. The port default (25) is used. If no smtp specified, local - * host is used - * + * This class handles mail notification via SMTP. This class uses + * <b>smtp.host</b> in the configuration for smtp host. The port default (25) is + * used. If no smtp specified, local host is used + * * @version $Revision$, $Date$ */ public interface IMailNotification { @@ -39,36 +36,42 @@ public interface IMailNotification { /** * sets the "From" field + * * @param from email address of the sender */ public void setFrom(String from); /** * sets the "Subject" field + * * @param subject subject of the email */ public void setSubject(String subject); /** * sets the "Content-Type" field + * * @param contentType content type of the email */ public void setContentType(String contentType); /** * sets the content of the email + * * @param content the message content */ public void setContent(String content); /** * sets the recipients' email addresses + * * @param addresses a list of email addresses of the recipients */ public void setTo(Vector addresses); /** * sets the recipient's email address + * * @param to address of the recipient email address */ public void setTo(String to); diff --git a/pki/base/common/src/com/netscape/certsrv/notification/NotificationResources.java b/pki/base/common/src/com/netscape/certsrv/notification/NotificationResources.java index 40d9e80e3..e7a2be400 100644 --- a/pki/base/common/src/com/netscape/certsrv/notification/NotificationResources.java +++ b/pki/base/common/src/com/netscape/certsrv/notification/NotificationResources.java @@ -17,14 +17,11 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.notification; - import java.util.ListResourceBundle; - /** - * A class represents a resource bundle for the - * Mail Notification package - * + * A class represents a resource bundle for the Mail Notification package + * * @version $Revision$, $Date$ */ public class NotificationResources extends ListResourceBundle { @@ -37,8 +34,7 @@ public class NotificationResources extends ListResourceBundle { } /** - * Constants. The suffix represents the number of - * possible parameters. + * Constants. The suffix represents the number of possible parameters. */ static final Object[][] contents = {}; |