_ServiceFactoryOperations (omero-blitz 5.5.12 API)

All Superinterfaces:

Glacier2._SessionOperations

All Known Subinterfaces:

ServiceFactory

All Known Implementing Classes:

_ServiceFactoryDisp, _ServiceFactoryTie, ServiceFactoryI
```
public interface _ServiceFactoryOperations
extends _SessionOperations
```
Starting point for all OMERO.blitz interaction.
A ServiceFactory once acquired can be used to create any number of service proxies to the server. Most services implement ServiceInterface or its subinterface StatefulServiceInterface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.List<java.lang.String>`	`activeServices(Ice.Current __current)` Returns a list of string ids for currently active services.
`void`	`closeOnDestroy(Ice.Current __current)` Marks the session for closure rather than detachment, which will be triggered by the destruction of the Glacier2 connection via router.destroySession() Closing the session rather the detaching is more secure, since all resources are removed from the server and can safely be set once it is clear that a client is finished with those resources.
`StatefulServiceInterfacePrx`	`createByName(java.lang.String name, Ice.Current __current)` Allows looking up any stateful service by name.
`ExporterPrx`	`createExporter(Ice.Current __current)`
`JobHandlePrx`	`createJobHandle(Ice.Current __current)`
`RawFileStorePrx`	`createRawFileStore(Ice.Current __current)`
`RawPixelsStorePrx`	`createRawPixelsStore(Ice.Current __current)`
`RenderingEnginePrx`	`createRenderingEngine(Ice.Current __current)`
`SearchPrx`	`createSearchService(Ice.Current __current)`
`ThumbnailStorePrx`	`createThumbnailStore(Ice.Current __current)`
`void`	`detachOnDestroy(Ice.Current __current)` Marks the session for detachment rather than closure, which will be triggered by the destruction of the Glacier2 connection via router.destroySession() This is the default and allows a lost session to be reconnected, at a slight security cost since the session will persist longer and can be used by others if the UUID is intercepted.
`IAdminPrx`	`getAdminService(Ice.Current __current)`
`ServiceInterfacePrx`	`getByName(java.lang.String name, Ice.Current __current)` Allows looking up any stateless service by name.
`IConfigPrx`	`getConfigService(Ice.Current __current)`
`IContainerPrx`	`getContainerService(Ice.Current __current)`
`ILdapPrx`	`getLdapService(Ice.Current __current)`
`IMetadataPrx`	`getMetadataService(Ice.Current __current)`
`IPixelsPrx`	`getPixelsService(Ice.Current __current)`
`IProjectionPrx`	`getProjectionService(Ice.Current __current)`
`IQueryPrx`	`getQueryService(Ice.Current __current)`
`IRenderingSettingsPrx`	`getRenderingSettingsService(Ice.Current __current)`
`IRepositoryInfoPrx`	`getRepositoryInfoService(Ice.Current __current)`
`IRoiPrx`	`getRoiService(Ice.Current __current)`
`IScriptPrx`	`getScriptService(Ice.Current __current)`
`java.util.List<IObject>`	`getSecurityContexts(Ice.Current __current)` Provides a list of all valid security contexts for this session.
`ISessionPrx`	`getSessionService(Ice.Current __current)`
`ISharePrx`	`getShareService(Ice.Current __current)`
`ITimelinePrx`	`getTimelineService(Ice.Current __current)`
`ITypesPrx`	`getTypesService(Ice.Current __current)`
`IUpdatePrx`	`getUpdateService(Ice.Current __current)`
`boolean`	`keepAlive(ServiceInterfacePrx proxy, Ice.Current __current)` Returns true if the given service is alive.
`long`	`keepAllAlive(ServiceInterfacePrx[] proxies, Ice.Current __current)` Requests that the given services be marked as alive.
`void`	`setCallback(ClientCallbackPrx callback, Ice.Current __current)` Sets the single callback used by the ServiceFactory to communicate with the client application.
`IObject`	`setSecurityContext(IObject obj, Ice.Current __current)` Changes the security context for the current session.
`void`	`setSecurityPassword(java.lang.String password, Ice.Current __current)` Re-validates the password for the current session.
`SharedResourcesPrx`	`sharedResources(Ice.Current __current)` Returns a reference to a back-end manager.
`void`	`subscribe(java.lang.String topicName, Ice.ObjectPrx prx, Ice.Current __current)` Subscribe to a given topic.

Methods inherited from interface omero.cmd._SessionOperations
submit_async

Methods inherited from interface Glacier2._SessionOperations
destroy

- Method Detail
  - getSecurityContexts
```
java.util.List<IObject> getSecurityContexts(Ice.Current __current)
                                     throws ServerError
