omero.cmd.admin

Class CurrentSessionsRequestI

java.lang.Object

Ice.ObjectImpl

omero.cmd.Request

omero.cmd.CurrentSessionsRequest

omero.cmd.admin.CurrentSessionsRequestI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.services.util.ReadOnlyStatus.IsAware, IRequest

public class CurrentSessionsRequestI
extends CurrentSessionsRequest
implements IRequest, ome.services.util.ReadOnlyStatus.IsAware

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CurrentSessionsRequestI.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	contexts
protected ome.security.basic.CurrentDetails	current
protected Helper	helper
protected ome.services.sessions.SessionManager	manager
protected ome.services.sessions.SessionProvider	provider

Fields inherited from class omero.cmd.CurrentSessionsRequest

__ids, serialVersionUID

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
CurrentSessionsRequestI(ome.security.basic.CurrentDetails current, ome.services.sessions.SessionManager manager, ome.services.sessions.SessionProvider provider)

Method Summary

Modifier and Type	Method and Description
void	buildResponse(int step, java.lang.Object object) Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.
void	finish() Method within the transaction boundaries after all processing has occurred.
java.util.Map<java.lang.String,java.lang.String>	getCallContext() Returns the desired call context for this request.
Response	getResponse() Returns the current response value.
void	init(Helper helper) Method called within the transaction boundaries before any processing occurs.
boolean	isReadOnly(ome.services.util.ReadOnlyStatus readOnly)
java.lang.Object	step(int step) Single uncancellable action which will be performed by this IRequest.

Methods inherited from class omero.cmd.CurrentSessionsRequest

__readImpl, __writeImpl, clone, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __dispatch, __read, __read, __readImpl, __write, __write, __writeImpl, 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

Field Detail

helper

protected Helper helper

current

protected final ome.security.basic.CurrentDetails current

manager

protected final ome.services.sessions.SessionManager manager

provider

protected final ome.services.sessions.SessionProvider provider

contexts

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> contexts

Constructor Detail

CurrentSessionsRequestI

public CurrentSessionsRequestI(ome.security.basic.CurrentDetails current,
                               ome.services.sessions.SessionManager manager,
                               ome.services.sessions.SessionProvider provider)

Method Detail

getCallContext

public java.util.Map<java.lang.String,java.lang.String> getCallContext()

Description copied from interface: IRequest

Returns the desired call context for this request. Some request implementations will require "omero.group":"-1" for example and will hard-code that value. Others may permit users to pass in the desired values which will be merged into the static Map as desired.

Specified by:

getCallContext in interface IRequest

Returns:

the call context for this request

init

public void init(Helper helper)

Description copied from interface: IRequest

Method called within the transaction boundaries before any processing occurs. Implementations must properly initialize the "step" field of the Status object by calling Helper.setSteps(int). This count will define how many times the IRequest.step(int) method will be called. The Helper instance passed in contains those resources needed by IRequests to interact with data and should be stored for later use.

Specified by:

init in interface IRequest

Parameters:

helper - the helper for this request

step

public java.lang.Object step(int step)
                      throws HandleI.Cancel

Description copied from interface: IRequest

Single uncancellable action which will be performed by this IRequest. The return value can be an ome.model object that is attached to the current thread and transaction. After processing and detachment from the transaction, the object will be passed to IRequest.buildResponse(int, Object) for conversion and storage.

Specified by:

step in interface IRequest

Parameters:

step - the step number

Returns:

an object to be used in building the response

Throws:

HandleI.Cancel - if this request is cancelled

finish

public void finish()
            throws HandleI.Cancel

Description copied from interface: IRequest

Method within the transaction boundaries after all processing has occurred. A thrown HandleI.Cancel will still rollback the current transaction.

Specified by:

finish in interface IRequest

Throws:

HandleI.Cancel - if this request is cancelled

buildResponse

public void buildResponse(int step,
                          java.lang.Object object)

Description copied from interface: IRequest

Post-transaction chance to map from the return value of IRequest.step(int) to a Response object.

Specified by:

buildResponse in interface IRequest

Parameters:

step - the step number

object - an object to be used in building the response

getResponse

public Response getResponse()

Description copied from interface: IRequest

Returns the current response value. This method should be protected by synchronization where necessary, and should never raise an exception. It is also guaranteed to be called so that any state cleanup that is necessary can take place here.

Specified by:

getResponse in interface IRequest

Returns:

the response to this request

isReadOnly

public boolean isReadOnly(ome.services.util.ReadOnlyStatus readOnly)

Specified by:

isReadOnly in interface ome.services.util.ReadOnlyStatus.IsAware