001/*
002 * Copyright 2006-2007 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.springframework.batch.core.configuration;
017
018import org.springframework.batch.core.Job;
019
020/**
021 * A runtime service registry interface for registering job configurations by
022 * <code>name</code>.
023 * 
024 * @author Dave Syer
025 * 
026 */
027public interface JobRegistry extends ListableJobLocator {
028
029        /**
030         * Registers a {@link Job} at runtime.
031         * 
032         * @param jobFactory the {@link Job} to be registered
033         * 
034         * @throws DuplicateJobException if a factory with the same job name has
035         * already been registered.
036         */
037        void register(JobFactory jobFactory) throws DuplicateJobException;
038
039        /**
040         * Unregisters a previously registered {@link Job}. If it was not
041         * previously registered there is no error.
042         * 
043         * @param jobName the {@link Job} to unregister.
044         */
045        void unregister(String jobName);
046}