D JMX MBean Reference

This appendix contains detailed information about the JMX MBeans provided by Job Scheduler and their attributes and values. The following topics are covered:

• Job Management Bean Attributes

• Job Scheduler Management Bean Attributes

• Job Scheduler Aggregation Management Bean Attributes

D.1 Job Management Bean Attributes

Table D-1 summarizes the Job MBean attributes for monitoring the job.

Table D-1 Job Management Bean Attributes

Attribute	Access	Type	Description
Description	Read-only	java.lang.string	Job description.
ClassName	Read-only	java.lang.string	Job implementation class name. This class provides an implementation of the oracle.ias.scheduler. Executable interface.
Schedule	Read-only	oracle.ias.scheduler.Schedule	Job schedule.
Triggers	Read-only	oracle.ias.scheduler.Trigger	Job trigger.
Properties	Read-only	java.util.Properties	Job properties.
State	Read-only	java.lang.string	Job state (ACTIVE, PAUSED, or COMPLETE).
LogLevel	Read/write	java.lang.string	String representation of log levels for the job. Possible values are ALL, OFF, SEVERE, WARNING, CONFIG, INFO, FINE, FINER, and FINEST.
ExecutionThreshold	Read-only	long	Job execution threshold (in milliseconds).
RetryPeriod	Read-only	long	Job retry period (in milliseconds).

Table D-2 summarizes the operations provided for configuring the job.

Table D-2 Job Management Bean Operations

Operation Name	Parameters	Return Type	Description
pause	None	None	Pauses the job.
resume	replay:boolean	None	Resumes the job. If the parameter is true, then replay the job if the trigger is set on resumption.
cancel	None	None	Cancels any currently running jobs.

Table D-3 summarizes the DMS metrics for a job.

Table D-3 Job Management Bean DMS Metrics

Metric Name	Metric Type
Notifications	count
Execution	average
FailedExecutions	value
CancelledExecutions	value
SuccessfulExecutions	value
BlackoutExecutions	value
ExceededThresholdExecutions	value

For more information about the metric types, see Oracle Application Server Performance Guide.

D.2 Job Scheduler Management Bean Attributes

Table D-4 summarizes Job Scheduler attributes for monitoring Job Scheduler.

Table D-4 Job Scheduler Management Bean Attributes

Attribute	Access	Type	Description
jobs	Read-only	java.util.Collection	All submitted jobs represented as a collection of javax.management.ObjectName objects, each of which references its associated job management bean instance.
jobstoreProvider	Read-only	java.lang.string	Class name of the configured job store provider implementation. The class specified implements the oracle.ias.scheduler.jobstore. JobStoreProvider interface.

Table D-5 summarizes the operations provided for configuring Job Scheduler.

Table D-5 Job Scheduler Management Bean Operations

Operation Name	Parameters	Return Type	Description
addBlackoutWindow	java.lang.String Windowname, java.lang.String datetime, long durationMinutes	None	Create a new execution blackout window with the specified window name. The date, time, and length of time the blackout window is in effect. The format of the date/time string must conform to the requirement of java.text.DateFormat using the java.text.DateFormat.FULL style for both date and time components. The duration is specified in minutes.
removeBlackoutWindow	java.lang.String windowName	None	Remove a previously defined execution blackout window identified by the specified window name.
listBlackoutWindows	None	java.util.Collection	List the names of all defined blackout windows.

Table D-6 summarizes the DMS metrics for a Job Scheduler.

Table D-6 Job Scheduler Management Bean DMS Metrics

Metric Name	Metric Type
ExecJobInstances	value
ActiveJobs	value
PausedJobs	value
CompletedJobs	value
Notifications	count

For more information about the metric types, see Oracle Application Server Performance Guide.

D.3 Job Scheduler Aggregation Management Bean Attributes

Table D-7 summarizes the Job Scheduler Aggregation MBean.

Table D-7 Job Scheduler Aggregation Management Bean Attributes

Attribute	Access	Type	Description
schedulers	Read-only	java.util.Collection	All Job Scheduler instances represented as a collection of javax.management.ObjectName objects, each of which references its associated Job Scheduler management bean instance.
jobs	Read-only	java.util.Collection	All job instances represented as a collection of javax.management.ObjectName objects, each of which references its associated job management bean instance.

Table D-8 summarizes the clusterwide operations provided to configure the Job Scheduler Aggregation MBean.

Table D-8 Job Scheduler Aggregation Management Bean Operations

Operation Name	Parameters	Return Type	Description
pause	none	None	Pause all jobs across all Job Scheduler instances.
resume	replay; boolean	None	Resume all paused jobs across all Job Scheduler instances. Replay jobs whose triggers are set on resumption.
cancel	None	None	Cancel any currently running jobs across all Job Scheduler instances.
addBlackoutWindow	java.lang.String windowname java.lang.String datetime long durationMinutes	None	Create a new blackout window across all Job Scheduler instances with the specified window name. The date, time, and duration determine when and for how long the blackout window is in effect. The format of the date/time string must conform to format required by java.text.DateFormat. The duration is specified in minutes.

D.4 Frequently Asked Questions About JMX MBeans

Does Job Scheduler expose a management interface?

Job Scheduler does expose a management interface that can be access through JMX MBeans. Two kinds of MBeans are published: SchedulerMBean and JobMBean. The former is used to manage a Job Scheduler instance and the later a specific job instance. These MBeans are accessible from the OC4J Administration Console.

Can I enable and disable MBean publication?

Yes. If the <env-entry> value of oracle.ias.scheduler.jmx is set to true, then MBean publication is enabled; otherwise, the beans are not published.

What privileges are required to access the Job, Job Scheduler, and Job Scheduler Aggregation MBeans?

Access to the Job and Job Scheduler MBeans requires the same privileges as those of the user application in which they are defined. Access to the Job Scheduler Aggregation MBean requires OC4J administrator privileges.