View Javadoc

1   package org.apache.maven.continuum.build.settings;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.continuum.Continuum;
23  import org.apache.maven.continuum.model.project.Schedule;
24  
25  /**
26   * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
27   * @version $Id: SchedulesActivator.java 1372260 2012-08-13 04:29:09Z brett $
28   */
29  public interface SchedulesActivator
30  {
31      String ROLE = SchedulesActivator.class.getName();
32  
33      /**
34       * Grab all the stored {@link org.apache.maven.continuum.model.project.Schedule} objects
35       * and activate them by looking at the scheduling information contained within and submitting a
36       * Job to the scheduler.
37       *
38       * @throws SchedulesActivationException
39       */
40      void activateSchedules( Continuum continuum )
41          throws SchedulesActivationException;
42  
43      /**
44       * Activate schedule by looking at the scheduling information contained within and submitting a
45       * Job to the scheduler.
46       *
47       * @throws SchedulesActivationException
48       */
49      void activateSchedule( Schedule schedule, Continuum continuum )
50          throws SchedulesActivationException;
51  
52      /**
53       * Activate schedule only for PurgeConfiguration associated.
54       *
55       * @throws SchedulesActivationException
56       */
57      void activatePurgeSchedule( Schedule schedule, Continuum continuum )
58          throws SchedulesActivationException;
59  
60      /**
61       * Activate schedule only for BuildDefinitions associated.
62       *
63       * @throws SchedulesActivationException
64       */
65      void activateBuildSchedule( Schedule schedule, Continuum continuum )
66          throws SchedulesActivationException;
67  
68      /**
69       * Unactivate schedule by looking at the scheduling information contained within.
70       *
71       * @throws SchedulesActivationException
72       */
73      void unactivateSchedule( Schedule schedule, Continuum continuum )
74          throws SchedulesActivationException;
75  
76      /**
77       * Unactivate schedule purgeConfigurations if it is not in a purgeConfiguration.
78       */
79      void unactivateOrphanPurgeSchedule( Schedule schedule )
80          throws SchedulesActivationException;
81  
82      /**
83       * Unactivate schedule buildDefinitions if it is not in a buildDefinition.
84       *
85       * @throws SchedulesActivationException
86       */
87      void unactivateOrphanBuildSchedule( Schedule schedule )
88          throws SchedulesActivationException;
89  }