Package com.zeroc.IcePatch2

Interface FileServer

All Superinterfaces:
Object
public interface FileServer extends Object
The interface that provides access to files.

  • Method Details

    • getFileInfoSeq

      @Deprecated FileInfo[] getFileInfoSeq(int partition, Current current) throws FileSizeRangeException, PartitionOutOfRangeException
      Deprecated.
      getFileInfoSeq() is deprecated, use getLargeFileInfoSeq() instead.
      Return file information for the specified partition.

      This operation is deprecated and only present for compatibility with old Ice clients (older than version 3.6).

      Parameters:
      partition - The partition number in the range 0-255.
      current - The Current object for the invocation.
      Returns:
      A sequence containing information about the files in the specified partition.
      Throws:
      FileSizeRangeException - If a file is larger than 2.1GB.
      PartitionOutOfRangeException - If the partition number is out of range.

    • getLargeFileInfoSeq

      LargeFileInfo[] getLargeFileInfoSeq(int partition, Current current) throws PartitionOutOfRangeException
      Returns file information for the specified partition.
      Parameters:
      partition - The partition number in the range 0-255.
      current - The Current object for the invocation.
      Returns:
      A sequence containing information about the files in the specified partition.
      Throws:
      PartitionOutOfRangeException - If the partition number is out of range.

    • getChecksumSeq

      byte[][] getChecksumSeq(Current current)
      Return the checksums for all partitions.
      Parameters:
      current - The Current object for the invocation.
      Returns:
      A sequence containing 256 checksums. Partitions with a checksum that differs from the previous checksum for the same partition contain updated files. Partitions with a checksum that is identical to the previous checksum do not contain updated files.

    • getChecksum

      byte[] getChecksum(Current current)
      Return the master checksum for all partitions. If this checksum is the same as for a previous run, the entire file set is up-to-date.
      Parameters:
      current - The Current object for the invocation.
      Returns:
      The master checksum for the file set.

    • getFileCompressedAsync

      @Deprecated CompletionStage<byte[]> getFileCompressedAsync(String path, int pos, int num, Current current) throws FileAccessException, FileSizeRangeException
      Deprecated.
      getFileCompressed() is deprecated, use getLargeFileCompressed() instead.
      Read the specified file. This operation may only return fewer bytes than requested in case there was an end-of-file condition.

      This operation is deprecated and only present for compatibility with old Ice clients (older than version 3.6).

      Parameters:
      path - The pathname (relative to the data directory) for the file to be read.
      pos - The file offset at which to begin reading.
      num - The number of bytes to be read.
      current - The Current object for the invocation.
      Returns:
      A sequence containing the compressed file contents.
      Throws:
      FileAccessException - If an error occurred while trying to read the file.
      FileSizeRangeException - If a file is larger than 2.1GB.

    • getLargeFileCompressedAsync

      CompletionStage<byte[]> getLargeFileCompressedAsync(String path, long pos, int num, Current current) throws FileAccessException
      Read the specified file. This operation may only return fewer bytes than requested in case there was an end-of-file condition.
      Parameters:
      path - The pathname (relative to the data directory) for the file to be read.
      pos - The file offset at which to begin reading.
      num - The number of bytes to be read.
      current - The Current object for the invocation.
      Returns:
      A sequence containing the compressed file contents.
      Throws:
      FileAccessException - If an error occurred while trying to read the file.

    • ice_ids

      default String[] ice_ids(Current current)
      Description copied from interface: Object
      Returns the Slice type IDs of the interfaces supported by this object.
      Specified by:
      ice_ids in interface Object
      Parameters:
      current - The Current object for the invocation.
      Returns:
      The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

    • ice_id

      default String ice_id(Current current)
      Description copied from interface: Object
      Returns the Slice type ID of the most-derived interface supported by this object.
      Specified by:
      ice_id in interface Object
      Parameters:
      current - The Current object for the invocation.
      Returns:
      The Slice type ID of the most-derived interface.

    • ice_staticId

      static String ice_staticId()
      Description copied from interface: Object
      Returns the Slice type ID of the interface supported by this object.
      Returns:
      The return value is always ::Ice::Object.