omero.api

Class _ISessionDisp

java.lang.Object

Ice.ObjectImpl

omero.api._ISessionDisp

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, _ISessionOperations, _ISessionOperationsNC, _ServiceInterfaceOperations, _ServiceInterfaceOperationsNC, ISession, ServiceInterface

Direct Known Subclasses:

_ISessionTie

public abstract class _ISessionDisp
extends Ice.ObjectImpl
implements ISession

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
static long	serialVersionUID

Fields inherited from interface omero.api.ISession

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_ISessionDisp()

Method Summary

Modifier and Type	Method and Description
static Ice.DispatchStatus	___closeSession(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___createSession(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___createSessionWithTimeout(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___createSessionWithTimeouts(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___createUserSession(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getInput(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getInputKeys(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getInputs(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMyOpenAgentSessions(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMyOpenClientSessions(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getMyOpenSessions(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getOutput(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getOutputKeys(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getOutputs(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getReferenceCount(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___getSession(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setInput(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
static Ice.DispatchStatus	___setOutput(ISession __obj, IceInternal.Incoming __inS, Ice.Current __current)
Ice.DispatchStatus	__dispatch(IceInternal.Incoming in, Ice.Current __current)
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
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.
protected void	ice_copyStateFrom(Ice.Object __obj)
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()
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.

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

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.api._ISessionOperations

closeSession_async, createSession_async, createSessionWithTimeout_async, createSessionWithTimeouts_async, createUserSession_async, getInput_async, getInputKeys_async, getInputs_async, getMyOpenAgentSessions_async, getMyOpenClientSessions_async, getMyOpenSessions_async, getOutput_async, getOutputKeys_async, getOutputs_async, getReferenceCount_async, getSession_async, setInput_async, setOutput_async

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

__ids

public static final java.lang.String[] __ids

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

_ISessionDisp

public _ISessionDisp()

Method Detail

ice_copyStateFrom

protected void ice_copyStateFrom(Ice.Object __obj)
                          throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

closeSession_async

public final 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.

Specified by:

closeSession_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

createSession_async

public final 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.

Specified by:

createSession_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ApiUsageException - if principal is null

SecurityViolation - if the password check fails

Glacier2.CannotCreateSessionException

ServerError

createSessionWithTimeout_async

public final 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.

Specified by:

createSessionWithTimeout_async in interface _ISessionOperationsNC

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

public final 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.

Specified by:

createSessionWithTimeouts_async in interface _ISessionOperationsNC

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

createUserSession_async

public final 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.

Specified by:

createUserSession_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

getInput_async

public final 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.

Specified by:

getInput_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getInputKeys_async

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

Retrieves all keys in the Session input environment.

Specified by:

getInputKeys_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getInputs_async

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

Retrieves all inputs from the given Session input environment.

Specified by:

getInputs_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenAgentSessions_async

public final 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.

Specified by:

getMyOpenAgentSessions_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenClientSessions_async

public final void getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb)
                                         throws ServerError

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

Specified by:

getMyOpenClientSessions_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getMyOpenSessions_async

public final 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.

Specified by:

getMyOpenSessions_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutput_async

public final 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.

Specified by:

getOutput_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutputKeys_async

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

Retrieves all keys in the Session output environment.

Specified by:

getOutputKeys_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getOutputs_async

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

Retrieves all outputs from the given Session input environment.

Specified by:

getOutputs_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getReferenceCount_async

public final 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.

Specified by:

getReferenceCount_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getSession_async

public final 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.

Specified by:

getSession_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setInput_async

public final 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.

Specified by:

setInput_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

setOutput_async

public final 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.

Specified by:

setOutput_async in interface _ISessionOperationsNC

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

___createSession

public static Ice.DispatchStatus ___createSession(ISession __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___createUserSession

public static Ice.DispatchStatus ___createUserSession(ISession __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___createSessionWithTimeout

public static Ice.DispatchStatus ___createSessionWithTimeout(ISession __obj,
                                                             IceInternal.Incoming __inS,
                                                             Ice.Current __current)

___createSessionWithTimeouts

public static Ice.DispatchStatus ___createSessionWithTimeouts(ISession __obj,
                                                              IceInternal.Incoming __inS,
                                                              Ice.Current __current)

___getSession

public static Ice.DispatchStatus ___getSession(ISession __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

___getReferenceCount

public static Ice.DispatchStatus ___getReferenceCount(ISession __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___closeSession

public static Ice.DispatchStatus ___closeSession(ISession __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getMyOpenSessions

public static Ice.DispatchStatus ___getMyOpenSessions(ISession __obj,
                                                      IceInternal.Incoming __inS,
                                                      Ice.Current __current)

___getMyOpenAgentSessions

public static Ice.DispatchStatus ___getMyOpenAgentSessions(ISession __obj,
                                                           IceInternal.Incoming __inS,
                                                           Ice.Current __current)

___getMyOpenClientSessions

public static Ice.DispatchStatus ___getMyOpenClientSessions(ISession __obj,
                                                            IceInternal.Incoming __inS,
                                                            Ice.Current __current)

___getInput

public static Ice.DispatchStatus ___getInput(ISession __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___getOutput

public static Ice.DispatchStatus ___getOutput(ISession __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___setInput

public static Ice.DispatchStatus ___setInput(ISession __obj,
                                             IceInternal.Incoming __inS,
                                             Ice.Current __current)

___setOutput

public static Ice.DispatchStatus ___setOutput(ISession __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___getInputKeys

public static Ice.DispatchStatus ___getInputKeys(ISession __obj,
                                                 IceInternal.Incoming __inS,
                                                 Ice.Current __current)

___getOutputKeys

public static Ice.DispatchStatus ___getOutputKeys(ISession __obj,
                                                  IceInternal.Incoming __inS,
                                                  Ice.Current __current)

___getInputs

public static Ice.DispatchStatus ___getInputs(ISession __obj,
                                              IceInternal.Incoming __inS,
                                              Ice.Current __current)

___getOutputs

public static Ice.DispatchStatus ___getOutputs(ISession __obj,
                                               IceInternal.Incoming __inS,
                                               Ice.Current __current)

__dispatch

public Ice.DispatchStatus __dispatch(IceInternal.Incoming in,
                                     Ice.Current __current)

Specified by:

__dispatch in interface Ice.Object

Overrides:

__dispatch in class Ice.ObjectImpl

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl