public interface _ISessionOperations extends _ServiceInterfaceOperations
Session
creation service for OMERO. Access to
all other services is dependent upon a properly created and still
active Session
.
The session uuid (omero.model.Session.getUuid
) can be
considered a capability token, or temporary single use password.
Simply by possessing it the client has access to all information
available to the Session
.
Note: Both the RMI ome.system.ServiceFactory
as well
as the Ice ServiceFactory
use
ISession
to acquire a
Session
. In the Ice case, Glacier2
contacts ISession
itself and returns a
ServiceFactory remote proxy. From both ServiceFactory
instances, it is possible but not necessary to access
ISession
.Modifier and Type | Method and Description |
---|---|
void |
closeSession_async(AMD_ISession_closeSession __cb,
Session sess,
Ice.Current __current)
Closes session and releases all resources.
|
void |
createSession_async(AMD_ISession_createSession __cb,
Principal p,
java.lang.String credentials,
Ice.Current __current)
Creates a new session and returns it to the user.
|
void |
createSessionWithTimeout_async(AMD_ISession_createSessionWithTimeout __cb,
Principal principal,
long timeToLiveMilliseconds,
Ice.Current __current)
Allows an admin to create a
Session for the give
Principal . |
void |
createSessionWithTimeouts_async(AMD_ISession_createSessionWithTimeouts __cb,
Principal principal,
long timeToLiveMilliseconds,
long timeToIdleMilliseconds,
Ice.Current __current)
Allows an admin to create a
Session for
the given Principal . |
void |
createUserSession_async(AMD_ISession_createUserSession __cb,
long timeToLiveMilliseconds,
long timeToIdleMilliseconds,
java.lang.String defaultGroup,
Ice.Current __current)
Allows a user to open up another session for him/herself with the given
defaults without needing to re-enter password.
|
void |
getInput_async(AMD_ISession_getInput __cb,
java.lang.String sess,
java.lang.String key,
Ice.Current __current)
Retrieves an entry from the given
Session input environment. |
void |
getInputKeys_async(AMD_ISession_getInputKeys __cb,
java.lang.String sess,
Ice.Current __current)
Retrieves all keys in the
Session input
environment. |
void |
getInputs_async(AMD_ISession_getInputs __cb,
java.lang.String sess,
Ice.Current __current)
Retrieves all inputs from the given
Session input environment. |
void |
getMyOpenAgentSessions_async(AMD_ISession_getMyOpenAgentSessions __cb,
java.lang.String agent,
Ice.Current __current)
Like
getMyOpenSessions but returns only those
sessions with the given agent string. |
void |
getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb,
Ice.Current __current)
Like
getMyOpenSessions but returns only those
sessions started by official OMERO clients. |
void |
getMyOpenSessions_async(AMD_ISession_getMyOpenSessions __cb,
Ice.Current __current)
Returns a list of open sessions for the current user.
|
void |
getOutput_async(AMD_ISession_getOutput __cb,
java.lang.String sess,
java.lang.String key,
Ice.Current __current)
Retrieves an entry from the
Session
output environment. |
void |
getOutputKeys_async(AMD_ISession_getOutputKeys __cb,
java.lang.String sess,
Ice.Current __current)
Retrieves all keys in the
Session
output environment. |
void |
getOutputs_async(AMD_ISession_getOutputs __cb,
java.lang.String sess,
Ice.Current __current)
Retrieves all outputs from the given
Session input environment. |
void |
getReferenceCount_async(AMD_ISession_getReferenceCount __cb,
java.lang.String sessionUuid,
Ice.Current __current)
Retrieves the current reference count for the given uuid.
|
void |
getSession_async(AMD_ISession_getSession __cb,
java.lang.String sessionUuid,
Ice.Current __current)
Retrieves the session associated with this uuid, updating
the last access time as well.
|
void |
setInput_async(AMD_ISession_setInput __cb,
java.lang.String sess,
java.lang.String key,
RType value,
Ice.Current __current)
Places an entry in the given
Session
input environment. |
void |
setOutput_async(AMD_ISession_setOutput __cb,
java.lang.String sess,
java.lang.String key,
RType value,
Ice.Current __current)
Places an entry in the given
Session
output environment. |
void createSession_async(AMD_ISession_createSession __cb, Principal p, java.lang.String credentials, Ice.Current __current) throws Glacier2.CannotCreateSessionException, ServerError
__cb
- The callback object for the operation.__current
- The Current object for the invocation.Glacier2.CannotCreateSessionException
ServerError
void createUserSession_async(AMD_ISession_createUserSession __cb, long timeToLiveMilliseconds, long timeToIdleMilliseconds, java.lang.String defaultGroup, Ice.Current __current) throws Glacier2.CannotCreateSessionException, ServerError
__cb
- The callback object for the operation.__current
- The Current object for the invocation.Glacier2.CannotCreateSessionException
ServerError
void createSessionWithTimeout_async(AMD_ISession_createSessionWithTimeout __cb, Principal principal, long timeToLiveMilliseconds, Ice.Current __current) throws Glacier2.CannotCreateSessionException, ServerError
Session
for the give
Principal
.__cb
- The callback object for the operation.principal
- Non-null Principal
with the
target user's nametimeToLiveMilliseconds
- The time that this Session
has until destruction. This is useful to
override the server default so that an initial
delay before the user is given the token will
not be construed as idle time. A value less than
1 will cause the default max timeToLive to be
used; but timeToIdle will be disabled.__current
- The Current object for the invocation.Glacier2.CannotCreateSessionException
ServerError
void createSessionWithTimeouts_async(AMD_ISession_createSessionWithTimeouts __cb, Principal principal, long timeToLiveMilliseconds, long timeToIdleMilliseconds, Ice.Current __current) throws Glacier2.CannotCreateSessionException, ServerError
Session
for
the given Principal
.__cb
- The callback object for the operation.principal
- Non-null Principal
with the
target user's nametimeToLiveMilliseconds
- The time that this Session
has until destruction. Setting the value to 0
will prevent destruction unless the session
remains idle.timeToIdleMilliseconds
- The time that this Session
can remain idle before being destroyed. Setting
the value to 0 will prevent idleness based
destruction.__current
- The Current object for the invocation.Glacier2.CannotCreateSessionException
ServerError
void getSession_async(AMD_ISession_getSession __cb, java.lang.String sessionUuid, Ice.Current __current) throws ServerError
RemovedSessionException
if not present, or
a SessionTimeoutException
if expired.
This method can be used as a Session
ping.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getReferenceCount_async(AMD_ISession_getReferenceCount __cb, java.lang.String sessionUuid, Ice.Current __current) throws ServerError
getSession
.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void closeSession_async(AMD_ISession_closeSession __cb, Session sess, Ice.Current __current) throws ServerError
__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getMyOpenSessions_async(AMD_ISession_getMyOpenSessions __cb, Ice.Current __current) throws ServerError
__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getMyOpenAgentSessions_async(AMD_ISession_getMyOpenAgentSessions __cb, java.lang.String agent, Ice.Current __current) throws ServerError
getMyOpenSessions
but returns only those
sessions with the given agent string.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb, Ice.Current __current) throws ServerError
getMyOpenSessions
but returns only those
sessions started by official OMERO clients.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getInput_async(AMD_ISession_getInput __cb, java.lang.String sess, java.lang.String key, Ice.Current __current) throws ServerError
Session
input environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getOutput_async(AMD_ISession_getOutput __cb, java.lang.String sess, java.lang.String key, Ice.Current __current) throws ServerError
Session
output environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void setInput_async(AMD_ISession_setInput __cb, java.lang.String sess, java.lang.String key, RType value, Ice.Current __current) throws ServerError
Session
input environment.
If the value is null, the key will be removed.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void setOutput_async(AMD_ISession_setOutput __cb, java.lang.String sess, java.lang.String key, RType value, Ice.Current __current) throws ServerError
Session
output environment. If the value is null, the key will be
removed.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getInputKeys_async(AMD_ISession_getInputKeys __cb, java.lang.String sess, Ice.Current __current) throws ServerError
Session
input
environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getOutputKeys_async(AMD_ISession_getOutputKeys __cb, java.lang.String sess, Ice.Current __current) throws ServerError
Session
output environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getInputs_async(AMD_ISession_getInputs __cb, java.lang.String sess, Ice.Current __current) throws ServerError
Session
input environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError
void getOutputs_async(AMD_ISession_getOutputs __cb, java.lang.String sess, Ice.Current __current) throws ServerError
Session
input environment.__cb
- The callback object for the operation.__current
- The Current object for the invocation.ServerError