|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.netscape.cms.jobs.AJobBase
com.netscape.cms.jobs.RenewalNotificationJob
public class RenewalNotificationJob
A job for the Jobs Scheduler. This job checks in the internal ldap
db for certs about to expire within the next configurable days and
sends email notifications to the appropriate recipients.
the $TOKENS that are available for the this jobs's summary outer form are:
IJob
,
AJobBase
Field Summary | |
---|---|
protected ICertificateAuthority |
mCA
|
protected ICertificateRepository |
mCertDB
|
protected static java.lang.String[] |
mConfigParams
|
protected java.lang.String |
mEmailSender
|
protected java.lang.String |
mEmailSubject
|
protected java.lang.String |
mEmailTemplateName
|
protected static java.util.Vector |
mExtendedPluginInfo
|
protected boolean |
mHTML
|
protected java.lang.String |
mHttpHost
|
protected java.lang.String |
mHttpPort
|
protected boolean |
mSummary
|
protected boolean |
mSummaryHTML
|
protected java.lang.String |
mSummaryItemTemplateName
|
protected java.lang.String |
mSummaryTemplateName
|
static java.lang.String |
PROP_CRON
|
static java.lang.String |
PROP_EMAILSUBJECT
email subject line as appeared on the notification email |
static java.lang.String |
PROP_EMAILTEMPLATE
location of the template file used for email notification |
static java.lang.String |
PROP_MAXNOTIFYCOUNT
|
static java.lang.String |
PROP_NOTIFYENDOFFSET
This job will stop sending notification this much time after the expiration date |
static java.lang.String |
PROP_NOTIFYTRIGGEROFFSET
This job will send notification at this much time before the enpiration date |
static java.lang.String |
PROP_PROFILE_ID
Profile ID specifies which profile approves the certificate. |
static java.lang.String |
PROP_SENDEREMAIL
sender email address as appeared on the notification email |
static java.lang.String |
PROP_SUMMARY_ITEMTEMPLATE
location of the template file for each item appeared on the notification summary |
static java.lang.String |
PROP_SUMMARY_RECIPIENTEMAIL
recipient of the notification summary email |
static java.lang.String |
PROP_SUMMARY_SENDEREMAIL
sender email as appeared on the notification summary email |
static java.lang.String |
PROP_SUMMARY_SUBJECT
email subject as appeared on the notification summary email |
static java.lang.String |
PROP_SUMMARY_TEMPLATE
location of the email template used for notification summary |
Fields inherited from class com.netscape.cms.jobs.AJobBase |
---|
mConfig, mContentParams, mCron, mId, mImplName, mItemForm, mItemParams, mJobCron, mLogger, mMailForm, mMailHTML, mSummaryMailSubject, mSummaryReceiverEmail, mSummarySenderEmail, PROP_EMAIL_SUBJECT, PROP_EMAIL_TEMPLATE, PROP_ENABLED, PROP_ITEM_TEMPLATE, PROP_RECEIVER_EMAIL, PROP_SENDER_EMAIL, PROP_SUMMARY, STATUS_FAILURE, STATUS_SUCCESS |
Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo |
---|
HELP_TEXT, HELP_TOKEN |
Constructor Summary | |
---|---|
RenewalNotificationJob()
class constructor |
Method Summary | |
---|---|
java.lang.String[] |
getConfigParams()
Returns a list of configuration parameter names. |
IConfigStore |
getConfigStore()
Gets the configuration substore used by this job |
java.lang.String[] |
getExtendedPluginInfo(java.util.Locale locale)
holds help text for this plugin |
java.lang.String |
getId()
get instance id. |
java.lang.String |
getImplName()
gets the plugin name of this job. |
IJobCron |
getJobCron()
get cron string associated with this job |
void |
init(ISubsystem owner,
java.lang.String id,
java.lang.String implName,
IConfigStore config)
Initialize from the configuration file. |
protected void |
mailUser(java.lang.String subject,
java.lang.String msg,
java.lang.String sender,
IRequest req,
ICertRecord cr)
|
void |
run()
finds out which cert needs notification and notifies the responsible parties |
void |
setId(java.lang.String id)
set instance id. |
Methods inherited from class com.netscape.cms.jobs.AJobBase |
---|
buildContentParams, buildItemParams, buildItemParams, buildItemParams, getTemplateContent, isEnabled, log, log, mailSummary |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.netscape.certsrv.jobs.IJob |
---|
isEnabled |
Field Detail |
---|
public static final java.lang.String PROP_CRON
public static final java.lang.String PROP_PROFILE_ID
public static final java.lang.String PROP_NOTIFYTRIGGEROFFSET
public static final java.lang.String PROP_NOTIFYENDOFFSET
public static final java.lang.String PROP_SENDEREMAIL
public static final java.lang.String PROP_EMAILSUBJECT
public static final java.lang.String PROP_EMAILTEMPLATE
public static final java.lang.String PROP_MAXNOTIFYCOUNT
public static final java.lang.String PROP_SUMMARY_SENDEREMAIL
public static final java.lang.String PROP_SUMMARY_RECIPIENTEMAIL
public static final java.lang.String PROP_SUMMARY_SUBJECT
public static final java.lang.String PROP_SUMMARY_TEMPLATE
public static final java.lang.String PROP_SUMMARY_ITEMTEMPLATE
protected static java.lang.String[] mConfigParams
protected ICertificateRepository mCertDB
protected ICertificateAuthority mCA
protected boolean mSummary
protected java.lang.String mEmailSender
protected java.lang.String mEmailSubject
protected java.lang.String mEmailTemplateName
protected java.lang.String mSummaryItemTemplateName
protected java.lang.String mSummaryTemplateName
protected boolean mSummaryHTML
protected boolean mHTML
protected java.lang.String mHttpHost
protected java.lang.String mHttpPort
protected static java.util.Vector mExtendedPluginInfo
Constructor Detail |
---|
public RenewalNotificationJob()
Method Detail |
---|
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
getExtendedPluginInfo
in interface IExtendedPluginInfo
public void init(ISubsystem owner, java.lang.String id, java.lang.String implName, IConfigStore config) throws EBaseException
init
in interface IJob
init
in class AJobBase
id
- String name of this instanceimplName
- string name of this implementationconfig
- configuration store for this instance
EBaseException
public void run()
run
in interface java.lang.Runnable
run
in class AJobBase
public java.lang.String getId()
getId
in interface IJob
getId
in class AJobBase
public void setId(java.lang.String id)
setId
in interface IJob
setId
in class AJobBase
id
- String id of the instancepublic IJobCron getJobCron()
getJobCron
in interface IJob
getJobCron
in class AJobBase
public java.lang.String getImplName()
getImplName
in interface IJob
getImplName
in class AJobBase
public IConfigStore getConfigStore()
getConfigStore
in interface IJob
getConfigStore
in class AJobBase
protected void mailUser(java.lang.String subject, java.lang.String msg, java.lang.String sender, IRequest req, ICertRecord cr) throws java.io.IOException, ENotificationException, EBaseException
java.io.IOException
ENotificationException
EBaseException
public java.lang.String[] getConfigParams()
getConfigParams
in interface IJob
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |