001/*
002 * Copyright 2013-2018 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;
017
018/**
019 * Strategy interface for the generation of the key used in identifying
020 * unique {@link JobInstance}.
021 *
022 * @author Michael Minella
023 * @author Mahmoud Ben Hassine
024 *
025 * @param <T> The type of the source data used to calculate the key.
026 * @since 2.2
027 */
028public interface JobKeyGenerator<T> {
029
030        /**
031         * Method to generate the unique key used to identify a job instance.
032         *
033         * @param source Source information used to generate the key (must not be {@code null})
034         *
035         * @return a unique string identifying the job based on the information
036         * supplied
037         */
038        String generateKey(T source);
039}