View Javadoc

1   /*
2    * Copyright 2006-2007 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.springframework.batch.core.configuration;
17  
18  import org.springframework.batch.core.Job;
19  
20  /**
21   * A runtime service registry interface for registering job configurations by
22   * <code>name</code>.
23   * 
24   * @author Dave Syer
25   * 
26   */
27  public interface JobRegistry extends ListableJobLocator {
28  
29  	/**
30  	 * Registers a {@link Job} at runtime.
31  	 * 
32  	 * @param jobFactory the {@link Job} to be registered
33  	 * 
34  	 * @throws DuplicateJobException if a factory with the same job name has
35  	 * already been registered.
36  	 */
37  	void register(JobFactory jobFactory) throws DuplicateJobException;
38  
39  	/**
40  	 * Unregisters a previously registered {@link Job}. If it was not
41  	 * previously registered there is no error.
42  	 * 
43  	 * @param jobName the {@link Job} to unregister.
44  	 */
45  	void unregister(String jobName);
46  }