runtime/org.argeo.slc.core/src/main/java/org/argeo/slc/core/execution/ExecutionResources.java

   1 package org.argeo.slc.core.execution;
   2
   3 import java.io.File;
   4
   5 import org.springframework.core.io.Resource;
   6
   7 public interface ExecutionResources {
   8         /** The base directory where this execution can write */
   9         public File getWritableBaseDir();
  10
  11         /** Allocates a local file in the writable area and return it as a resource. */
  12         public Resource getWritableResource(String relativePath);
  13
  14         /**
  15          * Allocates a local file in the writable area and return it as a fully
  16          * qualified OS path.
  17          */
  18         public String getWritableOsPath(String relativePath);
  19
  20         /**
  21          * Allocates a local file in the writable area and return it as a
  22          * {@link File}.
  23          */
  24         public File getWritableOsFile(String relativePath);
  25
  26         /**
  27          * Returns the resource as a file path. If the resource is not writable it
  28          * is copied as a file in the writable area and the path to this local file
  29          * is returned.
  30          */
  31         public String getAsOsPath(Resource resource, Boolean overwrite);
  32 }