ServiceFactoryI (omero-blitz 5.5.7 API)

java.lang.Object
- omero.cmd.SessionI
- - ome.services.blitz.impl.ServiceFactoryI

All Implemented Interfaces:

Glacier2._SessionOperations, _ServiceFactoryOperations
```
public final class ServiceFactoryI
extends SessionI
implements _ServiceFactoryOperations
```
Responsible for maintaining all servants for a single session. In general, try to reduce access to the Current and Util objects.

Since:

3.0-Beta2

Field Summary
- Fields inherited from class omero.cmd.SessionI
  adapter, callback, clientId, context, control, doClose, executor, holder, principal, reusedSession, sessionManager, token

Constructor Summary

Constructors
Constructor and Description
`ServiceFactoryI(boolean reusedSession, Ice.Current current, ServantHolder holder, Glacier2.SessionControlPrx control, ome.system.OmeroContext context, ome.services.sessions.SessionManager manager, ome.services.util.Executor executor, ome.system.Principal p, java.util.List<ome.logic.HardWiredInterceptor> interceptors, TopicManager topicManager, Registry registry, java.lang.String token)`
`ServiceFactoryI(Ice.Current current, ServantHolder holder, Glacier2.SessionControlPrx control, ome.system.OmeroContext context, ome.services.sessions.SessionManager manager, ome.services.util.Executor executor, ome.system.Principal p, java.util.List<ome.logic.HardWiredInterceptor> interceptors, TopicManager topicManager, Registry registry)`

Method Summary

All Methods Instance Methods Concrete 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.
`StatefulServiceInterfacePrx`	`createByName(java.lang.String name, Ice.Current current, boolean allowGuest)`
`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 blankname, Ice.Current dontUse)` Allows looking up any stateless service by name.
`ServiceInterfacePrx`	`getByName(java.lang.String blankname, Ice.Current dontUse, boolean allowGuest)`
`IConfigPrx`	`getConfigService(Ice.Current current)`
`IContainerPrx`	`getContainerService(Ice.Current current)`
`ome.system.EventContext`	`getEventContext()` Doesn't take current into account
`ome.system.EventContext`	`getEventContext(Ice.Current current)` Takes current into account
`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.
`java.lang.Object`	`getServant(Ice.Identity id)`
`ISessionPrx`	`getSessionService(Ice.Current current)`
`ISharePrx`	`getShareService(Ice.Current current)`
`java.lang.String`	`getStatefulServiceCount()` NB: Much of the logic here is similar to `SessionI.doClose` and should be pushed down.
`Ice.TieBase`	`getTie(Ice.Identity id)`
`ITimelinePrx`	`getTimelineService(Ice.Current current)`
`ITypesPrx`	`getTypesService(Ice.Current current)`
`IUpdatePrx`	`getUpdateService(Ice.Current current)`
`protected ServerError`	`handleException(java.lang.Throwable t)`
`protected void`	`internalServantConfig(java.lang.Object obj)`
`boolean`	`keepAlive(ServiceInterfacePrx proxy, Ice.Current __current)` Currently ignoring the individual proxies
`long`	`keepAllAlive(ServiceInterfacePrx[] proxies, Ice.Current __current)` Requests that the given services be marked as alive.
`ServiceFactoryPrx`	`proxy()`
`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 class omero.cmd.SessionI
allow, callContextWrapper, cleanServants, cleanServants, cleanupSelf, clientId, configureServant, createServantDelegate, destroy, doDestroy, getAdapter, getExecutor, getIdentity, getPrincipal, handleCallbackException, newCurrent, newCurrent, registerServant, registerServant, sessionId, sessionId, submit_async, submit_async, toString, unregisterServant, unregisterServant

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

Methods inherited from interface omero.cmd._SessionOperations
submit_async

Methods inherited from interface Glacier2._SessionOperations
destroy

- Constructor Detail
  - ServiceFactoryI
```
public ServiceFactoryI(Ice.Current current,
                       ServantHolder holder,
                       Glacier2.SessionControlPrx control,
                       ome.system.OmeroContext context,
                       ome.services.sessions.SessionManager manager,
                       ome.services.util.Executor executor,
                       ome.system.Principal p,
                       java.util.List<ome.logic.HardWiredInterceptor> interceptors,
                       TopicManager topicManager,
                       Registry registry)
                throws ApiUsageException
```
    Throws:
    
    ApiUsageException
  - ServiceFactoryI
```
public ServiceFactoryI(boolean reusedSession,
                       Ice.Current current,
                       ServantHolder holder,
                       Glacier2.SessionControlPrx control,
                       ome.system.OmeroContext context,
                       ome.services.sessions.SessionManager manager,
                       ome.services.util.Executor executor,
                       ome.system.Principal p,
                       java.util.List<ome.logic.HardWiredInterceptor> interceptors,
                       TopicManager topicManager,
                       Registry registry,
                       java.lang.String token)
                throws ApiUsageException
```
    Throws:
    
    ApiUsageException