```
    Provides a list of all valid security contexts for this session. Each of the returned IObject instances can be passed to setSecurityContext.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setSecurityContext
```
IObject setSecurityContext(IObject obj,
                           Ice.Current __current)
                    throws ServerError
```
    Changes the security context for the current session.
    A security context limits the set of objects which will be returned by all queries and restricts what updates can be made.
    
    Current valid values for security context:
    - ExperimenterGroup - logs into a specific group
    - Share - uses IShare to activate a share
    Passing an unloaded version of either object type will change the way the current session operates. Note: only objects which are returned by the getSecurityContext method are considered valid. Any other instance will cause an exception to be thrown.
    
    Example usage in Python:
    sf = client.createSession() objs = sf.getSecurityContexts() old = sf.setSecurityContext(objs\[-1])
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setSecurityPassword
```
void setSecurityPassword(java.lang.String password,
                         Ice.Current __current)
                  throws ServerError
```
    Re-validates the password for the current session. This prevents See methods that mention "HasPassword".
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - getAdminService
```
IAdminPrx getAdminService(Ice.Current __current)
                   throws ServerError
```
    Throws:
    
    ServerError
  - getConfigService
```
IConfigPrx getConfigService(Ice.Current __current)
                     throws ServerError
```
    Throws:
    
    ServerError
  - getContainerService
```
IContainerPrx getContainerService(Ice.Current __current)
                           throws ServerError
```
    Throws:
    
    ServerError
  - getLdapService
```
ILdapPrx getLdapService(Ice.Current __current)
                 throws ServerError
```
    Throws:
    
    ServerError
  - getPixelsService
```
IPixelsPrx getPixelsService(Ice.Current __current)
                     throws ServerError
```
    Throws:
    
    ServerError
  - getProjectionService
```
IProjectionPrx getProjectionService(Ice.Current __current)
                             throws ServerError
```
    Throws:
    
    ServerError
  - getQueryService
```
IQueryPrx getQueryService(Ice.Current __current)
                   throws ServerError
```
    Throws:
    
    ServerError
  - getRenderingSettingsService
```
IRenderingSettingsPrx getRenderingSettingsService(Ice.Current __current)
                                           throws ServerError
```
    Throws:
    
    ServerError
  - getRepositoryInfoService
```
IRepositoryInfoPrx getRepositoryInfoService(Ice.Current __current)
                                     throws ServerError
```
    Throws:
    
    ServerError
  - getRoiService
```
IRoiPrx getRoiService(Ice.Current __current)
               throws ServerError
```
    Throws:
    
    ServerError
  - getScriptService
```
IScriptPrx getScriptService(Ice.Current __current)
                     throws ServerError
```
    Throws:
    
    ServerError
  - getSessionService
```
ISessionPrx getSessionService(Ice.Current __current)
                       throws ServerError
```
    Throws:
    
    ServerError
  - getShareService
```
ISharePrx getShareService(Ice.Current __current)
                   throws ServerError
```
    Throws:
    
    ServerError
  - getTimelineService
```
ITimelinePrx getTimelineService(Ice.Current __current)
                         throws ServerError
```
    Throws:
    
    ServerError
  - getTypesService
```
ITypesPrx getTypesService(Ice.Current __current)
                   throws ServerError
```
    Throws:
    
    ServerError
  - getUpdateService
```
IUpdatePrx getUpdateService(Ice.Current __current)
                     throws ServerError
```
    Throws:
    
    ServerError
  - getMetadataService
```
IMetadataPrx getMetadataService(Ice.Current __current)
                         throws ServerError
```
    Throws:
    
    ServerError
  - createExporter
```
ExporterPrx createExporter(Ice.Current __current)
                    throws ServerError
```
    Throws:
    
    ServerError
  - createJobHandle
```
JobHandlePrx createJobHandle(Ice.Current __current)
                      throws ServerError
```
    Throws:
    
    ServerError
  - createRawFileStore
```
RawFileStorePrx createRawFileStore(Ice.Current __current)
                            throws ServerError
```
    Throws:
    
    ServerError
  - createRawPixelsStore
```
RawPixelsStorePrx createRawPixelsStore(Ice.Current __current)
                                throws ServerError
```
    Throws:
    
    ServerError
  - createRenderingEngine
```
RenderingEnginePrx createRenderingEngine(Ice.Current __current)
                                  throws ServerError
