ome.smuggler.core.service.omero.impl

Class SessionManager

java.lang.Object

ome.smuggler.core.service.omero.impl.SessionManager

All Implemented Interfaces:

SessionService

public class SessionManager
extends java.lang.Object
implements SessionService

Implements the SessionService.

Constructor Summary

Constructors

Constructor and Description
SessionManager(OmeroEnv env) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	close(java.net.URI omeroHostAndPort, java.lang.String sessionKey) Closes the specified session.
java.util.Optional<java.lang.String>	create(java.net.URI omeroHostAndPort, java.lang.String username, java.lang.String password) Starts a new session for the specified user.
java.util.Optional<java.lang.String>	createAndKeepAlive(java.net.URI omeroHostAndPort, java.lang.String username, java.lang.String password, java.time.Duration howLong) Starts a new session for the specified user and keeps it alive for a given amount of time.
boolean	keepAlive(java.net.URI omeroHostAndPort, java.lang.String sessionKey) Issues a keep-alive command for the specified session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManager

public SessionManager(OmeroEnv env)

Creates a new instance.

Parameters:

env - the service environment.

Method Detail

create

public java.util.Optional<java.lang.String> create(java.net.URI omeroHostAndPort,
                                                   java.lang.String username,
                                                   java.lang.String password)

Description copied from interface: SessionService

Starts a new session for the specified user.

Specified by:

create in interface SessionService

Parameters:

omeroHostAndPort - detail the server to connect to.

username - the login name of the user this session is for.

password - the password of the user this session is for.

Returns:

the session key of the newly created session or empty if the session could not be created.

keepAlive

public boolean keepAlive(java.net.URI omeroHostAndPort,
                         java.lang.String sessionKey)

Description copied from interface: SessionService

Issues a keep-alive command for the specified session.

Specified by:

keepAlive in interface SessionService

Parameters:

omeroHostAndPort - detail the server to connect to.

sessionKey - the session ID.

Returns:

true if the command succeeded, false otherwise.

close

public boolean close(java.net.URI omeroHostAndPort,
                     java.lang.String sessionKey)

Description copied from interface: SessionService

Closes the specified session.

Specified by:

close in interface SessionService

Parameters:

omeroHostAndPort - detail the server to connect to.

sessionKey - the session ID.

Returns:

true if the command succeeded, false otherwise.

createAndKeepAlive

public java.util.Optional<java.lang.String> createAndKeepAlive(java.net.URI omeroHostAndPort,
                                                               java.lang.String username,
                                                               java.lang.String password,
                                                               java.time.Duration howLong)

Description copied from interface: SessionService

Starts a new session for the specified user and keeps it alive for a given amount of time.

Specified by:

createAndKeepAlive in interface SessionService

Parameters:

omeroHostAndPort - detail the server to connect to.

username - the login name of the user this session is for.

password - the password of the user this session is for.

howLong - how long from now to keep the session alive.

Returns:

the session key of the newly created session or empty if the session could not be created.