omero.api

Interface _ISessionOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

ISession

All Known Implementing Classes:

_ISessionDisp, _ISessionTie

public interface _ISessionOperationsNC
extends _ServiceInterfaceOperationsNC

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.

Method Summary

Modifier and Type	Method and Description
void	closeSession_async(AMD_ISession_closeSession __cb, Session sess) Closes session and releases all resources.
void	createSession_async(AMD_ISession_createSession __cb, Principal p, java.lang.String credentials) Creates a new session and returns it to the user.
void	createSessionWithTimeout_async(AMD_ISession_createSessionWithTimeout __cb, Principal principal, long timeToLiveMilliseconds) Allows an admin to create a Session for the give Principal.
void	createSessionWithTimeouts_async(AMD_ISession_createSessionWithTimeouts __cb, Principal principal, long timeToLiveMilliseconds, long timeToIdleMilliseconds) 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) 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) Retrieves an entry from the given Session input environment.
void	getInputKeys_async(AMD_ISession_getInputKeys __cb, java.lang.String sess) Retrieves all keys in the Session input environment.
void	getInputs_async(AMD_ISession_getInputs __cb, java.lang.String sess) Retrieves all inputs from the given Session input environment.
void	getMyOpenAgentSessions_async(AMD_ISession_getMyOpenAgentSessions __cb, java.lang.String agent) Like getMyOpenSessions but returns only those sessions with the given agent string.
void	getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb) Like getMyOpenSessions but returns only those sessions started by official OMERO clients.
void	getMyOpenSessions_async(AMD_ISession_getMyOpenSessions __cb) 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) Retrieves an entry from the Session output environment.
void	getOutputKeys_async(AMD_ISession_getOutputKeys __cb, java.lang.String sess) Retrieves all keys in the Session output environment.
void	getOutputs_async(AMD_ISession_getOutputs __cb, java.lang.String sess) Retrieves all outputs from the given Session input environment.
void	getReferenceCount_async(AMD_ISession_getReferenceCount __cb, java.lang.String sessionUuid) Retrieves the current reference count for the given uuid.
void	getSession_async(AMD_ISession_getSession __cb, java.lang.String sessionUuid) 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) 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) Places an entry in the given Session output environment.

Method Detail

createSession_async

void createSession_async(AMD_ISession_createSession __cb,
                         Principal p,
                         java.lang.String credentials)
                  throws Glacier2.CannotCreateSessionException,
                         ServerError

Creates a new session and returns it to the user.

Parameters:

__cb - The callback object for the operation.

Throws:

ApiUsageException - if principal is null

SecurityViolation - if the password check fails

Glacier2.CannotCreateSessionException

ServerError

createUserSession_async

void createUserSession_async(AMD_ISession_createUserSession __cb,
                             long timeToLiveMilliseconds,
                             long timeToIdleMilliseconds,
                             java.lang.String defaultGroup)
                      throws Glacier2.CannotCreateSessionException,
                             ServerError

Allows a user to open up another session for him/herself with the given defaults without needing to re-enter password.

Parameters:

__cb - The callback object for the operation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

createSessionWithTimeout_async

void createSessionWithTimeout_async(AMD_ISession_createSessionWithTimeout __cb,
                                    Principal principal,
                                    long timeToLiveMilliseconds)
                             throws Glacier2.CannotCreateSessionException,
                                    ServerError

Allows an admin to create a Session for the give Principal.

Parameters:

__cb - The callback object for the operation.

principal - Non-null Principal with the target user's name

timeToLiveMilliseconds - 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.

Throws:

Glacier2.CannotCreateSessionException

ServerError

createSessionWithTimeouts_async

void createSessionWithTimeouts_async(AMD_ISession_createSessionWithTimeouts __cb,
                                     Principal principal,
                                     long timeToLiveMilliseconds,
                                     long timeToIdleMilliseconds)
                              throws Glacier2.CannotCreateSessionException,
                                     ServerError

Allows an admin to create a Session for the given Principal.

Parameters:

__cb - The callback object for the operation.

principal - Non-null Principal with the target user's name

timeToLiveMilliseconds - 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.

Throws:

Glacier2.CannotCreateSessionException

ServerError

getSession_async

void getSession_async(AMD_ISession_getSession __cb,
                      java.lang.String sessionUuid)
               throws ServerError

Retrieves the session associated with this uuid, updating the last access time as well. Throws a RemovedSessionException if not present, or a SessionTimeoutException if expired. This method can be used as a Session ping.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getReferenceCount_async

void getReferenceCount_async(AMD_ISession_getReferenceCount __cb,
                             java.lang.String sessionUuid)
                      throws ServerError

Retrieves the current reference count for the given uuid. Has the same semantics as getSession.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

closeSession_async

void closeSession_async(AMD_ISession_closeSession __cb,
                        Session sess)
                 throws ServerError

Closes session and releases all resources. It is preferred that all clients call this method as soon as possible to free memory, but it is possible to not call close, and rejoin a session later. The current reference count for the session is returned. If the session does not exist, -1. If this call caused the death of the session, then -2.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenSessions_async

void getMyOpenSessions_async(AMD_ISession_getMyOpenSessions __cb)
                      throws ServerError

Returns a list of open sessions for the current user. The list is ordered by session creation time, so that the last item was created last.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenAgentSessions_async

void getMyOpenAgentSessions_async(AMD_ISession_getMyOpenAgentSessions __cb,
                                  java.lang.String agent)
                           throws ServerError

Like getMyOpenSessions but returns only those sessions with the given agent string.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenClientSessions_async

void getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb)
                            throws ServerError

Like getMyOpenSessions but returns only those sessions started by official OMERO clients.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getInput_async

void getInput_async(AMD_ISession_getInput __cb,
                    java.lang.String sess,
                    java.lang.String key)
             throws ServerError

Retrieves an entry from the given Session input environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutput_async

void getOutput_async(AMD_ISession_getOutput __cb,
                     java.lang.String sess,
                     java.lang.String key)
              throws ServerError

Retrieves an entry from the Session output environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setInput_async

void setInput_async(AMD_ISession_setInput __cb,
                    java.lang.String sess,
                    java.lang.String key,
                    RType value)
             throws ServerError

Places an entry in the given Session input environment. If the value is null, the key will be removed.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setOutput_async

void setOutput_async(AMD_ISession_setOutput __cb,
                     java.lang.String sess,
                     java.lang.String key,
                     RType value)
              throws ServerError

Places an entry in the given Session output environment. If the value is null, the key will be removed.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getInputKeys_async

void getInputKeys_async(AMD_ISession_getInputKeys __cb,
                        java.lang.String sess)
                 throws ServerError

Retrieves all keys in the Session input environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutputKeys_async

void getOutputKeys_async(AMD_ISession_getOutputKeys __cb,
                         java.lang.String sess)
                  throws ServerError

Retrieves all keys in the Session output environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getInputs_async

void getInputs_async(AMD_ISession_getInputs __cb,
                     java.lang.String sess)
              throws ServerError

Retrieves all inputs from the given Session input environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutputs_async

void getOutputs_async(AMD_ISession_getOutputs __cb,
                      java.lang.String sess)
               throws ServerError

Retrieves all outputs from the given Session input environment.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError