com.esri.arcgis.system

Interface OutputStore

All Known Implementing Classes:

ServerOutputStore

public interface OutputStore

An interface to represent the output store and common calls to make to it Platform (k8s or windows/linux) agnostic

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String fileName) Deletes a file from the output store
boolean	exists(java.lang.String fileName)
java.lang.String	getServicePhysicalOutputDir()
java.lang.String	getServiceVirtualOutputDir()
java.util.List	listFiles() List all files in the service's output directory
java.util.List	listFiles(java.lang.String subDir) List all the files in a sub-directory of a service's output directory
void	read(java.lang.String fileName, java.io.OutputStream out) Reads the file from the Output
void	write(java.lang.String fileName, java.io.InputStream in, long size) Writes the input stream to the specified file.

Method Detail

write

void write(java.lang.String fileName,
           java.io.InputStream in,
           long size)
    throws java.lang.IllegalArgumentException,
           java.io.IOException

Writes the input stream to the specified file. Will overwrite a file if it exists. The file will be accessible at {root}/arcgisoutput/{service_id}/{fileName}

Parameters:

fileName - can contain subdirectories

in - the origin file as an InputStream

size - the size of the origin file

Throws:

java.lang.IllegalArgumentException - if any of the args is empty or null

java.io.IOException - if there was an error writing the input stream to the specified file

read

void read(java.lang.String fileName,
          java.io.OutputStream out)
   throws java.lang.IllegalArgumentException,
          java.io.IOException

Reads the file from the Output

Parameters:

fileName - can contain subdirectories

Throws:

java.io.IOException - if there was an error reading the file

java.lang.IllegalArgumentException

exists

boolean exists(java.lang.String fileName)
        throws java.lang.IllegalArgumentException,
               java.io.IOException

Parameters:

fileName - can contain subdirectories

Returns:

Whether or not the file exists in the output store

Throws:

java.lang.IllegalArgumentException - if fileName is empty or null

java.io.IOException - if there was an error checking whether a file exists

delete

void delete(java.lang.String fileName)
     throws java.lang.IllegalArgumentException,
            java.io.IOException

Deletes a file from the output store

Parameters:

fileName - can contain subdirectories

Throws:

java.lang.IllegalArgumentException - if fileName is empty or null

java.io.IOException - if there was an error checking whether a file exists

listFiles

java.util.List listFiles()
                  throws java.io.IOException

List all files in the service's output directory

Returns:

a list of the paths (from the arcgisoutput directory) of the files in a subdirectory

Throws:

java.io.IOException

listFiles

java.util.List listFiles(java.lang.String subDir)
                  throws java.io.IOException

List all the files in a sub-directory of a service's output directory

Parameters:

subDir - - the subdirectory to list files from

Returns:

a list of the paths (from the subdirectory) of the files in a subdirectory

Throws:

java.io.IOException

getServiceVirtualOutputDir

java.lang.String getServiceVirtualOutputDir()
                                     throws java.io.IOException

Returns:

the virtual output directory

Throws:

java.io.IOException - if there was an error retrieving the virtual output directory

getServicePhysicalOutputDir

java.lang.String getServicePhysicalOutputDir()
                                      throws java.io.IOException

Returns:

the physical output directory

Throws:

java.io.IOException - if there was an error retrieving the virtual output directory