Gateway (omero-gateway 5.6.9 API)

java.lang.Object
- omero.gateway.Gateway

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class Gateway
extends java.lang.Object
implements java.lang.AutoCloseable
```
A Gateway for simplifying access to an OMERO server

Since:

5.1

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_CONNECTOR_CLOSED` Property to indicate that a `Connector` has been closed
`static java.lang.String`	`PROP_CONNECTOR_CREATED` Property to indicate that a `Connector` has been created
`static java.lang.String`	`PROP_FACILITY_CLOSED` Property to indicate that a `Facility` has been closed
`static java.lang.String`	`PROP_FACILITY_CREATED` Property to indicate that a `Facility` has been created
`static java.lang.String`	`PROP_IMPORTSTORE_CLOSED` Property to indicate that an import store has been closed
`static java.lang.String`	`PROP_IMPORTSTORE_CREATED` Property to indicate that an import store has been created
`static java.lang.String`	`PROP_RENDERINGENGINE_CLOSED` Property to indicate that a rendering engine has been closed
`static java.lang.String`	`PROP_RENDERINGENGINE_CREATED` Property to indicate that a rendering engine has been created
`static java.lang.String`	`PROP_SESSION_CLOSED` Property to indicate that a session has been closed
`static java.lang.String`	`PROP_SESSION_CREATED` Property to indicate that a session has been created
`static java.lang.String`	`PROP_SESSION_DETACHED` Property to indicate that client got detached from a session
`static java.lang.String`	`PROP_STATEFUL_SERVICE_CLOSED` Property to indicate that a stateful service has been closed
`static java.lang.String`	`PROP_STATEFUL_SERVICE_CREATED` Property to indicate that a stateful service has been created
`static java.lang.String`	`PROP_STATELESS_SERVICE_CREATED` Property to indicate that a stateless service has been created

Constructor Summary

