Package com.zeroc.IcePatch2

Interface FileServerPrx

All Superinterfaces:
ObjectPrx
public interface FileServerPrx extends ObjectPrx
The interface that provides access to files.

  • Method Details

    • getFileInfoSeq

      @Deprecated default FileInfo[] getFileInfoSeq(int partition) 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.
      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.

    • getFileInfoSeq

      @Deprecated default FileInfo[] getFileInfoSeq(int partition, Map<String,String> context) 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.
      context - The Context map to send with 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.

    • getFileInfoSeqAsync

      @Deprecated default CompletableFuture<FileInfo[]> getFileInfoSeqAsync(int partition)
      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.
      Returns:
      A sequence containing information about the files in the specified partition.

    • getFileInfoSeqAsync

      @Deprecated default CompletableFuture<FileInfo[]> getFileInfoSeqAsync(int partition, Map<String,String> context)
      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.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing information about the files in the specified partition.

    • getLargeFileInfoSeq

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

    • getLargeFileInfoSeq

      default LargeFileInfo[] getLargeFileInfoSeq(int partition, Map<String,String> context) throws PartitionOutOfRangeException
      Returns file information for the specified partition.
      Parameters:
      partition - The partition number in the range 0-255.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing information about the files in the specified partition.
      Throws:
      PartitionOutOfRangeException - If the partition number is out of range.

    • getLargeFileInfoSeqAsync

      default CompletableFuture<LargeFileInfo[]> getLargeFileInfoSeqAsync(int partition)
      Returns file information for the specified partition.
      Parameters:
      partition - The partition number in the range 0-255.
      Returns:
      A sequence containing information about the files in the specified partition.

    • getLargeFileInfoSeqAsync

      default CompletableFuture<LargeFileInfo[]> getLargeFileInfoSeqAsync(int partition, Map<String,String> context)
      Returns file information for the specified partition.
      Parameters:
      partition - The partition number in the range 0-255.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing information about the files in the specified partition.

    • getChecksumSeq

      default byte[][] getChecksumSeq()
      Return the checksums for all partitions.
      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.

    • getChecksumSeq

      default byte[][] getChecksumSeq(Map<String,String> context)
      Return the checksums for all partitions.
      Parameters:
      context - The Context map to send with 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.

    • getChecksumSeqAsync

      default CompletableFuture<byte[][]> getChecksumSeqAsync()
      Return the checksums for all partitions.
      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.

    • getChecksumSeqAsync

      default CompletableFuture<byte[][]> getChecksumSeqAsync(Map<String,String> context)
      Return the checksums for all partitions.
      Parameters:
      context - The Context map to send with 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

      default byte[] getChecksum()
      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.
      Returns:
      The master checksum for the file set.

    • getChecksum

      default byte[] getChecksum(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      The master checksum for the file set.

    • getChecksumAsync

      default CompletableFuture<byte[]> getChecksumAsync()
      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.
      Returns:
      The master checksum for the file set.

    • getChecksumAsync

      default CompletableFuture<byte[]> getChecksumAsync(Map<String,String> context)
      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:
      context - The Context map to send with the invocation.
      Returns:
      The master checksum for the file set.

    • getFileCompressed

      @Deprecated default byte[] getFileCompressed(String path, int pos, int num) throws FileSizeRangeException, FileAccessException
      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.
      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.

    • getFileCompressed

      @Deprecated default byte[] getFileCompressed(String path, int pos, int num, Map<String,String> context) throws FileSizeRangeException, FileAccessException
      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.
      context - The Context map to send with 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.

    • getFileCompressedAsync

      @Deprecated default CompletableFuture<byte[]> getFileCompressedAsync(String path, int pos, int num)
      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.
      Returns:
      A sequence containing the compressed file contents.

    • getFileCompressedAsync

      @Deprecated default CompletableFuture<byte[]> getFileCompressedAsync(String path, int pos, int num, Map<String,String> context)
      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.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing the compressed file contents.

    • getLargeFileCompressed

      default byte[] getLargeFileCompressed(String path, long pos, int num) 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.
      Returns:
      A sequence containing the compressed file contents.
      Throws:
      FileAccessException - If an error occurred while trying to read the file.

    • getLargeFileCompressed

      default byte[] getLargeFileCompressed(String path, long pos, int num, Map<String,String> context) 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.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing the compressed file contents.
      Throws:
      FileAccessException - If an error occurred while trying to read the file.

    • getLargeFileCompressedAsync

      default CompletableFuture<byte[]> getLargeFileCompressedAsync(String path, long pos, int num)
      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.
      Returns:
      A sequence containing the compressed file contents.

    • getLargeFileCompressedAsync

      default CompletableFuture<byte[]> getLargeFileCompressedAsync(String path, long pos, int num, Map<String,String> context)
      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.
      context - The Context map to send with the invocation.
      Returns:
      A sequence containing the compressed file contents.

    • checkedCast

      static FileServerPrx checkedCast(ObjectPrx obj)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static FileServerPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static FileServerPrx checkedCast(ObjectPrx obj, String facet)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • checkedCast

      static FileServerPrx checkedCast(ObjectPrx obj, String facet, Map<String,String> context)
      Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      context - The Context map to send with the invocation.
      Returns:
      A proxy for this type, or null if the object does not support this type.

    • uncheckedCast

      static FileServerPrx uncheckedCast(ObjectPrx obj)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type.

    • uncheckedCast

      static FileServerPrx uncheckedCast(ObjectPrx obj, String facet)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      facet - The name of the desired facet.
      Returns:
      A proxy for this type.

    • ice_context

      default FileServerPrx ice_context(Map<String,String> newContext)
      Returns a proxy that is identical to this proxy, except for the per-proxy context.
      Specified by:
      ice_context in interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the specified per-proxy context.

    • ice_adapterId

      default FileServerPrx ice_adapterId(String newAdapterId)
      Returns a proxy that is identical to this proxy, except for the adapter ID.
      Specified by:
      ice_adapterId in interface ObjectPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the specified adapter ID.

    • ice_endpoints

      default FileServerPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns a proxy that is identical to this proxy, except for the endpoints.
      Specified by:
      ice_endpoints in interface ObjectPrx
      Parameters:
      newEndpoints - The endpoints for the new proxy.
      Returns:
      A proxy with the specified endpoints.

    • ice_locatorCacheTimeout

      default FileServerPrx ice_locatorCacheTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the locator cache timeout.
      Specified by:
      ice_locatorCacheTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default FileServerPrx ice_invocationTimeout(int newTimeout)
      Returns a proxy that is identical to this proxy, except for the invocation timeout.
      Specified by:
      ice_invocationTimeout in interface ObjectPrx
      Parameters:
      newTimeout - The new invocation timeout (in seconds).
      Returns:
      A proxy with the specified invocation timeout.

    • ice_connectionCached

      default FileServerPrx ice_connectionCached(boolean newCache)
      Returns a proxy that is identical to this proxy, except for connection caching.
      Specified by:
      ice_connectionCached in interface ObjectPrx
      Parameters:
      newCache - true if the new proxy should cache connections; false otherwise.
      Returns:
      A proxy with the specified caching policy.

    • ice_endpointSelection

      default FileServerPrx ice_endpointSelection(EndpointSelectionType newType)
      Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
      Specified by:
      ice_endpointSelection in interface ObjectPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      A proxy with the specified endpoint selection policy.
      See Also:

    • ice_secure

      default FileServerPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      Specified by:
      ice_secure in interface ObjectPrx
      Parameters:
      b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.
      Returns:
      A proxy with the specified selection policy.

    • ice_encodingVersion

      default FileServerPrx ice_encodingVersion(EncodingVersion e)
      Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
      Specified by:
      ice_encodingVersion in interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      A proxy with the specified encoding version.

    • ice_preferSecure

      default FileServerPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      Specified by:
      ice_preferSecure in interface ObjectPrx
      Parameters:
      b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.
      Returns:
      A proxy with the specified selection policy.

    • ice_router

      default FileServerPrx ice_router(RouterPrx router)
      Returns a proxy that is identical to this proxy, except for the router.
      Specified by:
      ice_router in interface ObjectPrx
      Parameters:
      router - The router for the new proxy.
      Returns:
      A proxy with the specified router.

    • ice_locator

      default FileServerPrx ice_locator(LocatorPrx locator)
      Returns a proxy that is identical to this proxy, except for the locator.
      Specified by:
      ice_locator in interface ObjectPrx
      Parameters:
      locator - The locator for the new proxy.
      Returns:
      A proxy with the specified locator.

    • ice_collocationOptimized

      default FileServerPrx ice_collocationOptimized(boolean b)
      Returns a proxy that is identical to this proxy, except for collocation optimization.
      Specified by:
      ice_collocationOptimized in interface ObjectPrx
      Parameters:
      b - true if the new proxy enables collocation optimization; false otherwise.
      Returns:
      A proxy with the specified collocation optimization.

    • ice_twoway

      default FileServerPrx ice_twoway()
      Returns a proxy that is identical to this proxy, but uses twoway invocations.
      Specified by:
      ice_twoway in interface ObjectPrx
      Returns:
      A proxy that uses twoway invocations.

    • ice_oneway

      default FileServerPrx ice_oneway()
      Returns a proxy that is identical to this proxy, but uses oneway invocations.
      Specified by:
      ice_oneway in interface ObjectPrx
      Returns:
      A proxy that uses oneway invocations.

    • ice_batchOneway

      default FileServerPrx ice_batchOneway()
      Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
      Specified by:
      ice_batchOneway in interface ObjectPrx
      Returns:
      A proxy that uses batch oneway invocations.

    • ice_datagram

      default FileServerPrx ice_datagram()
      Returns a proxy that is identical to this proxy, but uses datagram invocations.
      Specified by:
      ice_datagram in interface ObjectPrx
      Returns:
      A proxy that uses datagram invocations.

    • ice_batchDatagram

      default FileServerPrx ice_batchDatagram()
      Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
      Specified by:
      ice_batchDatagram in interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.

    • ice_compress

      default FileServerPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      Specified by:
      ice_compress in interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.

    • ice_timeout

      default FileServerPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting.
      Specified by:
      ice_timeout in interface ObjectPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

      default FileServerPrx ice_connectionId(String connectionId)
      Returns a proxy that is identical to this proxy, except for its connection ID.
      Specified by:
      ice_connectionId in interface ObjectPrx
      Parameters:
      connectionId - The connection ID for the new proxy. An empty string removes the connection ID.
      Returns:
      A proxy with the specified connection ID.

    • ice_fixed

      default FileServerPrx ice_fixed(Connection connection)
      Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.
      Specified by:
      ice_fixed in interface ObjectPrx
      Parameters:
      connection - The fixed proxy connection.
      Returns:
      A fixed proxy bound to the given connection.

    • ice_staticId

      static String ice_staticId()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.