ome.smuggler.core.service.omero

Interface SessionService

All Known Implementing Classes:

SessionManager

public interface SessionService

Provides access to OMERO sessions functionality.

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.

Method Detail

create

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.

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.

Throws:

java.lang.NullPointerException - if the URI argument is null.

java.lang.IllegalArgumentException - if the username or password is null or empty.

keepAlive

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

Issues a keep-alive command for the specified session.

Parameters:

omeroHostAndPort - detail the server to connect to.

sessionKey - the session ID.

Returns:

true if the command succeeded, false otherwise.

Throws:

java.lang.NullPointerException - if any argument is null.

close

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

Closes the specified session.

Parameters:

omeroHostAndPort - detail the server to connect to.

sessionKey - the session ID.

Returns:

true if the command succeeded, false otherwise.

Throws:

java.lang.NullPointerException - if any argument is null.

createAndKeepAlive

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.

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.

Throws:

java.lang.NullPointerException - if the URI or time argument is null.

java.lang.IllegalArgumentException - if the username or password is null or empty.