Constructors
Constructor and Description
`Gateway(omero.log.Logger log)` Creates a new Gateway instance
`Gateway(omero.log.Logger log, CacheService cacheService)` Deprecated. This constructor will be removed in future. Please use `instead`
`Gateway(omero.log.Logger log, CacheService cacheService, java.util.concurrent.ExecutorService executorService, boolean executorShutdownOnDisconnect)` Deprecated. This constructor will be removed in future. Please use `instead`
`Gateway(omero.log.Logger log, java.util.concurrent.ExecutorService executorService, boolean executorShutdownOnDisconnect)` Creates a new Gateway instance

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)` Adds a `PropertyChangeListener`
`java.lang.Boolean`	`canCreate(SecurityContext ctx)` Get the read-only status of the server.
`void`	`close()`
`void`	`closeConnector(SecurityContext ctx)` Close a connector for a certain `SecurityContext`
`void`	`closeImport(SecurityContext ctx, java.lang.String userName)` Close Import for a certain user
`void`	`closeService(SecurityContext ctx, omero.api.StatefulServiceInterfacePrx svc)` Close a service
`void`	`closeSessionOnExit(SecurityContext ctx, boolean closeSession)` By default the session is closed if it was initialized by the gateway.
`ExperimenterData`	`connect(LoginCredentials c)` Connect to the server
`omero.api.RawPixelsStorePrx`	`createPixelsStore(SecurityContext ctx)` Create a `RawPixelsStorePrx`
`omero.api.ThumbnailStorePrx`	`createThumbnailStore(SecurityContext ctx)` Create a `ThumbnailStorePrx`
`void`	`disconnect()` Disconnects from the server
`omero.api.IAdminPrx`	`getAdminService(SecurityContext ctx)` Returns the `IAdminPrx` service.
`omero.api.IAdminPrx`	`getAdminService(SecurityContext ctx, boolean secure)` Returns the `IAdminPrx` service.
`CacheService`	`getCacheService()` Deprecated. This method will be removed in future.
`omero.api.IConfigPrx`	`getConfigService(SecurityContext ctx)` Returns the `IConfigPrx` service.
`omero.gateway.Connector`	`getConnector(SecurityContext ctx)` Get a connector for a certain `SecurityContext`
`omero.gateway.Connector`	`getConnector(SecurityContext ctx, boolean recreate, boolean permitNull)` Returns the connector corresponding to the passed context.
`omero.api.ExporterPrx`	`getExporterService(SecurityContext ctx)` Returns the `ExporterPrx` service.
`<T extends Facility> T`	`getFacility(java.lang.Class<T> type)` Get a `Facility` to perform further operations with the server
`ome.formats.OMEROMetadataStoreClient`	`getImportStore(SecurityContext ctx)` Creates or recycles the import store.
`ome.formats.OMEROMetadataStoreClient`	`getImportStore(SecurityContext ctx, java.lang.String userName)` Creates or recycles the import store.
`ExperimenterData`	`getLoggedInUser()` Get the currently logged in user
`omero.log.Logger`	`getLogger()` Provides access to the `Logger`
`omero.api.IMetadataPrx`	`getMetadataService(SecurityContext ctx)` Returns the `IMetadataPrx` service.
`omero.api.IPixelsPrx`	`getPixelsService(SecurityContext ctx)` Returns the `IPixelsPrx` service.
`omero.api.RawPixelsStorePrx`	`getPixelsStore(SecurityContext ctx)` Returns the `RawPixelsStorePrx` service.
`omero.api.IContainerPrx`	`getPojosService(SecurityContext ctx)` Returns the `IContainerPrx` service.
`omero.api.IProjectionPrx`	`getProjectionService(SecurityContext ctx)` Returns the `IProjectionPrx` service.
`java.beans.PropertyChangeListener[]`	`getPropertyChangeListeners()` Get the `PropertyChangeListener`s
`omero.api.IQueryPrx`	`getQueryService(SecurityContext ctx)` Returns the `IQueryPrx` service.
`omero.api.RawFileStorePrx`	`getRawFileService(SecurityContext ctx)` Returns the `RawFileStorePrx` service.
`java.util.Map<SecurityContext,java.util.Set<java.lang.Long>>`	`getRenderingEngines()` Returns the rendering engines to re-activate.
`omero.api.RenderingEnginePrx`	`getRenderingService(SecurityContext ctx, long pixelsID)` Returns the `Rendering service`.
`omero.api.IRenderingSettingsPrx`	`getRenderingSettingsService(SecurityContext ctx)` Returns the `IRenderingSettingsPrx` service.
`omero.api.IRepositoryInfoPrx`	`getRepositoryService(SecurityContext ctx)` Returns the `IRepositoryInfoPrx` service.
`omero.api.IRoiPrx`	`getROIService(SecurityContext ctx)` Returns the `IRoiPrx` service.
`omero.api.IScriptPrx`	`getScriptService(SecurityContext ctx)` Returns the `IScriptPrx` service.
`omero.api.SearchPrx`	`getSearchService(SecurityContext ctx)` Returns the `SearchPrx` service.
`java.lang.String`	`getServerVersion()` Get the version of the server the Gateway is connected to
`java.lang.String`	`getSessionId(ExperimenterData user)` Get the ID of the current session
`omero.grid.SharedResourcesPrx`	`getSharedResources(SecurityContext ctx)` Returns the `SharedResourcesPrx` service.
`omero.api.ThumbnailStorePrx`	`getThumbnailService(SecurityContext ctx)` Returns the `ThumbnailStorePrx` service.
`omero.api.ITypesPrx`	`getTypesService(SecurityContext ctx)` Returns the `ITypesPrx` service.
`omero.api.IUpdatePrx`	`getUpdateService(SecurityContext ctx)` Returns the `IUpdatePrx` service.
`omero.api.IUpdatePrx`	`getUpdateService(SecurityContext ctx, java.lang.String userName)` Returns the `IUpdatePrx` service.
`ExperimenterData`	`getUserDetails(SecurityContext ctx, java.lang.String name)` Get the user details of a certain user
`boolean`	`isAlive(SecurityContext ctx)` Checks if there is a `Connector` for a particular `SecurityContext`
`boolean`	`isConnected()` Check if the Gateway is still connected to the server
`boolean`	`isNetworkUp(boolean useCachedValue)` Checks if the network interface is up.
`boolean`	`joinSession()` Deprecated. This method will be removed in future (never used). Tries to rejoin the session.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)` Removes a `PropertyChangeListener`
`omero.grid.ProcessCallbackI`	`runScript(SecurityContext ctx, long scriptID, java.util.Map<java.lang.String,omero.RType> parameters)` Run a script on the server
`void`	`shutDownDerivedConnector(SecurityContext ctx)` Shuts down the connectors created while creating/importing data for other users.
`void`	`shutdownRenderingEngine(SecurityContext ctx, long pixelsID)` Shuts down the rendering engine
`<T> java.util.concurrent.Future<T>`	`submit(java.util.concurrent.Callable<T> task)` Submits an async task
`omero.cmd.CmdCallbackI`	`submit(SecurityContext ctx, java.util.List<omero.cmd.Request> commands, SecurityContext target)` Executes the commands.
`omero.cmd.CmdCallbackI`	`submit(SecurityContext ctx, omero.cmd.Request cmd)` Directly submit a `Request` to the server

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_CONNECTOR_CREATED
```
public static final java.lang.String PROP_CONNECTOR_CREATED
```
    Property to indicate that a Connector has been created
    
    See Also:
    
    Constant Field Values
  - PROP_CONNECTOR_CLOSED
