1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.syncope.core.provisioning.api.job.report;
20
21 import org.apache.syncope.common.lib.report.ReportConf;
22 import org.apache.syncope.core.provisioning.api.job.JobDelegate;
23 import org.quartz.JobExecutionContext;
24 import org.quartz.JobExecutionException;
25
26 public interface ReportJobDelegate extends JobDelegate {
27
28 /**
29 * Optional configuration.
30 *
31 * @param conf configuration
32 */
33 default void setConf(ReportConf conf) {
34 }
35
36 /**
37 * Executes a Quartz Job to run the given Report.
38 *
39 * @param reportKey Report key to run
40 * @param dryRun indicates if execution shall be simulated with no actual changes
41 * @param context Quartz' execution context, can be used to pass parameters to the job
42 * @throws JobExecutionException if anything goes wrong
43 */
44 void execute(
45 String reportKey,
46 boolean dryRun,
47 JobExecutionContext context) throws JobExecutionException;
48 }