Package omero.api

Interface RawFileStorePrx

    • Method Detail

      • setFileId

        void setFileId​(long fileId)
        throws ServerError
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Throws:
        ServerError

      • setFileId

        void setFileId​(long fileId,
               java.util.Map<java.lang.String,​java.lang.String> __ctx)
        throws ServerError
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Returns:
        The asynchronous result object.

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId,
                                java.util.Map<java.lang.String,​java.lang.String> __ctx)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId,
                                Ice.Callback __cb)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId,
                                java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                Ice.Callback __cb)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId,
                                Callback_RawFileStore_setFileId __cb)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_setFileId

        Ice.AsyncResult begin_setFileId​(long fileId,
                                java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                Callback_RawFileStore_setFileId __cb)
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_setFileId

        void end_setFileId​(Ice.AsyncResult __result)
            throws ServerError
        This method manages the state of the service. This method will throw a SecurityViolation if for the current user context either the file is not readable or a omero.constants.permissions.BINARYACCESS restriction is in place.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • getFileId

        RLong getFileId​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
         throws ServerError
        Returns the current file id or null if none has been set.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_getFileId

        Ice.AsyncResult begin_getFileId()
        Returns the current file id or null if none has been set.
        Returns:
        The asynchronous result object.

      • begin_getFileId

        Ice.AsyncResult begin_getFileId​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Returns the current file id or null if none has been set.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_getFileId

        Ice.AsyncResult begin_getFileId​(Ice.Callback __cb)
        Returns the current file id or null if none has been set.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_getFileId

        Ice.AsyncResult begin_getFileId​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                Ice.Callback __cb)
        Returns the current file id or null if none has been set.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_getFileId

        Ice.AsyncResult begin_getFileId​(Callback_RawFileStore_getFileId __cb)
        Returns the current file id or null if none has been set.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_getFileId

        Ice.AsyncResult begin_getFileId​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                                Callback_RawFileStore_getFileId __cb)
        Returns the current file id or null if none has been set.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_getFileId

        RLong end_getFileId​(Ice.AsyncResult __result)
             throws ServerError
        Returns the current file id or null if none has been set.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • read

        byte[] read​(long position,
            int length)
     throws ServerError
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Throws:
        ServerError

      • read

        byte[] read​(long position,
            int length,
            java.util.Map<java.lang.String,​java.lang.String> __ctx)
     throws ServerError
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           Ice.Callback __cb)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Ice.Callback __cb)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           Callback_RawFileStore_read __cb)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_read

        Ice.AsyncResult begin_read​(long position,
                           int length,
                           java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Callback_RawFileStore_read __cb)
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_read

        byte[] end_read​(Ice.AsyncResult __result)
         throws ServerError
        Reads length bytes of data at the position from the raw file into an array of bytes.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • size

        long size()
   throws ServerError
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Throws:
        ServerError

      • size

        long size​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
   throws ServerError
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_size

        Ice.AsyncResult begin_size()
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Returns:
        The asynchronous result object.

      • begin_size

        Ice.AsyncResult begin_size​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_size

        Ice.AsyncResult begin_size​(Ice.Callback __cb)
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_size

        Ice.AsyncResult begin_size​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Ice.Callback __cb)
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_size

        Ice.AsyncResult begin_size​(Callback_RawFileStore_size __cb)
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_size

        Ice.AsyncResult begin_size​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Callback_RawFileStore_size __cb)
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_size

        long end_size​(Ice.AsyncResult __result)
       throws ServerError
        Returns the size of the file on disk (not as stored in the database since that value will only be updated on save. If the file has not yet been written to, and therefore does not exist, a ResourceError will be thrown.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • truncate

        boolean truncate​(long length)
          throws ServerError
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Throws:
        ServerError

      • truncate

        boolean truncate​(long length,
                 java.util.Map<java.lang.String,​java.lang.String> __ctx)
          throws ServerError
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Returns:
        The asynchronous result object.

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length,
                               Ice.Callback __cb)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx,
                               Ice.Callback __cb)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length,
                               Callback_RawFileStore_truncate __cb)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_truncate

        Ice.AsyncResult begin_truncate​(long length,
                               java.util.Map<java.lang.String,​java.lang.String> __ctx,
                               Callback_RawFileStore_truncate __cb)
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_truncate

        boolean end_truncate​(Ice.AsyncResult __result)
              throws ServerError
        Limits the size of a file to the given length. If the file is already shorter than length, no action is taken in which case false is returned.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • write

        void write​(byte[] buf,
           long position,
           int length)
    throws ServerError
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Throws:
        ServerError

      • write

        void write​(byte[] buf,
           long position,
           int length,
           java.util.Map<java.lang.String,​java.lang.String> __ctx)
    throws ServerError
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Throws:
        ServerError

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Returns:
        The asynchronous result object.

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length,
                            java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length,
                            Ice.Callback __cb)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length,
                            java.util.Map<java.lang.String,​java.lang.String> __ctx,
                            Ice.Callback __cb)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length,
                            Callback_RawFileStore_write __cb)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_write

        Ice.AsyncResult begin_write​(byte[] buf,
                            long position,
                            int length,
                            java.util.Map<java.lang.String,​java.lang.String> __ctx,
                            Callback_RawFileStore_write __cb)
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_write

        void end_write​(Ice.AsyncResult __result)
        throws ServerError
        Writes length bytes of data from the specified buf byte array starting at at position to the raw file.
        Parameters:
        __result - The asynchronous result object.
        Throws:
        ServerError

      • exists

        boolean exists()
        throws ServerError
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Returns:
        true if there is an accessible file within the original file repository with the correct ID. Otherwise false.
        Throws:
        ResourceError - if there is a problem accessing the file due to permissions errors within the repository or any other I/O error.
        ServerError

      • exists

        boolean exists​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        throws ServerError
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        true if there is an accessible file within the original file repository with the correct ID. Otherwise false.
        Throws:
        ResourceError - if there is a problem accessing the file due to permissions errors within the repository or any other I/O error.
        ServerError

      • begin_exists

        Ice.AsyncResult begin_exists()
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Returns:
        The asynchronous result object.

      • begin_exists

        Ice.AsyncResult begin_exists​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_exists

        Ice.AsyncResult begin_exists​(Ice.Callback __cb)
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_exists

        Ice.AsyncResult begin_exists​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                             Ice.Callback __cb)
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_exists

        Ice.AsyncResult begin_exists​(Callback_RawFileStore_exists __cb)
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_exists

        Ice.AsyncResult begin_exists​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                             Callback_RawFileStore_exists __cb)
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • end_exists

        boolean end_exists​(Ice.AsyncResult __result)
            throws ServerError
        Checks to see if a raw file exists with the file ID that the service was initialized with.
        Parameters:
        __result - The asynchronous result object.
        Returns:
        true if there is an accessible file within the original file repository with the correct ID. Otherwise false.
        Throws:
        ResourceError - if there is a problem accessing the file due to permissions errors within the repository or any other I/O error.
        ServerError

      • begin_save

        Ice.AsyncResult begin_save​(java.util.Map<java.lang.String,​java.lang.String> __ctx)
        Saves the OriginalFile associated with the service if it has been modified. The returned valued should replace all instances of the OriginalFile in the client. If save has not been called, RawFileStore instances will save the OriginalFile object associated with it on close. See also ticket 1651 and ticket 2161.
        Parameters:
        __ctx - The Context map to send with the invocation.
        Returns:
        The asynchronous result object.

      • begin_save

        Ice.AsyncResult begin_save​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Ice.Callback __cb)
        Saves the OriginalFile associated with the service if it has been modified. The returned valued should replace all instances of the OriginalFile in the client. If save has not been called, RawFileStore instances will save the OriginalFile object associated with it on close. See also ticket 1651 and ticket 2161.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.

      • begin_save

        Ice.AsyncResult begin_save​(java.util.Map<java.lang.String,​java.lang.String> __ctx,
                           Callback_RawFileStore_save __cb)
        Saves the OriginalFile associated with the service if it has been modified. The returned valued should replace all instances of the OriginalFile in the client. If save has not been called, RawFileStore instances will save the OriginalFile object associated with it on close. See also ticket 1651 and ticket 2161.
        Parameters:
        __ctx - The Context map to send with the invocation.
        __cb - The asynchronous callback object.
        Returns:
        The asynchronous result object.