```
public static final java.lang.String PROP_CONNECTOR_CLOSED
```
    Property to indicate that a Connector has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_SESSION_CREATED
```
public static final java.lang.String PROP_SESSION_CREATED
```
    Property to indicate that a session has been created
    
    See Also:
    
    Constant Field Values
  - PROP_SESSION_CLOSED
```
public static final java.lang.String PROP_SESSION_CLOSED
```
    Property to indicate that a session has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_SESSION_DETACHED
```
public static final java.lang.String PROP_SESSION_DETACHED
```
    Property to indicate that client got detached from a session
    
    See Also:
    
    Constant Field Values
  - PROP_FACILITY_CREATED
```
public static final java.lang.String PROP_FACILITY_CREATED
```
    Property to indicate that a Facility has been created
    
    See Also:
    
    Constant Field Values
  - PROP_FACILITY_CLOSED
```
public static final java.lang.String PROP_FACILITY_CLOSED
```
    Property to indicate that a Facility has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_IMPORTSTORE_CREATED
```
public static final java.lang.String PROP_IMPORTSTORE_CREATED
```
    Property to indicate that an import store has been created
    
    See Also:
    
    Constant Field Values
  - PROP_IMPORTSTORE_CLOSED
```
public static final java.lang.String PROP_IMPORTSTORE_CLOSED
```
    Property to indicate that an import store has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_RENDERINGENGINE_CREATED
```
public static final java.lang.String PROP_RENDERINGENGINE_CREATED
```
    Property to indicate that a rendering engine has been created
    
    See Also:
    
    Constant Field Values
  - PROP_RENDERINGENGINE_CLOSED
```
public static final java.lang.String PROP_RENDERINGENGINE_CLOSED
```
    Property to indicate that a rendering engine has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_STATEFUL_SERVICE_CREATED
```
public static final java.lang.String PROP_STATEFUL_SERVICE_CREATED
```
    Property to indicate that a stateful service has been created
    
    See Also:
    
    Constant Field Values
  - PROP_STATEFUL_SERVICE_CLOSED
```
public static final java.lang.String PROP_STATEFUL_SERVICE_CLOSED
```
    Property to indicate that a stateful service has been closed
    
    See Also:
    
    Constant Field Values
  - PROP_STATELESS_SERVICE_CREATED
```
public static final java.lang.String PROP_STATELESS_SERVICE_CREATED
```
    Property to indicate that a stateless service has been created
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Gateway
```
public Gateway(omero.log.Logger log)
```
    Creates a new Gateway instance
    
    Parameters:
    
    log - A Logger
  - Gateway
