ome.api

Interface ISession

All Superinterfaces:

ServiceInterface

All Known Implementing Classes:

SessionBean

public interface ISession
extends ServiceInterface

Start here: Session creation service for OMERO. Access to all other services is dependent upon a properly created and still active Session. The session's uuid 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 ServiceFactory as well as the Ice omero.api.ServiceFactoryPrx use ISession to acquire a Session. In the RMI case, the ISession instance is the first remote proxy accessed. 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.

Since:

3.0-Beta3

Author:

Josh Moore, josh at glencoesoftware.com

Method Summary

Modifier and Type	Method and Description
int	closeSession(Session session) Closes session and releases all resources.
Session	createSession(Principal principal, String credentials) Creates a new session and returns it to the user.
Session	createSessionWithTimeout(Principal principal, long timeToLiveMilliseconds) Allows an admin to create a Session for the give Principal
Session	createSessionWithTimeouts(Principal principal, long timeToLiveMilliseconds, long timeToIdleMilliseconds) Allows an admin to create a Session for the give Principal
Session	createUserSession(long timeToLiveMilliseconds, long timeToIdleMillisecond, String defaultGroup) Allows a user to open up another session for him/herself with the given defaults without needing to re-enter password.
Object	getInput(String session, String key) Retrieves an entry from the given session's input environment.
Set<String>	getInputKeys(String session) Retrieves all keys in the session's input environment.
Map<String,Object>	getInputs(String session) Retrieves all inputs from the given session's input environment.
List<Session>	getMyOpenAgentSessions(String agent) Like getMyOpenSessions() but returns only those sessions with the given agent string.
List<Session>	getMyOpenClientSessions() Like getMyOpenSessions() but returns only those sessions started by official OMERO clients.
List<Session>	getMyOpenSessions() Returns a list of open sessions for the current user.
Object	getOutput(String session, String key) Retrieves an entry from the session's output environment.
Set<String>	getOutputKeys(String session) Retrieves all keys in the sesson's output environment.
Map<String,Object>	getOutputs(String session) Retrieves all outputs from the given session's input environment.
int	getReferenceCount(String sessionUuid) Retrieves the current reference count for the given uuid.
Session	getSession(String sessionUuid) Retrieves the session associated with this uuid, updating the last access time as well.
void	setInput(String session, String key, Object objection) Places an entry in the given session's input environment.
void	setOutput(String session, String key, Object objection) Places an entry in the given session's output environment.

Method Detail

createUserSession

Session createUserSession(long timeToLiveMilliseconds,
                          long timeToIdleMillisecond,
                          String defaultGroup)

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

createSessionWithTimeout

Session createSessionWithTimeout(Principal principal,
                                 long timeToLiveMilliseconds)

Allows an admin to create a Session for the give Principal

Parameters:

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.

createSessionWithTimeouts

Session createSessionWithTimeouts(Principal principal,
                                  long timeToLiveMilliseconds,
                                  long timeToIdleMilliseconds)

Allows an admin to create a Session for the give Principal

Parameters:

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.

createSession

Session createSession(Principal principal,
                      String credentials)

Creates a new session and returns it to the user.

Throws:

ApiUsageException - if principal is null

SecurityViolation - if the password check fails

getSession

Session getSession(String sessionUuid)

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.

getReferenceCount

int getReferenceCount(String sessionUuid)

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

closeSession

int closeSession(Session session)

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.

getMyOpenSessions

List<Session> getMyOpenSessions()

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.

getMyOpenAgentSessions

List<Session> getMyOpenAgentSessions(String agent)

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

getMyOpenClientSessions

List<Session> getMyOpenClientSessions()

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

getInput

Object getInput(String session,
                String key)

Retrieves an entry from the given session's input environment.

getInputKeys

Set<String> getInputKeys(String session)

Retrieves all keys in the session's input environment.

Parameters:

session -

Returns:

a Set of keys

getInputs

Map<String,Object> getInputs(String session)

Retrieves all inputs from the given session's input environment.

setInput

void setInput(String session,
              String key,
              Object objection)

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

getOutputKeys

Set<String> getOutputKeys(String session)

Retrieves all keys in the sesson's output environment.

getOutput

Object getOutput(String session,
                 String key)

Retrieves an entry from the session's output environment.

getOutputs

Map<String,Object> getOutputs(String session)

Retrieves all outputs from the given session's input environment.

setOutput

void setOutput(String session,
               String key,
               Object objection)

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