omero.api

Class _ISessionTie

java.lang.Object

Ice.ObjectImpl

omero.api._ISessionDisp

omero.api._ISessionTie

All Implemented Interfaces:

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

public class _ISessionTie
extends _ISessionDisp
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._ISessionDisp

__ids

Fields inherited from interface omero.api.ISession

ice_staticId

Constructor Summary

Constructors

Constructor and Description
_ISessionTie(_ISessionOperations delegate)
_ISessionTie()

Method Summary

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.
boolean	equals(java.lang.Object rhs)
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.
int	hashCode()
java.lang.Object	ice_delegate()
void	ice_delegate(java.lang.Object delegate)
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.

Methods inherited from class omero.api._ISessionDisp

___closeSession, ___createSession, ___createSessionWithTimeout, ___createSessionWithTimeouts, ___createUserSession, ___getInput, ___getInputKeys, ___getInputs, ___getMyOpenAgentSessions, ___getMyOpenClientSessions, ___getMyOpenSessions, ___getOutput, ___getOutputKeys, ___getOutputs, ___getReferenceCount, ___getSession, ___setInput, ___setOutput, __dispatch, __readImpl, __writeImpl, 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, ice_copyStateFrom, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setInput_async, setOutput_async

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

_ISessionTie

public _ISessionTie()

_ISessionTie

public _ISessionTie(_ISessionOperations 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

closeSession_async

public void closeSession_async(AMD_ISession_closeSession __cb,
                               Session sess,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

createSession_async

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

Description copied from interface: _ISessionOperations

Creates a new session and returns it to the user.

Specified by:

createSession_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

createSessionWithTimeout_async

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

Description copied from interface: _ISessionOperations

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

Specified by:

createSessionWithTimeout_async in interface _ISessionOperations

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.

__current - The Current object for the invocation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

createSessionWithTimeouts_async

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

Description copied from interface: _ISessionOperations

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

Specified by:

createSessionWithTimeouts_async in interface _ISessionOperations

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.

__current - The Current object for the invocation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

createUserSession_async

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

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

Glacier2.CannotCreateSessionException

ServerError

getInput_async

public void getInput_async(AMD_ISession_getInput __cb,
                           java.lang.String sess,
                           java.lang.String key,
                           Ice.Current __current)
                    throws ServerError

Description copied from interface: _ISessionOperations

Retrieves an entry from the given Session input environment.

Specified by:

getInput_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getInputKeys_async

public void getInputKeys_async(AMD_ISession_getInputKeys __cb,
                               java.lang.String sess,
                               Ice.Current __current)
                        throws ServerError

Description copied from interface: _ISessionOperations

Retrieves all keys in the Session input environment.

Specified by:

getInputKeys_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getInputs_async

public void getInputs_async(AMD_ISession_getInputs __cb,
                            java.lang.String sess,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _ISessionOperations

Retrieves all inputs from the given Session input environment.

Specified by:

getInputs_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getMyOpenAgentSessions_async

public void getMyOpenAgentSessions_async(AMD_ISession_getMyOpenAgentSessions __cb,
                                         java.lang.String agent,
                                         Ice.Current __current)
                                  throws ServerError

Description copied from interface: _ISessionOperations

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

Specified by:

getMyOpenAgentSessions_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getMyOpenClientSessions_async

public void getMyOpenClientSessions_async(AMD_ISession_getMyOpenClientSessions __cb,
                                          Ice.Current __current)
                                   throws ServerError

Description copied from interface: _ISessionOperations

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

Specified by:

getMyOpenClientSessions_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getMyOpenSessions_async

public void getMyOpenSessions_async(AMD_ISession_getMyOpenSessions __cb,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getOutput_async

public void getOutput_async(AMD_ISession_getOutput __cb,
                            java.lang.String sess,
                            java.lang.String key,
                            Ice.Current __current)
                     throws ServerError

Description copied from interface: _ISessionOperations

Retrieves an entry from the Session output environment.

Specified by:

getOutput_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getOutputKeys_async

public void getOutputKeys_async(AMD_ISession_getOutputKeys __cb,
                                java.lang.String sess,
                                Ice.Current __current)
                         throws ServerError

Description copied from interface: _ISessionOperations

Retrieves all keys in the Session output environment.

Specified by:

getOutputKeys_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getOutputs_async

public void getOutputs_async(AMD_ISession_getOutputs __cb,
                             java.lang.String sess,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _ISessionOperations

Retrieves all outputs from the given Session input environment.

Specified by:

getOutputs_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getReferenceCount_async

public void getReferenceCount_async(AMD_ISession_getReferenceCount __cb,
                                    java.lang.String sessionUuid,
                                    Ice.Current __current)
                             throws ServerError

Description copied from interface: _ISessionOperations

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

Specified by:

getReferenceCount_async in interface _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

getSession_async

public void getSession_async(AMD_ISession_getSession __cb,
                             java.lang.String sessionUuid,
                             Ice.Current __current)
                      throws ServerError

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setInput_async

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

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError

setOutput_async

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

Description copied from interface: _ISessionOperations

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 _ISessionOperations

Parameters:

__cb - The callback object for the operation.

__current - The Current object for the invocation.

Throws:

ServerError