```
@Deprecated
public Gateway(omero.log.Logger log,
                           CacheService cacheService)
```
    Deprecated. This constructor will be removed in future. Please use instead
    
    Creates a new Gateway instance
    
    Parameters:
    
    log - A Logger
    
    cacheService - A CacheService, can be null
  - Gateway
```
@Deprecated
public Gateway(omero.log.Logger log,
                           CacheService cacheService,
                           java.util.concurrent.ExecutorService executorService,
                           boolean executorShutdownOnDisconnect)
```
    Deprecated. This constructor will be removed in future. Please use instead
    
    Creates a new Gateway instance
    
    Parameters:
    
    log - A Logger
    
    cacheService - A CacheService, can be null
    
    executorService - A ExecutorService for handling asynchronous tasks, can be null (in which case the Java built-in cached thread pool will be used)
    
    executorShutdownOnDisconnect - Flag to indicate that executor threads should be shutdown on disconnect (only taken into account if an ExecutorService was provided; the default cached thread pool will be shut down by default)
  - Gateway
```
public Gateway(omero.log.Logger log,
               java.util.concurrent.ExecutorService executorService,
               boolean executorShutdownOnDisconnect)
```
    Creates a new Gateway instance
    
    Parameters:
    
    log - A Logger
    
    executorService - A ExecutorService for handling asynchronous tasks, can be null (in which case the Java built-in cached thread pool will be used)
    
    executorShutdownOnDisconnect - Flag to indicate that executor threads should be shutdown on disconnect (only taken into account if an ExecutorService was provided; the default cached thread pool will be shut down by default)
- Method Detail
  - submit
```
public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> task)
```
    Submits an async task
    
    Parameters:
    
    task - The task
    
    Returns:
    
    The callback reference
  - connect
```
public ExperimenterData connect(LoginCredentials c)
                         throws DSOutOfServiceException
```
    Connect to the server
    
    Parameters:
    
    c - The LoginCredentials
    
    Returns:
    
    The ExperimenterData who is logged in
    
    Throws:
    
    DSOutOfServiceException - If the connection can't be established
  - getLoggedInUser
```
public ExperimenterData getLoggedInUser()
```
    Get the currently logged in user
    
    Returns:
    
    See above.
  - disconnect
```
public void disconnect()
```
    Disconnects from the server
  - joinSession
```
@Deprecated
public boolean joinSession()
```
    Deprecated. This method will be removed in future (never used). Tries to rejoin the session.
    
    Returns:
    
    See above.
  - isConnected
```
public boolean isConnected()
```
    Check if the Gateway is still connected to the server
    
    Returns:
    
    See above.
  - getSessionId
```
public java.lang.String getSessionId(ExperimenterData user)
                              throws DSOutOfServiceException
```
    Get the ID of the current session
    
    Parameters:
    
    user - The user to get the session ID for
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - getServerVersion
```
public java.lang.String getServerVersion()
                                  throws DSOutOfServiceException
```
    Get the version of the server the Gateway is connected to
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - getFacility
```
public <T extends Facility> T getFacility(java.lang.Class<T> type)
                                   throws java.util.concurrent.ExecutionException
```
    Get a Facility to perform further operations with the server
    
    Parameters:
    
    type - The kind of Facility to request
    
    Returns:
    
    See above
    
    Throws:
    
    java.util.concurrent.ExecutionException - If the Facility can't be retrieved or instantiated
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Adds a PropertyChangeListener
    
    Parameters:
    
    listener - The listener
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Removes a PropertyChangeListener
    
    Parameters:
    
    listener - The listener
  - getPropertyChangeListeners
```
public java.beans.PropertyChangeListener[] getPropertyChangeListeners()
```
    Get the PropertyChangeListeners
    
    Returns:
    
    See above
  - submit
```
public omero.cmd.CmdCallbackI submit(SecurityContext ctx,
                                     java.util.List<omero.cmd.Request> commands,
                                     SecurityContext target)
                              throws java.lang.Throwable
```
    Executes the commands.
    
    Parameters:
    
    ctx - The SecurityContext
    
    commands - The commands to execute.
    
    target - The target context is any.
    
    Returns:
    
    See above.
    
    Throws:
    
    java.lang.Throwable - If an error occurred
  - submit
