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

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.slc.core.execution;
  17
  18 import java.io.File;
  19
  20 import org.springframework.core.io.Resource;
  21
  22 /** Provides write access to resources during execution */
  23 public interface ExecutionResources {
  24         /** The base directory where this execution can write */
  25         public File getWritableBaseDir();
  26
  27         /** Allocates a local file in the writable area and return it as a resource. */
  28         public Resource getWritableResource(String relativePath);
  29
  30         /**
  31          * Allocates a local file in the writable area and return it as a fully
  32          * qualified OS path.
  33          */
  34         public String getWritableOsPath(String relativePath);
  35
  36         /**
  37          * Allocates a local file in the writable area and return it as a
  38          * {@link File}.
  39          */
  40         public File getWritableOsFile(String relativePath);
  41
  42         /**
  43          * Returns the resource as a file path. If the resource is not writable it
  44          * is copied as a file in the writable area and the path to this local file
  45          * is returned.
  46          */
  47         public String getAsOsPath(Resource resource, Boolean overwrite);
  48 }