```
    Throws:
    
    ServerError
  - createSearchService
```
SearchPrx createSearchService(Ice.Current __current)
                       throws ServerError
```
    Throws:
    
    ServerError
  - createThumbnailStore
```
ThumbnailStorePrx createThumbnailStore(Ice.Current __current)
                                throws ServerError
```
    Throws:
    
    ServerError
  - sharedResources
```
SharedResourcesPrx sharedResources(Ice.Current __current)
                            throws ServerError
```
    Returns a reference to a back-end manager. The SharedResources service provides look ups for various facilities offered by OMERO:
    - OMERO.scripts
    - OMERO.tables
    These facilities may or may not be available on first request.
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
    
    See Also:
    
    SharedResources
  - getByName
```
ServiceInterfacePrx getByName(java.lang.String name,
                              Ice.Current __current)
                       throws ServerError
```
    Allows looking up any stateless service by name. See Constants.ice for examples of services. If a service has been added by third-parties, getByName can be used even though no concrete method is available.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - createByName
```
StatefulServiceInterfacePrx createByName(java.lang.String name,
                                         Ice.Current __current)
                                  throws ServerError
```
    Allows looking up any stateful service by name. See Constants.ice for examples of services. If a service has been added by third-parties, createByName can be used even though no concrete method is available.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - subscribe
```
void subscribe(java.lang.String topicName,
               Ice.ObjectPrx prx,
               Ice.Current __current)
        throws ServerError
```
    Subscribe to a given topic. The topic must exist and the user must have sufficient permissions for that topic. Further the proxy object must match the required type for the topic as encoded in the topic name.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setCallback
```
void setCallback(ClientCallbackPrx callback,
                 Ice.Current __current)
          throws ServerError
```
    Sets the single callback used by the ServiceFactory to communicate with the client application. A default callback is set by the omero::client object on session creation which should suffice for most usage. See the client object's documentation in each language mapping for ways to use the callback.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - closeOnDestroy
```
void closeOnDestroy(Ice.Current __current)
             throws ServerError
```
    Marks the session for closure rather than detachment, which will be triggered by the destruction of the Glacier2 connection via router.destroySession() Closing the session rather the detaching is more secure, since all resources are removed from the server and can safely be set once it is clear that a client is finished with those resources.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - detachOnDestroy
```
void detachOnDestroy(Ice.Current __current)
              throws ServerError
```
    Marks the session for detachment rather than closure, which will be triggered by the destruction of the Glacier2 connection via router.destroySession() This is the default and allows a lost session to be reconnected, at a slight security cost since the session will persist longer and can be used by others if the UUID is intercepted.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - activeServices
```
java.util.List<java.lang.String> activeServices(Ice.Current __current)
                                         throws ServerError
```
    Returns a list of string ids for currently active services. This will _not_ keep services alive, and in fact checks for all expired services and removes them.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - keepAllAlive
```
long keepAllAlive(ServiceInterfacePrx[] proxies,
                  Ice.Current __current)
           throws ServerError
```
    Requests that the given services be marked as alive. It is possible that one of the services has already timed out, in which case the returned long value will be non-zero. Specifically, the bit representing the 0-based index will be 1: if (retval & 1<<idx == 1<<idx) { // not alive } Except for fatal server or session errors, this method should never throw an exception.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - keepAlive
```
boolean keepAlive(ServiceInterfacePrx proxy,
                  Ice.Current __current)
           throws ServerError
```
    Returns true if the given service is alive. Except for fatal server or session errors, this method should never throw an exception.
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError

Interface _ServiceFactoryOperations

Method Summary

Methods inherited from interface omero.cmd._SessionOperations

Methods inherited from interface Glacier2._SessionOperations

Method Detail

getSecurityContexts

setSecurityContext

Example usage in Python:

sf = client.createSession() objs = sf.getSecurityContexts() old = sf.setSecurityContext(objs\[-1])

setSecurityPassword

getAdminService

getConfigService

getContainerService

getLdapService

getPixelsService

getProjectionService

getQueryService

getRenderingSettingsService

getRepositoryInfoService

getRoiService

getScriptService

getSessionService

getShareService

getTimelineService

getTypesService

getUpdateService

getMetadataService

createExporter

createJobHandle

createRawFileStore

createRawPixelsStore

createRenderingEngine

createSearchService

createThumbnailStore

sharedResources

getByName

createByName

subscribe

setCallback

closeOnDestroy

detachOnDestroy

activeServices

keepAllAlive

keepAlive