Complete Contents
About This Guide
PART 1: Netscape Certificate Management System
Chapter 1: Introduction to Certificate Management System
Chapter 2: Administration Tasks and Tool
Chapter 3: Configuration
PART 2: Managing Certificate Management System
Chapter 4: Installing and Uninstalling Instances
Chapter 5: Starting and Stopping Instances
PART 3: System-Level Configuration
Chapter 6: Configuring Ports, Database, and SMTP Settings
Chapter 7: Managing Privileged Users and Groups
Chapter 8: Keys and Certificates
PART 4: Authentication
Chapter 9: Introduction to Authentication
Chapter 10: Using the PIN Generator Tool
Chapter 11: Configuring Authentication for End Entities
Chapter 12: Developing Authentication Plug-ins
PART 5: Job Scheduling and Notification
Chapter 13: Introduction to Job Scheduling and Notifications
Chapter 14: Configuring Jobs
PART 6: Policies
Chapter 15: Introduction to Policies
Chapter 16: Configuring Policies
PART 7: LDAP Publishing
Chapter 17: Introduction to LDAP Publishing
Chapter 18: Configuring Subsystems for LDAP Publishing
Chapter 19: Publishing CRLs
PART 8: Agent and End-Entity Interfaces
Chapter 20: Introduction to End-Entity and Agent Interfaces
Chapter 21: Customizing End-Entity and Agent Interfaces
PART 9: Logs
Chapter 22: Introduction to Logs
Chapter 23: Managing Logs
PART 10: Issuance and Management of End-Entity Certificates
Chapter 24: Issuing and Managing End-Entity Certificates
Chapter 25: Recovering Encrypted Data
PART 11: Appendixes
Appendix A: Distinguished Names
Appendix B: Backing Up and Restoring Data
Appendix C: Command-Line Utilities
Appendix D: Certificate Database Tool
Appendix E: Key Database Tool
Appendix F: Netscape Signing Tool
Appendix G: SSL Strength Tool
Appendix H: SSL Debugging Tool
Previous Next Contents Index Bookshelf


Chapter 14 Configuring Jobs

Netscape Certificate Management System (CMS) provides a customizable Job Scheduler component that supports various mechanisms for scheduling cron jobs. This chapter explains how to configure Certificate Management System to use specific job plug-in modules for accomplishing jobs. The chapter also shows how plug-in implementations and configured instances for various job items appear in the configuration file.

Before reading this chapter, you should have read the chapter "Introduction to Job Scheduling and Notifications". In particular, you should be familiar with the various job plug-in modules that come with Certificate Management System. If you are not, see "Built-in Job Plug-in Modules".

The chapter has the following sections:
Job Management
You can manage jobs in two ways:

 The recommended method is to use the CMS window.

 Job Management from the CMS Window

Figure 14.1 shows the CMS window, which provides the required user interface to support job management.

Figure 14.1 Job Scheduler information in the CMS window

In the CMS window you will find a single Job Scheduler object, within which is another object identified as Jobs. The Jobs object represents the job plug-in implementations and instances currently recognized by this instance of Certificate Management System; the Job Scheduler object represents the schedule for the configured jobs.

 From the CMS window you can accomplish the following operations:

 The sections that follow describe the parts of the window from which you carry out these operations.

 Job Instance Tab

The Job Instance tab lists jobs that are currently scheduled for the server, so that you can manage them at a single place. From this tab you can perform the following operations:

Add. The add operation shows a list of registered job plug-in modules from which you can select the one you want to configure. You configure an instance of the selected module with the help of the job instance editor (see "Job Instance Editor"). When you save the changes, Certificate Management System creates the instance and displays it in the list of jobs. For instructions on adding new jobs to the CMS configuration, see "Adding a Job".

Delete. The delete operation allows you to remove unwanted jobs from the CMS configuration. For instructions on deleting jobs, see "Deleting a Job".

Edit/View. The edit operation allows you to view and modify configuration parameter values of currently configured jobs. You modify the parameter values with the help of the job instance editor (see "Job Instance Editor"). For instructions on modifying jobs, see "Modifying a Job".

Job Instance Editor

The job instance editor is designed to be generic. Its simple graphical interface enables you to create new job instances and modify the configuration of individual jobs. When you are adding a new job, the editor shows the configuration parameters pertaining to the plug-in module you selected. When you are modifying a job, the editor shows the configuration parameters pertaining to the job you selected.