```
public omero.cmd.CmdCallbackI submit(SecurityContext ctx,
                                     omero.cmd.Request cmd)
                              throws java.lang.Throwable
```
    Directly submit a Request to the server
    
    Parameters:
    
    ctx - The SecurityContext
    
    cmd - The Request to submit
    
    Returns:
    
    A callback reference, CmdCallbackI
    
    Throws:
    
    java.lang.Throwable - If an error occurred
  - closeImport
```
public void closeImport(SecurityContext ctx,
                        java.lang.String userName)
```
    Close Import for a certain user
    
    Parameters:
    
    ctx - The SecurityContext
    
    userName - The name of the user which import should be closed
  - runScript
```
public omero.grid.ProcessCallbackI runScript(SecurityContext ctx,
                                             long scriptID,
                                             java.util.Map<java.lang.String,omero.RType> parameters)
                                      throws DSOutOfServiceException,
                                             omero.ServerError
```
    Run a script on the server
    
    Parameters:
    
    ctx - The SecurityContext
    
    scriptID - The ID of the script
    
    parameters - Parameters for the script
    
    Returns:
    
    A callback reference, ProcessCallbackI
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
    
    omero.ServerError - If an error in the script execution occurred
  - getLogger
```
public omero.log.Logger getLogger()
```
    Provides access to the Logger
    
    Returns:
    
    See above
  - getCacheService
```
@Deprecated
public CacheService getCacheService()
```
    Deprecated. This method will be removed in future.
    
    Provides access to the CacheService
    
    Returns:
    
    See above
  - getSharedResources
```
public omero.grid.SharedResourcesPrx getSharedResources(SecurityContext ctx)
                                                 throws DSOutOfServiceException
```
    Returns the SharedResourcesPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getRenderingSettingsService
```
public omero.api.IRenderingSettingsPrx getRenderingSettingsService(SecurityContext ctx)
                                                            throws DSOutOfServiceException
```
    Returns the IRenderingSettingsPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getRepositoryService
```
public omero.api.IRepositoryInfoPrx getRepositoryService(SecurityContext ctx)
                                                  throws DSOutOfServiceException
```
    Returns the IRepositoryInfoPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getScriptService
```
public omero.api.IScriptPrx getScriptService(SecurityContext ctx)
                                      throws DSOutOfServiceException
```
    Returns the IScriptPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getPojosService
```
public omero.api.IContainerPrx getPojosService(SecurityContext ctx)
                                        throws DSOutOfServiceException
```
    Returns the IContainerPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getQueryService
```
public omero.api.IQueryPrx getQueryService(SecurityContext ctx)
                                    throws DSOutOfServiceException
```
    Returns the IQueryPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getUpdateService
```
public omero.api.IUpdatePrx getUpdateService(SecurityContext ctx)
                                      throws DSOutOfServiceException
```
    Returns the IUpdatePrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getUpdateService
```
public omero.api.IUpdatePrx getUpdateService(SecurityContext ctx,
                                             java.lang.String userName)
                                      throws DSOutOfServiceException
```
    Returns the IUpdatePrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    userName - The username
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getMetadataService
```
public omero.api.IMetadataPrx getMetadataService(SecurityContext ctx)
                                          throws DSOutOfServiceException
```
    Returns the IMetadataPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getROIService
```
public omero.api.IRoiPrx getROIService(SecurityContext ctx)
                                throws DSOutOfServiceException
```
    Returns the IRoiPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getConfigService
```
public omero.api.IConfigPrx getConfigService(SecurityContext ctx)
                                      throws DSOutOfServiceException
```
    Returns the IConfigPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getThumbnailService
```
public omero.api.ThumbnailStorePrx getThumbnailService(SecurityContext ctx)
                                                throws DSOutOfServiceException
```
    Returns the ThumbnailStorePrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getExporterService
```
public omero.api.ExporterPrx getExporterService(SecurityContext ctx)
                                         throws DSOutOfServiceException
```
    Returns the ExporterPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getRawFileService
```
public omero.api.RawFileStorePrx getRawFileService(SecurityContext ctx)
                                            throws DSOutOfServiceException
```
    Returns the RawFileStorePrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getPixelsStore
```
public omero.api.RawPixelsStorePrx getPixelsStore(SecurityContext ctx)
                                           throws DSOutOfServiceException
```
    Returns the RawPixelsStorePrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getPixelsService
```
public omero.api.IPixelsPrx getPixelsService(SecurityContext ctx)
                                      throws DSOutOfServiceException
```
    Returns the IPixelsPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getSearchService
```
public omero.api.SearchPrx getSearchService(SecurityContext ctx)
                                     throws DSOutOfServiceException
```
    Returns the SearchPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getProjectionService
```
public omero.api.IProjectionPrx getProjectionService(SecurityContext ctx)
                                              throws DSOutOfServiceException
```
    Returns the IProjectionPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getAdminService
```
public omero.api.IAdminPrx getAdminService(SecurityContext ctx)
                                    throws DSOutOfServiceException
```
    Returns the IAdminPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getAdminService
```
public omero.api.IAdminPrx getAdminService(SecurityContext ctx,
                                           boolean secure)
                                    throws DSOutOfServiceException
```
    Returns the IAdminPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    secure - Pass true to have a secure admin service, false otherwise.
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getImportStore
```
public ome.formats.OMEROMetadataStoreClient getImportStore(SecurityContext ctx)
                                                    throws DSOutOfServiceException
```
    Creates or recycles the import store.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getImportStore
```
public ome.formats.OMEROMetadataStoreClient getImportStore(SecurityContext ctx,
                                                           java.lang.String userName)
                                                    throws DSOutOfServiceException
```
    Creates or recycles the import store.
    
    Parameters:
    
    ctx - The SecurityContext
    
    userName - The username
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - getRenderingService
```
public omero.api.RenderingEnginePrx getRenderingService(SecurityContext ctx,
                                                        long pixelsID)
                                                 throws DSOutOfServiceException,
                                                        omero.ServerError
```
    Returns the Rendering service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    pixelsID - The pixels ID
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
    
    omero.ServerError - Thrown if the service cannot be initialized.
  - getUserDetails
```
public ExperimenterData getUserDetails(SecurityContext ctx,
                                       java.lang.String name)
                                throws DSOutOfServiceException
```
    Get the user details of a certain user
    
    Parameters:
    
    ctx - The SecurityContext
    
    name - The name of the user
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - isNetworkUp
```
public boolean isNetworkUp(boolean useCachedValue)
```
    Checks if the network interface is up.
    
    Parameters:
    
    useCachedValue - Uses the result of the last check instead of really performing the test if the last check is not older than 5 sec
    
    Returns:
    
    See above
  - getConnector
```
public omero.gateway.Connector getConnector(SecurityContext ctx)
                                     throws DSOutOfServiceException
```
    Get a connector for a certain SecurityContext
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - closeConnector
```
public void closeConnector(SecurityContext ctx)
```
    Close a connector for a certain SecurityContext
    
    Parameters:
    
    ctx - The SecurityContext
  - closeSessionOnExit
```
public void closeSessionOnExit(SecurityContext ctx,
                               boolean closeSession)
```
    By default the session is closed if it was initialized by the gateway. This method allows to override this. Has to be called after connect().
    
    Parameters:
    
    closeSession - Pass false to not close the session on disconnect
  - closeService
```
public void closeService(SecurityContext ctx,
                         omero.api.StatefulServiceInterfacePrx svc)
```
    Close a service
    
    Parameters:
    
    ctx - The SecurityContext
    
    svc - The service to close
  - createPixelsStore
