SchedulerService API Example

The SchedulerService interface API being used to retrieve, manipulate the schedule task parameters and also execute the schedule task job pro-grammatically in OIM repository as follows:

Pre-Requisite:

Initial Setup.

Please follow the link and setup the OIM client environment to use to create the OIM Objects.


Client Code Setup

SchedulerService  API Usage:

1. Retrieving the Schedule Task Job Parameters.

2. Update the Schedule Task Parameters.

3. Executing the Schedule Task Pro-grammatically. 

4. Retrieving the Job History.

5. Retrieving the Last Job History.

Tasks Needs to be Performed:

1.    Create the OIMClient Handle

OIMClient client= new OIMClient();
client.login(username,password.toCharArray());

2.    Get SchedulerService service object

SchedulerService schedulerService = client.getService(SchedulerService.class);

3.  Retrieving the Schedule Task Job Parameters. 

String scheduleJobName="AD User Target Recon";
JobDetails jobdetails=schedulerService.getJobDetail(scheduleJobName);
HashMap<String, JobParameter> params= jobdetails.getParams();
           

4.  Updating the Schedule Task Parameter. 

String parameterName="Search Filter";
String parameterValue="(objectclass=inetorgperson)";
//Retrieving the Job Parameter Object
JobParameter jobParam= params.get(parameterName);
//Updating the Job Parameter Value in the Object
jobParam.setValue(parameterValue);
params.put(parameterName, jobParam);

//Udating the Schedule Task Parameters in OIM
schedulerService.updateJob(jobdetails);

5.  Executing the Schedule Task. 

// Invoking the Schedule Task

schedulerService.triggerNow(scheduleJobName);

6.  Retrieving the Schedule Job History

        List<JobHistory> history= schedulerService.getHistoryOfJob(jobName);
        if(history != null && !history.isEmpty())
        {
            for (JobHistory jobHistory : history)
            { // Retrieving the Error Data
                System.out.println("Error Data :"+new String(jobHistory.getErrorData() != null ? jobHistory.getErrorData() : "Success".getBytes()));
                try
                {
                   //Retrieving the Error Message
                    Exception exp=jobHistory.getExceptionObject();
                    if(exp != null)
                    {
                       System.out.println("Exception Message :"+.getMessage());
                    }
                   
                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    e.printStackTrace();
                }
            }
        }

7. Retrieving the Schedule Job Last Run History.

        JobHistory  history = schedulerService.getLastHistoryOfJob(jobName);
        if(history != null){
        // Retrieving the Error Data
        System.out.println("Error Data :"+new String(history.getErrorData() != null ? history.getErrorData() : "Success".getBytes()));
        // Exception Message
        System.out.println("Exception Message :"+history.getExceptionObject() != null ? history.getExceptionObject().getMessage() : "Empty");
                   
       }