JobLogFileNameCreator.java

/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.codecentric.batch.logging;

import org.springframework.batch.core.JobExecution;

/**
 * Components implementing this interface specify the name of the job run specific log
 * file. Data from the JobExecution may be used to compose the name. There are also
 * methods to get the specific parts (basename and extension) of the filename. Default
 * implementation used when there's no other Spring bean implementing this interface is
 * the {@link DefaultJobLogFileNameCreator}.
 * 
 * @author Tobias Flohre
 * @author Dennis Schulte
 * 
 */
public interface JobLogFileNameCreator {

	public String getName(JobExecution jobExecution);

	public String getBaseName(JobExecution jobExecution);

	public String getExtension();

}