- Method Detail
  - proxy
```
public ServiceFactoryPrx proxy()
```
  - getSecurityContexts
```
public java.util.List<IObject> getSecurityContexts(Ice.Current __current)
                                            throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    Provides a list of all valid security contexts for this session. Each of the returned IObject instances can be passed to setSecurityContext.
    
    Specified by:
    
    getSecurityContexts in interface _ServiceFactoryOperations
    
    Parameters:
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setSecurityContext
```
public IObject setSecurityContext(IObject obj,
                                  Ice.Current __current)
                           throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    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])
    Specified by:
    
    setSecurityContext in interface _ServiceFactoryOperations
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setSecurityPassword
```
public void setSecurityPassword(java.lang.String password,
                                Ice.Current __current)
                         throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    Re-validates the password for the current session. This prevents See methods that mention "HasPassword".
    
    Specified by:
    
    setSecurityPassword in interface _ServiceFactoryOperations
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - handleException
```
protected ServerError handleException(java.lang.Throwable t)
```
  - getAdminService
```
public IAdminPrx getAdminService(Ice.Current current)
                          throws ServerError
```
    Specified by:
    
    getAdminService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getConfigService
```
public IConfigPrx getConfigService(Ice.Current current)
                            throws ServerError
```
    Specified by:
    
    getConfigService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getLdapService
```
public ILdapPrx getLdapService(Ice.Current current)
                        throws ServerError
```
    Specified by:
    
    getLdapService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getPixelsService
```
public IPixelsPrx getPixelsService(Ice.Current current)
                            throws ServerError
```
    Specified by:
    
    getPixelsService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getContainerService
```
public IContainerPrx getContainerService(Ice.Current current)
                                  throws ServerError
```
    Specified by:
    
    getContainerService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getProjectionService
```
public IProjectionPrx getProjectionService(Ice.Current current)
                                    throws ServerError
```
    Specified by:
    
    getProjectionService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getQueryService
```
public IQueryPrx getQueryService(Ice.Current current)
                          throws ServerError
```
    Specified by:
    
    getQueryService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getRoiService
```
public IRoiPrx getRoiService(Ice.Current current)
                      throws ServerError
```
    Specified by:
    
    getRoiService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getScriptService
```
public IScriptPrx getScriptService(Ice.Current current)
                            throws ServerError
```
    Specified by:
    
    getScriptService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getSessionService
```
public ISessionPrx getSessionService(Ice.Current current)
                              throws ServerError
```
    Specified by:
    
    getSessionService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getShareService
```
public ISharePrx getShareService(Ice.Current current)
                          throws ServerError
```
    Specified by:
    
    getShareService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getTimelineService
```
public ITimelinePrx getTimelineService(Ice.Current current)
                                throws ServerError
```
    Specified by:
    
    getTimelineService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getTypesService
```
public ITypesPrx getTypesService(Ice.Current current)
                          throws ServerError
```
    Specified by:
    
    getTypesService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getUpdateService
```
public IUpdatePrx getUpdateService(Ice.Current current)
                            throws ServerError
```
    Specified by:
    
    getUpdateService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getRenderingSettingsService
```
public IRenderingSettingsPrx getRenderingSettingsService(Ice.Current current)
                                                  throws ServerError
```
    Specified by:
    
    getRenderingSettingsService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getRepositoryInfoService
```
public IRepositoryInfoPrx getRepositoryInfoService(Ice.Current current)
                                            throws ServerError
```
    Specified by:
    
    getRepositoryInfoService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - getMetadataService
```
public IMetadataPrx getMetadataService(Ice.Current current)
                                throws ServerError
```
    Specified by:
    
    getMetadataService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createExporter
```
public ExporterPrx createExporter(Ice.Current current)
                           throws ServerError
```
    Specified by:
    
    createExporter in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createJobHandle
```
public JobHandlePrx createJobHandle(Ice.Current current)
                             throws ServerError
```
    Specified by:
    
    createJobHandle in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createRenderingEngine
```
public RenderingEnginePrx createRenderingEngine(Ice.Current current)
                                         throws ServerError
```
    Specified by:
    
    createRenderingEngine in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createRawFileStore
```
public RawFileStorePrx createRawFileStore(Ice.Current current)
                                   throws ServerError
```
    Specified by:
    
    createRawFileStore in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createRawPixelsStore
```
public RawPixelsStorePrx createRawPixelsStore(Ice.Current current)
                                       throws ServerError
```
    Specified by:
    
    createRawPixelsStore in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createSearchService
```
public SearchPrx createSearchService(Ice.Current current)
                              throws ServerError
```
    Specified by:
    
    createSearchService in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - createThumbnailStore
```
public ThumbnailStorePrx createThumbnailStore(Ice.Current current)
                                       throws ServerError
