Package omero :: Package gateway :: Class _BlitzGateway
[hide private]
[frames] | no frames]

Class _BlitzGateway

source code


ICE_CONFIG - Defines the path to the Ice configuration

Instance Methods [hide private]
 
__init__(self, username=None, passwd=None, client_obj=None, group=None, clone=False, try_super=False, host=None, port=None, extra_config=[])
TODO: Constructor
source code
 
getProperty(self, k) source code
 
clone(self) source code
 
setIdentity(self, username, passwd, _internal=False)
TODO: description
source code
 
keepAlive(self)
Keeps service alive.
source code
 
seppuku(self, softclose=False)
Terminates connection.
source code
 
__del__(self) source code
 
_createProxies(self)
Creates proxies to the server services.
source code
 
_createSession(self, skipSUuid=False)
Creates a new session for the principal given in the constructor.
source code
 
_closeSession(self)
Close session.
source code
 
_resetOmeroClient(self)
Resets omero.client object.
source code
 
connect(self, sUuid=None)
Creates or retrieves connection for the given sessionUuid.
source code
 
getLastError(self)
Returns error if thrown by _BlitzGateway.connect connect.
source code
 
isConnected(self)
Returns last status of connection.
source code
 
getEventContext(self)
Returns omero_System_ice.EventContext.
source code
 
getUser(self)
Returns current omero_model_ExperimenterI.
source code
 
isAdmin(self)
Checks if a user has administration privileges.
source code
 
canWrite(self, obj)
Checks if a user has write privileges to the given object.
source code
 
setGroupForSession(self, group) source code
 
revertGroupForSession(self) source code
 
getAdminService(self)
Gets reference to the admin service from ProxyObjectWrapper.
source code
 
getQueryService(self)
Gets reference to the query service from ProxyObjectWrapper.
source code
 
getContainerService(self)
Gets reference to the container service from ProxyObjectWrapper.
source code
 
getPixelsService(self)
Gets reference to the pixels service from ProxyObjectWrapper.
source code
 
getMetadataService(self)
Gets reference to the metadata service from ProxyObjectWrapper.
source code
 
createRawFileStore(self)
Creates a new raw file store.
source code
 
getRepositoryInfoService(self)
Gets reference to the repository info service from ProxyObjectWrapper.
source code
 
getShareService(self)
Gets reference to the share service from ProxyObjectWrapper.
source code
 
getTimelineService(self)
Gets reference to the timeline service from ProxyObjectWrapper.
source code
 
getTypesService(self)
Gets reference to the types service from ProxyObjectWrapper.
source code
 
getConfigService(self)
Gets reference to the config service from ProxyObjectWrapper.
source code
 
createRenderingEngine(self)
Creates a new rendering engine.
source code
 
getRenderingSettingsService(self) source code
 
createRawPixelsStore(self)
Creates a new raw pixels store.
source code
 
createThumbnailStore(self)
Creates a new thumbnail store.
source code
 
createSearchService(self)
Creates a new search service.
source code
 
getUpdateService(self)
Gets reference to the update service from ProxyObjectWrapper.
source code
 
getDeleteService(self)
Gets reference to the delete service from ProxyObjectWrapper.
source code
 
getSessionService(self)
Gets reference to the session service from ProxyObjectWrapper.
source code
 
listProjects(self, only_owned=False)
List every Projects controlled by the security system.
source code
 
listExperimenters(self, start='')
Return a generator for all Experimenters whose omeName starts with 'start'.
source code
 
getExperimenter(self, eid)
Return an Experimenter for the given ID.
source code
 
lookupExperimenter(self, name)
Return an Experimenter for the given username.
source code
 
getProject(self, oid)
Return Project for the given ID.
source code
 
getDataset(self, oid)
Return Dataset for the given ID.
source code
 
getImage(self, oid)
Return Image for the given ID.
source code
 
listImages(self, ns, params=None)
TODO: description
source code
 
searchImages(self, text)
Fulltext search for images
source code
 
simpleSearch(self, text, types=None)
Fulltext search on Projects, Datasets and Images.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  ICE_CONFIG = None
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, username=None, passwd=None, client_obj=None, group=None, clone=False, try_super=False, host=None, port=None, extra_config=[])
(Constructor)

source code 

TODO: Constructor

Parameters:
  • username - User name. String
  • passwd - Password. String
  • client_obj - omero.client
  • group - admin group
  • clone - Boolean
  • try_super - Boolean
  • host - Omero server host. String
  • port - Omero server port. Integer
  • extra_config
Overrides: object.__init__

setIdentity(self, username, passwd, _internal=False)

source code 

TODO: description

Parameters:
  • username - User name. String
  • passwd - Password. String
  • _internal - Boolean

keepAlive(self)

source code 

Keeps service alive. Returns True if connected. If connection was lost, reconnecting.

Returns:
Boolean

seppuku(self, softclose=False)

source code 

Terminates connection. If softclose is False, the session is really terminate disregarding its connection refcount.

Parameters:
  • softclose - Boolean

connect(self, sUuid=None)

source code 

Creates or retrieves connection for the given sessionUuid. Returns True if connected.

Parameters:
  • sUuid - omero_model_SessionI
Returns:
Boolean

getLastError(self)

source code 

Returns error if thrown by _BlitzGateway.connect connect.

Returns:
String

isConnected(self)

source code 

Returns last status of connection.

Returns:
Boolean

getEventContext(self)

source code 

Returns omero_System_ice.EventContext. It containes:

   shareId, sessionId, sessionUuid, userId, userName, 
   groupId, groupName, isAdmin, isReadOnly, 
   eventId, eventType, eventType,
   memberOfGroups, leaderOfGroups
Returns:
omero.sys.EventContext

getUser(self)

source code 

Returns current omero_model_ExperimenterI.

Returns:
omero.model.ExperimenterI

isAdmin(self)

source code 

Checks if a user has administration privileges.

Returns:
Boolean

canWrite(self, obj)

source code 

Checks if a user has write privileges to the given object.

Parameters:
  • obj - Given object
Returns:
Boolean

getAdminService(self)

source code 

Gets reference to the admin service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getQueryService(self)

source code 

Gets reference to the query service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getContainerService(self)

source code 

Gets reference to the container service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getPixelsService(self)

source code 

Gets reference to the pixels service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getMetadataService(self)

source code 

Gets reference to the metadata service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

createRawFileStore(self)

source code 

Creates a new raw file store. This service is special in that it does not get cached inside BlitzGateway so every call to this function returns a new object, avoiding unexpected inherited states.

Returns:
omero.gateway.ProxyObjectWrapper

getRepositoryInfoService(self)

source code 

Gets reference to the repository info service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getShareService(self)

source code 

Gets reference to the share service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getTimelineService(self)

source code 

Gets reference to the timeline service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getTypesService(self)

source code 

Gets reference to the types service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getConfigService(self)

source code 

Gets reference to the config service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

createRenderingEngine(self)

source code 

Creates a new rendering engine. This service is special in that it does not get cached inside BlitzGateway so every call to this function returns a new object, avoiding unexpected inherited states.

Returns:
omero.gateway.ProxyObjectWrapper

createRawPixelsStore(self)

source code 

Creates a new raw pixels store. This service is special in that it does not get cached inside BlitzGateway so every call to this function returns a new object, avoiding unexpected inherited states.

Returns:
omero.gateway.ProxyObjectWrapper

createThumbnailStore(self)

source code 

Creates a new thumbnail store. This service is special in that it does not get cached inside BlitzGateway so every call to this function returns a new object, avoiding unexpected inherited states.

Returns:
omero.gateway.ProxyObjectWrapper

createSearchService(self)

source code 

Creates a new search service. This service is special in that it does not get cached inside BlitzGateway so every call to this function returns a new object, avoiding unexpected inherited states.

Returns:
omero.gateway.ProxyObjectWrapper

getUpdateService(self)

source code 

Gets reference to the update service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getDeleteService(self)

source code 

Gets reference to the delete service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

getSessionService(self)

source code 

Gets reference to the session service from ProxyObjectWrapper.

Returns:
omero.gateway.ProxyObjectWrapper

listProjects(self, only_owned=False)

source code 

List every Projects controlled by the security system.

Parameters:
  • only_owned - Only owned by the logged user. Boolean.
Returns:
Generator yielding _ProjectWrapper

listExperimenters(self, start='')

source code 

Return a generator for all Experimenters whose omeName starts with 'start'. The generated values follow the alphabetic order on omeName.

Parameters:
  • start - Only if omero_model_ExperimenterI.omeName starts with. String.
Returns:
Generator yielding _ExperimenterWrapper

getExperimenter(self, eid)

source code 

Return an Experimenter for the given ID.

Parameters:
  • eid - User ID.
Returns:
_ExperimenterWrapper or None

lookupExperimenter(self, name)

source code 

Return an Experimenter for the given username.

Parameters:
  • name - Username. String
Returns:
_ExperimenterWrapper or None

getProject(self, oid)

source code 

Return Project for the given ID.

Parameters:
  • oid - Project ID.
Returns:
_ProjectWrapper or None

getDataset(self, oid)

source code 

Return Dataset for the given ID.

Parameters:
  • oid - Dataset ID.
Returns:
_DatasetWrapper or None

getImage(self, oid)

source code 

Return Image for the given ID.

Parameters:
  • oid - Image ID.
Returns:
_ImageWrapper or None

listImages(self, ns, params=None)

source code 

TODO: description

Returns:
Generator yielding _ImageWrapper

simpleSearch(self, text, types=None)

source code 

Fulltext search on Projects, Datasets and Images. TODO: search other object types? TODO: batch support.