All configurable parameters are displayed in the form of a table with two columns and multiple rows, each parameter occupying a row in the table. The left column lists the names of the configurable parameters; the right column is designated for entering the appropriate values. The ordering of the configurable parameters is irrelevant unless it is defined by the job plug-in implementation.

 The job instance editor provides normal save, cancel, and help functionality. You can specify names for jobs, but only at the time of adding new ones; you cannot change names later.

 Job Plugin Registration Tab

The Job Plugin Registration tab lists the currently registered job plug-in modules for the selected CMS instance and gives you access to the window from which you can register new modules. On this tab you will find the names of registered plug-in modules listed on the left and the path to the Java class that implements the plug-in module listed on the right.

You can perform the following operations from this tab:

 Register. This operation allows you to register a new job plug-in module. You do this with the help of the job registration editor (see "Job Plugin Registration Editor").

When you save the changes, Certificate Management System loads the plug- in module implementation for the job and displays it in the list of currently registered plug-in modules. For instructions on registering new modules, see "Registering a Job Plug-in Module".

Delete. This operation allows you to remove unwanted job plug-in modules from the CMS framework. For instructions on deleting modules, see "Deleting a Job Scheduler Plug-in".

Job Plugin Registration Editor

The job plug-in registration editor allows you to register new job plug-in modules in the CMS framework. Registering a new module involves specifying its name and the full name of the Java class that implements the module.

For example, you can add a job implementation named as follows:

 com.netscape.jobscheduler.unpublishUserCert

 Job Scheduler Parameters in the Configuration File

The sample in Figure 14.2 shows how Job Scheduler-specific information appears in the configuration file. Keep the following points in mind:

To change the configuration by editing the configuration file, follow the instructions in "Changing the Configuration by Editing the Configuration File".

Job Plug-in Implementation and Instance

Jobs are implemented as Java classes, which are then registered with Certificate Management System as plug-ins. You can use a given implementation of a job plug-in module and configure multiple instances of it. Each instance must have a unique name (an alphanumeric string with no spaces) and can contain different input parameter values to apply to different jobs. In other words, a given job implementation can be shared by multiple configurations. You can also distinguish the applicability of configured instances by including appropriate instance names.


Managing Jobs
This section explains how to use the CMS window to perform the following operations:

For information on adding or changing job-specific information in the configuration file, see "Job Scheduler Parameters in the Configuration File".

Adding a Job

Adding a job to the CMS configuration involves creating a new instance of an already registered plug-in module, assigning a unique name (an alphanumeric string with no spaces) for the instance, and entering appropriate values for the parameters that define the plug-in module you want to create an instance of.

When you add a job, the CMS configuration is updated with the appropriate information.

 Note Certificate Management System executes this job only if the Job Scheduler is turned on or enabled. For information on scheduling the interval for executing the job, see "Setting the Job Scheduler Frequency".

To add a job to the CMS configuration:

  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler, then click Jobs.

    4. The Job Instance tab appears. It lists any currently configured jobs. For information about this tab, see "Job Instance Tab".

  4. Click Add.
    5.

    The Select Job Plugin Implementation window appears. It lists the currently registered job plug-in modules.

  5. Select a plug-in module.
    6.

    The following choices are the ones provided out of the box with Certificate Management System. If you have registered any custom job plug-in modules, they too will be available for selection.

    For the purposes of this instruction, assume that you selected RenewalNotificationJob.

  6. Click Next.
    7.

    The Configure Job Instance Parameters window appears. It lists the configuration information required for this job. For information on how this window works, see "Job Instance Editor".

  7. In the Job Instance ID field, type a unique name for this job that will help you identify it.

    8. For the name, be sure to use an alphanumeric string with no spaces.

  8. In the configuration area, specify the required information by filling in parameter values in the text fields in the right column.
    9.

    If you do not want to set any restrictions on a particular parameter, leave its value field blank.

  9. Click OK.
    10.

    The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.

Deleting a Job

You can delete unwanted jobs from the CMS configuration, by using the CMS window. If you think you might need a job in the future, instead of deleting it from the configuration you should disable it by setting the enable parameter value to false. In this way, you can avoid re-creating the job in the future. Because Certificate Management System executes only those jobs that are currently enabled, keeping unwanted jobs in a disabled state in the configuration does not affect the server's functioning.

To delete a job from the CMS configuration:
  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler, then click Jobs.

    4. The Job Instance tab appears. It lists any currently configured jobs. For information about this tab, see "Job Instance Tab".

  4. In the Instance Name list, select the job you want to delete and click Delete.
    5.

  5. When prompted, confirm the delete action.

    6. The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.

Modifying a Job

Modifying a job involves changing the configuration parameter values of the job instance; you cannot change the name of a job. To change the name of a job, create a new job using the same job plug-in module (that you used to create the job you want to rename) with the same parameter values, and delete the old one.

