// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cms.jobs;
import java.text.DateFormat;
import java.util.Date;
import java.util.Enumeration;
import java.util.Locale;
import netscape.security.x509.X509CertImpl;
import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.IExtendedPluginInfo;
import com.netscape.certsrv.base.ISubsystem;
import com.netscape.certsrv.base.MetaInfo;
import com.netscape.certsrv.ca.ICertificateAuthority;
import com.netscape.certsrv.dbs.certdb.ICertRecord;
import com.netscape.certsrv.dbs.certdb.ICertificateRepository;
import com.netscape.certsrv.jobs.IJob;
import com.netscape.certsrv.jobs.IJobCron;
import com.netscape.certsrv.jobs.IJobsScheduler;
import com.netscape.certsrv.logging.ILogger;
import com.netscape.certsrv.notification.IEmailFormProcessor;
import com.netscape.certsrv.publish.IPublisherProcessor;
import com.netscape.certsrv.request.IRequest;
import com.netscape.certsrv.request.IRequestQueue;
import com.netscape.certsrv.request.RequestId;
/**
* a job for the Jobs Scheduler. This job checks in the internal ldap
* db for valid certs that have not been published to the
* publishing directory.
*
* the $TOKENS that are available for the this jobs's summary outer form are:
*
*
* @version $Revision$, $Date$
*/
public class PublishCertsJob extends AJobBase
implements IJob, Runnable, IExtendedPluginInfo {
ICertificateAuthority mCa = null;
IRequestQueue mReqQ = null;
ICertificateRepository mRepository = null;
IPublisherProcessor mPublisherProcessor = null;
private boolean mSummary = false;
/* Holds configuration parameters accepted by this implementation.
* This list is passed to the configuration console so configuration
* for instances of this implementation can be configured through the
* console.
*/
protected static String[] mConfigParams =
new String[] {
"enabled",
"cron",
"summary.enabled",
"summary.emailSubject",
"summary.emailTemplate",
"summary.itemTemplate",
"summary.senderEmail",
"summary.recipientEmail"
};
public String[] getExtendedPluginInfo(Locale locale) {
String s[] = {
IExtendedPluginInfo.HELP_TEXT +
"; A job that checks for valid certificates in the " +
"database, that have not been published and publish them to " +
"the publishing directory",
"cron;string;Format: minute hour dayOfMonth month " +
"dayOfWeek. Use '*' for 'every'. For dayOfWeek, 0 is Sunday",
"summary.senderEmail;string;Specify the address to be used " +
"as the email's 'sender'. Bounces go to this address.",
"summary.recipientEmail;string;Who should receive summaries",
"enabled;boolean;Enable this plugin",
"summary.enabled;boolean;Enable the summary. You must enabled " +
"this for the job to work.",
"summary.emailSubject;string;Subject of summary email",
"summary.emailTemplate;string;Fully qualified pathname of " +
"template file of email to be sent",
"summary.itemTemplate;string;Fully qualified pathname of " +
"file containing template for each item",
IExtendedPluginInfo.HELP_TOKEN +
";configuration-jobrules-unpublishexpiredjobs",
};
return s;
}
/**
* initialize from the configuration file
*/
public void init(ISubsystem owner, String id, String implName, IConfigStore config) throws
EBaseException {
mConfig = config;
mId = id;
mImplName = implName;
mCa = (ICertificateAuthority)
CMS.getSubsystem("ca");
if (mCa == null) {
return;
}
mReqQ = mCa.getRequestQueue();
mRepository = mCa.getCertificateRepository();
mPublisherProcessor = mCa.getPublisherProcessor();
// read from the configuration file
mCron = mConfig.getString(IJobCron.PROP_CRON);
if (mCron == null) {
return;
}
// parse cron string into a JobCron class
IJobsScheduler scheduler = (IJobsScheduler) owner;
mJobCron = scheduler.createJobCron(mCron);
// initialize the summary related config info
IConfigStore sc = mConfig.getSubStore(PROP_SUMMARY);
if (sc.getBoolean(PROP_ENABLED, false)) {
mSummary = true;
mSummaryMailSubject = sc.getString(PROP_EMAIL_SUBJECT);
mMailForm = sc.getString(PROP_EMAIL_TEMPLATE);
mItemForm = sc.getString(PROP_ITEM_TEMPLATE);
mSummarySenderEmail = sc.getString(PROP_SENDER_EMAIL);
mSummaryReceiverEmail = sc.getString(PROP_RECEIVER_EMAIL);
} else {
mSummary = false;
}
}
/**
* look in the internal db for certificateRecords that are
* valid but not published
* The publish() method should set InLdapPublishDir flag accordingly.
* if publish unsuccessfully, log it -- unsuccessful certs should be
* picked up and attempted again at the next scheduled run
*/
public void run() {
CMS.debug("in PublishCertsJob " +
getId() + " : run()");
// get time now..."now" is before the loop
Date date = CMS.getCurrentDate();
DateFormat dateFormat = DateFormat.getDateTimeInstance();
String nowString = dateFormat.format(date);
// form filter
String filter = // might need to use "metaInfo"
"(!(certMetainfo=" + ICertRecord.META_LDAPPUBLISH +
":true))";
Enumeration