omero.api

Class _ServiceFactoryTie

java.lang.Object

Ice.ObjectImpl

omero.api._ServiceFactoryDisp

omero.api._ServiceFactoryTie

All Implemented Interfaces:

Glacier2._SessionOperations, Glacier2._SessionOperationsNC, Glacier2.Session, Ice.Object, Ice.TieBase, java.io.Serializable, java.lang.Cloneable, _ServiceFactoryOperations, _ServiceFactoryOperationsNC, ServiceFactory

public class _ServiceFactoryTie
extends _ServiceFactoryDisp
implements Ice.TieBase

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class omero.api._ServiceFactoryDisp

__ids

Fields inherited from interface omero.api.ServiceFactory

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_ServiceFactoryTie(_ServiceFactoryOperations delegate)
_ServiceFactoryTie()

Method Summary

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	destroy(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.
boolean	equals(java.lang.Object rhs)
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)
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
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	submit_async(AMD_Session_submit __cb, Request req, Ice.Current __current)
void	subscribe(java.lang.String topicName, Ice.ObjectPrx prx, Ice.Current __current) Subscribe to a given topic.

Methods inherited from class omero.api._ServiceFactoryDisp

___activeServices, ___closeOnDestroy, ___createByName, ___createExporter, ___createJobHandle, ___createRawFileStore, ___createRawPixelsStore, ___createRenderingEngine, ___createSearchService, ___createThumbnailStore, ___detachOnDestroy, ___getAdminService, ___getByName, ___getConfigService, ___getContainerService, ___getLdapService, ___getMetadataService, ___getPixelsService, ___getProjectionService, ___getQueryService, ___getRenderingSettingsService, ___getRepositoryInfoService, ___getRoiService, ___getScriptService, ___getSecurityContexts, ___getSessionService, ___getShareService, ___getTimelineService, ___getTypesService, ___getUpdateService, ___keepAlive, ___keepAllAlive, ___setCallback, ___setSecurityContext, ___setSecurityPassword, ___sharedResources, ___subscribe, __dispatch, __readImpl, __writeImpl, activeServices, closeOnDestroy, createByName, createExporter, createJobHandle, createRawFileStore, createRawPixelsStore, createRenderingEngine, createSearchService, createThumbnailStore, destroy, detachOnDestroy, getAdminService, getByName, getConfigService, getContainerService, getLdapService, getMetadataService, getPixelsService, getProjectionService, getQueryService, getRenderingSettingsService, getRepositoryInfoService, getRoiService, getScriptService, getSecurityContexts, getSessionService, getShareService, getTimelineService, getTypesService, getUpdateService, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, keepAlive, keepAllAlive, setCallback, setSecurityContext, setSecurityPassword, sharedResources, submit_async, subscribe

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Ice.Object

__read, __read, __write, __write, clone, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_ServiceFactoryTie

public _ServiceFactoryTie()

_ServiceFactoryTie

public _ServiceFactoryTie(_ServiceFactoryOperations delegate)

Method Detail

ice_delegate

public java.lang.Object ice_delegate()

Specified by:

ice_delegate in interface Ice.TieBase

ice_delegate

public void ice_delegate(java.lang.Object delegate)

Specified by:

ice_delegate in interface Ice.TieBase

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

destroy

public void destroy(Ice.Current __current)

Specified by:

destroy in interface Glacier2._SessionOperations

activeServices

public java.util.List<java.lang.String> activeServices(Ice.Current __current)
                                                throws ServerError

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.

Throws:

ServerError

closeOnDestroy

public void closeOnDestroy(Ice.Current __current)
                    throws ServerError

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.

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

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

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

createRenderingEngine

public RenderingEnginePrx createRenderingEngine(Ice.Current __current)
                                         throws ServerError

Specified by:

createRenderingEngine 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

detachOnDestroy

public void detachOnDestroy(Ice.Current __current)
                     throws ServerError

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.

Throws:

ServerError

getAdminService

public IAdminPrx getAdminService(Ice.Current __current)
                          throws ServerError

Specified by:

getAdminService in interface _ServiceFactoryOperations

Throws:

ServerError

getByName

public ServiceInterfacePrx getByName(java.lang.String name,
                                     Ice.Current __current)
                              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

__current - The Current object for the invocation.

Throws:

ServerError

getConfigService

public IConfigPrx getConfigService(Ice.Current __current)
                            throws ServerError

Specified by:

getConfigService in interface _ServiceFactoryOperations

Throws:

ServerError

getContainerService

public IContainerPrx getContainerService(Ice.Current __current)
                                  throws ServerError

Specified by:

getContainerService in interface _ServiceFactoryOperations

Throws:

ServerError

getLdapService

public ILdapPrx getLdapService(Ice.Current __current)
                        throws ServerError

Specified by:

getLdapService in interface _ServiceFactoryOperations

Throws:

ServerError

getMetadataService

public IMetadataPrx getMetadataService(Ice.Current __current)
                                throws ServerError

Specified by:

getMetadataService in interface _ServiceFactoryOperations

Throws:

ServerError

getPixelsService

public IPixelsPrx getPixelsService(Ice.Current __current)
                            throws ServerError

Specified by:

getPixelsService 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

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

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

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

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

keepAlive

public boolean keepAlive(ServiceInterfacePrx proxy,
                         Ice.Current __current)
                  throws ServerError

Description copied from interface: _ServiceFactoryOperations

Returns true if the given service is alive. Except for fatal server or session errors, this method should never throw an exception.

Specified by:

keepAlive in interface _ServiceFactoryOperations

__current - The Current object for the invocation.

Throws:

ServerError

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

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

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

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

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

submit_async

public void submit_async(AMD_Session_submit __cb,
                         Request req,
                         Ice.Current __current)