Note Certificate Management System executes jobs only if the Job Scheduler is turned on or enabled. For information on scheduling the interval for executing the job, see "Setting the Job Scheduler Frequency".

During installation, both Certificate Manager and Registration Manager create default jobs. Table 14.1 lists these jobs. After installation, you must verify whether you want to use these jobs, check how these jobs are configured, and make the appropriate configuration changes. If you don't want to use a job, delete it from the configuration following the instructions in "Deleting a Job". If you want to create a new job, follow the instructions in "Adding a Job".

Table 14.1 Default jobs created for a Certificate Manager or Registration Manager

Job instance name
Job plug-in module name
certRenewalNotifier
RenewalNotificationJob
See "Certificate Renewal Notifications".

requestInQueueNotifier
RequestInQueueJob
See "Notification of Request Queue Status".

unpublishExpiredCerts
UnpublishExpiredJob
See "Directory Update and Notification".

To modify a configured job in the CMS configuration:
  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler, then click Jobs.

    4. The Job Instance tab appears. It lists any currently configured jobs. For information about this tab, see "Job Instance Tab".

  4. In the Instance Name list, select the job you want to modify and click Edit.
    5.

    The Configure Job Instance Parameters window appears, showing how this job is currently configured. For information on how this window works, see "Job Instance Editor".

  5. Make the necessary changes by filling in parameter values in the text fields in the right column.

    6. If you do not want to set any restrictions on a particular parameter, leave its value field blank.

  6. Click OK.
    7.

    The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.

Setting the Job Scheduler Frequency

You can schedule the frequency at which the Job Scheduler daemon should check if any of the configured jobs need to be executed. To do this:

  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler.

    4. The General Settings tab appears. It shows whether the Job Scheduler component is currently enabled or disabled.

  4. Enter information as appropriate:
    5.

    Enable Job Scheduler. Check this option to enable the Job Scheduler. To disable the Job Scheduler uncheck the option; disabling turns off all the jobs.

    Check Frequency. Type the frequency at which the Job Scheduler daemon thread should wake up and call the configured jobs that meet the cron specification (see "Schedule for Executing Jobs"). By default, it is set to one minute.

  5. To save your changes, click Save.

    6. The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.


Managing Job Plug-in Modules
This section explains how to use the CMS window to perform the following operations:

 For information on adding or changing job-specific information in the configuration file, see "Job Scheduler Parameters in the Configuration File".

Registering a Job Plug-in Module

You can register custom job plug-in modules from the CMS window. Before registering a module, be sure to put the Java class for the plug-in module in the classes directory.

To register a job plug-in module in the CMS framework:
  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler, then click Jobs.

    4. The Job Instance tab appears. It lists any currently configured jobs.

  4. Click the Job Plugin Registration tab.

    5. The Job Plugin Registration tab appears. It lists currently registered job plug- in modules. For information about this tab, see "Job Plugin Registration Tab".

  5. Click Register.
    6.

    The Register Job Scheduler Plugin Implementation window appears. For information on how this window works, see "Job Plugin Registration Editor".

  6. Specify information as appropriate:
    7.

    Plugin name. Type the name of the plug-in module.

    Class name. Type the full name of the class for this plug-in module--that is, the path to the implementing Java class. If this class is part of a package, be sure to include the package name. For example, if you are registering a class named myJob and if this class is in a package named com.myCompany, type com.myCompany.myJob.

  7. Click OK.

    8. The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.

Deleting a Job Scheduler Plug-in

You can delete unwanted job plug-in modules by using the CMS window. Before deleting a module, be sure to delete all the instances that are based on this module; for instructions, see "Deleting a Job".

To delete a job plug-in from the CMS framework:
  1. Access the CMS window (see "Accessing the CMS Window").

  2. Click the Configuration tab.

  3. In the navigation tree, click Job Scheduler, then click Jobs.

    4. The Job Instance tab appears. It lists any currently configured instances.

  4. Click the Job Plugin Registration tab.
    5.

    The Job Plugin Registration tab appears. It lists currently registered job plug- in modules. For information about this tab, see "Job Plugin Registration Tab".

  5. In the Plugin Name list, select the plug-in module you want to delete and click Delete.
    6.

  6. When prompted, confirm the delete action.

    7. The CMS configuration is modified. If the changes you made require you to restart the server, you will be prompted accordingly. In that case, restart the server.

 

© Copyright 1999 Netscape Communications Corp., a subsidiary of America Online, Inc. All rights reserved.