com.dtolabs.rundeck.core.logging

Interface ExecutionFileStorage

All Known Subinterfaces:

ExecutionFileStoragePlugin

public interface ExecutionFileStorage

Handles storage and retrieval of typed files for an execution, the filetype is specified in the store(String, java.io.InputStream, long, java.util.Date) and retrieve(String, java.io.OutputStream) methods, and more than one filetype may be stored or retrieved for the same execution.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	retrieve(java.lang.String filetype, java.io.OutputStream stream) Write a file of the given file type to the given stream
boolean	store(java.lang.String filetype, java.io.InputStream stream, long length, java.util.Date lastModified) Stores a file of the given file type, read from the given stream

Method Detail

store

boolean store(java.lang.String filetype,
            java.io.InputStream stream,
            long length,
            java.util.Date lastModified)
              throws java.io.IOException,
                     ExecutionFileStorageException

Stores a file of the given file type, read from the given stream

Parameters:

filetype - filetype or extension of the file to store

stream - the input stream

length - the file length

lastModified - the file modification time

Returns:

true if successful

Throws:

java.io.IOException - if an IO error occurs

ExecutionFileStorageException - if other errors occur

retrieve

boolean retrieve(java.lang.String filetype,
               java.io.OutputStream stream)
                 throws java.io.IOException,
                        ExecutionFileStorageException

Write a file of the given file type to the given stream

Parameters:

filetype - key to identify stored file

stream - the output stream

Returns:

true if successful

Throws:

java.io.IOException - if an IO error occurs

ExecutionFileStorageException - if other errors occur