```
    Specified by:
    
    createThumbnailStore in interface _ServiceFactoryOperations
    
    Throws:
    
    ServerError
  - sharedResources
```
public SharedResourcesPrx sharedResources(Ice.Current current)
                                   throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    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.
    Specified by:
    
    sharedResources in interface _ServiceFactoryOperations
    
    Parameters:
    
    current - The Current object for the invocation.
    
    Throws:
    
    ServerError
    
    See Also:
    
    SharedResources
  - getTie
```
public Ice.TieBase getTie(Ice.Identity id)
```
  - getServant
```
public java.lang.Object getServant(Ice.Identity id)
```
  - getByName
```
public ServiceInterfacePrx getByName(java.lang.String blankname,
                                     Ice.Current dontUse)
                              throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    getByName in interface _ServiceFactoryOperations
    
    dontUse - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - getByName
```
public ServiceInterfacePrx getByName(java.lang.String blankname,
                                     Ice.Current dontUse,
                                     boolean allowGuest)
                              throws ServerError
```
    Throws:
    
    ServerError
  - createByName
```
public StatefulServiceInterfacePrx createByName(java.lang.String name,
                                                Ice.Current current)
                                         throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    createByName in interface _ServiceFactoryOperations
    
    current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - createByName
```
public StatefulServiceInterfacePrx createByName(java.lang.String name,
                                                Ice.Current current,
                                                boolean allowGuest)
                                         throws ServerError
```
    Throws:
    
    ServerError
  - subscribe
```
public void subscribe(java.lang.String topicName,
                      Ice.ObjectPrx prx,
                      Ice.Current __current)
               throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    subscribe in interface _ServiceFactoryOperations
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - setCallback
```
public void setCallback(ClientCallbackPrx callback,
                        Ice.Current current)
                 throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    setCallback in interface _ServiceFactoryOperations
    
    current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - detachOnDestroy
```
public void detachOnDestroy(Ice.Current current)
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    detachOnDestroy in interface _ServiceFactoryOperations
    
    Parameters:
    
    current - The Current object for the invocation.
  - closeOnDestroy
```
public void closeOnDestroy(Ice.Current current)
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    closeOnDestroy in interface _ServiceFactoryOperations
    
    Parameters:
    
    current - The Current object for the invocation.
  - getStatefulServiceCount
```
public java.lang.String getStatefulServiceCount()
```
    NB: Much of the logic here is similar to SessionI.doClose and should be pushed down.
  - activeServices
```
public java.util.List<java.lang.String> activeServices(Ice.Current __current)
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    activeServices in interface _ServiceFactoryOperations
    
    Parameters:
    
    __current - The Current object for the invocation.
  - getEventContext
```
public ome.system.EventContext getEventContext()
```
    Doesn't take current into account
  - getEventContext
```
public ome.system.EventContext getEventContext(Ice.Current current)
```
    Takes current into account
  - keepAllAlive
```
public long keepAllAlive(ServiceInterfacePrx[] proxies,
                         Ice.Current __current)
                  throws ServerError
```
    Description copied from interface: _ServiceFactoryOperations
    
    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.
    
    Specified by:
    
    keepAllAlive in interface _ServiceFactoryOperations
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - keepAlive
```
public boolean keepAlive(ServiceInterfacePrx proxy,
                         Ice.Current __current)
                  throws ServerError
```
    Currently ignoring the individual proxies
    
    Specified by:
    
    keepAlive in interface _ServiceFactoryOperations
    
    __current - The Current object for the invocation.
    
    Throws:
    
    ServerError
  - internalServantConfig
```
protected void internalServantConfig(java.lang.Object obj)
                              throws ServerError
```
    Overrides:
    
    internalServantConfig in class SessionI
    
    Throws:
    
    ServerError

Class ServiceFactoryI

Field Summary

Fields inherited from class omero.cmd.SessionI

Constructor Summary

Method Summary

Methods inherited from class omero.cmd.SessionI

Methods inherited from class java.lang.Object

Methods inherited from interface omero.cmd._SessionOperations

Methods inherited from interface Glacier2._SessionOperations

Constructor Detail

ServiceFactoryI

ServiceFactoryI

Method Detail

proxy

getSecurityContexts

setSecurityContext

Example usage in Python:

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

setSecurityPassword

handleException

getAdminService

getConfigService

getLdapService

getPixelsService

getContainerService

getProjectionService

getQueryService

getRoiService

getScriptService

getSessionService

getShareService

getTimelineService

getTypesService

getUpdateService

getRenderingSettingsService

getRepositoryInfoService

getMetadataService

createExporter

createJobHandle

createRenderingEngine

createRawFileStore

createRawPixelsStore

createSearchService

createThumbnailStore

sharedResources

getTie

getServant

getByName

getByName

createByName

createByName

subscribe

setCallback

detachOnDestroy

closeOnDestroy

getStatefulServiceCount

activeServices

getEventContext

getEventContext

keepAllAlive

keepAlive

internalServantConfig