```
public omero.api.RawPixelsStorePrx createPixelsStore(SecurityContext ctx)
                                              throws DSOutOfServiceException
```
    Create a RawPixelsStorePrx
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - createThumbnailStore
```
public omero.api.ThumbnailStorePrx createThumbnailStore(SecurityContext ctx)
                                                 throws DSOutOfServiceException
```
    Create a ThumbnailStorePrx
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - isAlive
```
public boolean isAlive(SecurityContext ctx)
                throws DSOutOfServiceException
```
    Checks if there is a Connector for a particular SecurityContext
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    true if there is one, false otherwise
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - getConnector
```
public omero.gateway.Connector getConnector(SecurityContext ctx,
                                            boolean recreate,
                                            boolean permitNull)
                                     throws DSOutOfServiceException
```
    Returns the connector corresponding to the passed context.
    
    Parameters:
    
    ctx - The security context.
    
    recreate - whether or not to allow the recreation of the Connector. A DSOutOfServiceException is thrown if this is set to false and no Connector is available.
    
    permitNull - whether or not to throw a DSOutOfServiceException if no Connector is available by the end of the execution.
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - shutDownDerivedConnector
```
public void shutDownDerivedConnector(SecurityContext ctx)
                              throws DSOutOfServiceException
```
    Shuts down the connectors created while creating/importing data for other users.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Throws:
    
    DSOutOfServiceException - If the connection is broken, or not logged in
  - getRenderingEngines
```
public java.util.Map<SecurityContext,java.util.Set<java.lang.Long>> getRenderingEngines()
```
    Returns the rendering engines to re-activate.
    
    Returns:
    
    See above.
  - shutdownRenderingEngine
```
public void shutdownRenderingEngine(SecurityContext ctx,
                                    long pixelsID)
```
    Shuts down the rendering engine
    
    Parameters:
    
    ctx - The SecurityContext
    
    pixelsID - The pixels id
  - getTypesService
```
public omero.api.ITypesPrx getTypesService(SecurityContext ctx)
                                    throws DSOutOfServiceException
```
    Returns the ITypesPrx service.
    
    Parameters:
    
    ctx - The SecurityContext
    
    Returns:
    
    See above.
    
    Throws:
    
    DSOutOfServiceException - Thrown if the service cannot be initialized.
  - canCreate
```
public java.lang.Boolean canCreate(SecurityContext ctx)
                            throws DSOutOfServiceException
```
    Get the read-only status of the server. Warning: This is experimental API that is subject to change.
    
    Parameters:
    
    ctx - the SecurityContext to use for the query
    
    Returns:
    
    true if the server is wholly in read-write mode, false if the server is wholly in read-only mode, otherwise null
    
    Throws:
    
    DSOutOfServiceException - if the status query failed
  - close
```
public void close()
           throws java.lang.Exception
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception

Class Gateway

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_CONNECTOR_CREATED

PROP_CONNECTOR_CLOSED

PROP_SESSION_CREATED

PROP_SESSION_CLOSED

PROP_SESSION_DETACHED

PROP_FACILITY_CREATED

PROP_FACILITY_CLOSED

PROP_IMPORTSTORE_CREATED

PROP_IMPORTSTORE_CLOSED

PROP_RENDERINGENGINE_CREATED

PROP_RENDERINGENGINE_CLOSED

PROP_STATEFUL_SERVICE_CREATED

PROP_STATEFUL_SERVICE_CLOSED

PROP_STATELESS_SERVICE_CREATED

Constructor Detail

Gateway

Gateway

Gateway

Gateway

Method Detail

submit

connect

getLoggedInUser

disconnect

joinSession

isConnected

getSessionId

getServerVersion

getFacility

addPropertyChangeListener

removePropertyChangeListener

getPropertyChangeListeners

submit

submit

closeImport

runScript

getLogger

getCacheService

getSharedResources

getRenderingSettingsService

getRepositoryService

getScriptService

getPojosService

getQueryService

getUpdateService

getUpdateService

getMetadataService

getROIService

getConfigService

getThumbnailService

getExporterService

getRawFileService

getPixelsStore

getPixelsService

getSearchService

getProjectionService

getAdminService

getAdminService

getImportStore

getImportStore

getRenderingService

getUserDetails

isNetworkUp

getConnector

closeConnector

closeSessionOnExit

closeService

createPixelsStore

createThumbnailStore

isAlive

getConnector

shutDownDerivedConnector

getRenderingEngines

shutdownRenderingEngine