X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=runtime%2Forg.argeo.slc.core%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fcore%2Fexecution%2FExecutionResources.java;h=759a125425e86ce80a0c66ba450ee026cde55e2d;hb=f86db0937b395c7fa96fa4bf4a29cc2c676fe3f5;hp=53f5af79af837377fe9f409863813af7c75d7b91;hpb=ee6c3543a0ff9403420ce6a9c647723269f14331;p=gpl%2Fargeo-slc.git

diff --git a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/ExecutionResources.java b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/ExecutionResources.java
index 53f5af79a..759a12542 100644
--- a/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/ExecutionResources.java
+++ b/runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/ExecutionResources.java
@@ -1,9 +1,48 @@
+/*
+ * 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.core.execution;
 
+import java.io.File;
+
 import org.springframework.core.io.Resource;
 
+/** 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 Resource 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(Resource resource, Boolean overwrite);
 }