Package omero.grid

Interface _SharedResourcesOperations

  • All Known Subinterfaces:
    SharedResources
    All Known Implementing Classes:
    _SharedResourcesDisp, _SharedResourcesTie, SharedResourcesI
    public interface _SharedResourcesOperations
    Resource manager provided by each Blitz session for acquiring shared resources in the OmeroGrid. Unlike the other services provided by ServiceFactory instances, it is not guaranteed that a service instance returned from this interface will be returned if that resource happens to be busy. In that case, a null will be returned.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      InteractiveProcessorPrx acquireProcessor​(Job job, int seconds, Ice.Current __current)
      Waits up to seconds to acquire a slot in a processor which can handle the given job.
      void addProcessor​(ProcessorPrx proc, Ice.Current __current)
      Registers a Processor for Storm notifications so that other sessions can query whether or not a given processor would accept a given task.
      boolean areTablesEnabled​(Ice.Current __current)
      Returns true if a Tables service is active in the grid.
      RepositoryPrx getScriptRepository​(Ice.Current __current)
      Returns the single (possibly mirrored) script repository which makes all official scripts available.
      TablePrx newTable​(long repoId, java.lang.String path, Ice.Current __current)
      Creates a new Format(""OMERO.tables"") file at the given path on the given repository.
      TablePrx openTable​(OriginalFile file, Ice.Current __current)
      Returns a Table instance or null.
      void removeProcessor​(ProcessorPrx proc, Ice.Current __current)
      Unregisters a Processor from Storm notifications.
      RepositoryMap repositories​(Ice.Current __current)
      Returns a map between Repository descriptions (omero::model::OriginalFile instances) and RepositoryPrx instances (possibly null).

    • Method Detail

      • acquireProcessor

        InteractiveProcessorPrx acquireProcessor​(Job job,
                                         int seconds,
                                         Ice.Current __current)
                                  throws ServerError
        Waits up to seconds to acquire a slot in a processor which can handle the given job.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • addProcessor

        void addProcessor​(ProcessorPrx proc,
                  Ice.Current __current)
           throws ServerError
        Registers a Processor for Storm notifications so that other sessions can query whether or not a given processor would accept a given task.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • removeProcessor

        void removeProcessor​(ProcessorPrx proc,
                     Ice.Current __current)
              throws ServerError
        Unregisters a Processor from Storm notifications. If the processor was not already registered via addProcessor this is a no-op.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • repositories

        RepositoryMap repositories​(Ice.Current __current)
                    throws ServerError
        Returns a map between Repository descriptions (omero::model::OriginalFile instances) and RepositoryPrx instances (possibly null).
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • getScriptRepository

        RepositoryPrx getScriptRepository​(Ice.Current __current)
                           throws ServerError
        Returns the single (possibly mirrored) script repository which makes all official scripts available.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • areTablesEnabled

        boolean areTablesEnabled​(Ice.Current __current)
                  throws ServerError
        Returns true if a Tables service is active in the grid. If this value is false, then all calls to #ewTable or openTable will either fail or return null (possibly blocking while waiting for a service to startup)
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • newTable

        TablePrx newTable​(long repoId,
                  java.lang.String path,
                  Ice.Current __current)
           throws ServerError
        Creates a new Format(""OMERO.tables"") file at the given path on the given repository. The returned Table proxy follows the same semantics as the openTable method.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError

      • openTable

        TablePrx openTable​(OriginalFile file,
                   Ice.Current __current)
            throws ServerError
        Returns a Table instance or null. Table instances are not exclusively owned by the client and may throw an OptimisticLockException if background modifications take place. The file instance must be managed (i.e. have a non-null id) and be of the format ""OMERO.tables"". Use newTable() to create a new instance.
        Parameters:
        __current - The Current object for the invocation.
        Throws:
        ServerError