/*
 * Copyright (C) 2007-2012 Argeo GmbH
 *
 * 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 org.argeo.slc.execution;

import java.io.File;
import java.nio.file.Path;

/** Provides write access to resources during execution */
public interface ExecutionResources {
	/** The base directory where this execution can write */
	public File getWritableBaseDir();

	/** Allocates a local file in the writable area and return it as a resource. */
	public Path getWritableResource(String relativePath);

	/**
	 * Allocates a local file in the writable area and return it as a fully
	 * qualified OS path.
	 */
	public String getWritableOsPath(String relativePath);

	/**
	 * Allocates a local file in the writable area and return it as a {@link File}.
	 */
	public File getWritableOsFile(String relativePath);

	/**
	 * Returns the resource as a file path. If the resource is not writable it is
	 * copied as a file in the writable area and the path to this local file is
	 * returned.
	 */
	public String getAsOsPath(Path resource, Boolean overwrite);
}