omero.cmd

Class Helper

java.lang.Object

omero.cmd.Helper

public class Helper
extends Object

Helper object for all omero.cmd implementations. Since the objects must subclass from an Ice implementation repeated implementations which cannot be inherited are provided here.

Since:

4.4.0

Author:

Josh Moore, josh at glencoesoftware.com

Constructor Summary

Constructors

Constructor and Description
Helper(omero.cmd.Request request, omero.cmd.Status status, SqlAction sql, org.hibernate.Session session, ServiceFactory sf)

Method Summary

Modifier and Type	Method and Description
void	allowGuests() Must be called before setSteps if access by the guest user is to be allowed.
void	assertResponse(int step) Checks the given steps against the number of times that this method has been called on this instance and then increments the call count.
void	assertStep(int step) Checks the given steps against the number of times that this method has been called on this instance and then increments the call count.
void	assertStep(int i, int step) Throws an exception if the current step is not the expected value.
HandleI.Cancel	cancel(omero.cmd.ERR err, Throwable t, String name, Map<String,String> params) Like fail(ERR, Throwable, String, String...) throws a HandleI.Cancel exception.
HandleI.Cancel	cancel(omero.cmd.ERR err, Throwable t, String name, String... paramList) Calls cancel(ERR, Throwable, String, Map) with the output of params(String...).
void	debug(String fmt, Object... args)
void	error(String fmt, Object... args)
void	error(Throwable t, String fmt, Object... args)
void	fail(omero.cmd.ERR err, Throwable t, String name, Map<String,String> params) Sets the status.flags and the ERR properties appropriately and also stores the message and stacktrace of the throwable in the parameters.
void	fail(omero.cmd.ERR err, Throwable t, String name, String... paramList) Calls fail(ERR, Throwable, String, Map) with the output of params(String...).
EventContext	getEventContext() Provides an EventContext instance without reloading the session, via LocalAdmin.getEventContextQuiet().
omero.cmd.Response	getResponse()
ServiceFactory	getServiceFactory()
org.hibernate.Session	getSession()
SqlAction	getSql()
omero.cmd.Status	getStatus()
int	getSteps()
void	info(String fmt, Object... args)
boolean	isLast(int step) Returns true if this is the last step for the given request.
Map<String,String>	params(String... paramList) Converts pairs of values from the varargs list into a map.
boolean	setResponseIfNull(omero.cmd.Response rsp) Set the response if there is not currently run, in which case true is returned.
void	setSteps(int steps)
Helper	subhelper(omero.cmd.Request req, omero.cmd.Status substatus) Run IRequest.init(Helper) on a sub-command by creating a new Helper instance.
void	warn(String fmt, Object... args)

Methods inherited from class java.lang.Object

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

Constructor Detail

Helper

public Helper(omero.cmd.Request request,
              omero.cmd.Status status,
              SqlAction sql,
              org.hibernate.Session session,
              ServiceFactory sf)

Method Detail

subhelper

public Helper subhelper(omero.cmd.Request req,
                        omero.cmd.Status substatus)

Run IRequest.init(Helper) on a sub-command by creating a new Helper instance.

Parameters:

req - the request

substatus - its status for its new helper

Returns:

the new helper

allowGuests

public void allowGuests()

Must be called before setSteps if access by the guest user is to be allowed.

setSteps

public void setSteps(int steps)

getSteps

public int getSteps()

getStatus

public omero.cmd.Status getStatus()

getResponse

public omero.cmd.Response getResponse()

setResponseIfNull

public boolean setResponseIfNull(omero.cmd.Response rsp)

Set the response if there is not currently run, in which case true is returned. Otherwise, false.

Parameters:

rsp - the response

Returns:

if the setting was successful

getServiceFactory

public ServiceFactory getServiceFactory()

getSession

public org.hibernate.Session getSession()

getSql

public SqlAction getSql()

debug

public void debug(String fmt,
                  Object... args)

info

public void info(String fmt,
                 Object... args)

warn

public void warn(String fmt,
                 Object... args)

error

public void error(String fmt,
                  Object... args)

error

public void error(Throwable t,
                  String fmt,
                  Object... args)

params

public Map<String,String> params(String... paramList)

Converts pairs of values from the varargs list into a map. Any leftover value will be ignored.

Parameters:

paramList - a list of parameters

Returns:

a map with entries constructed from consecutive pairs of the parameters

fail

public void fail(omero.cmd.ERR err,
                 Throwable t,
                 String name,
                 String... paramList)

Calls fail(ERR, Throwable, String, Map) with the output of params(String...).

fail

public void fail(omero.cmd.ERR err,
                 Throwable t,
                 String name,
                 Map<String,String> params)

Sets the status.flags and the ERR properties appropriately and also stores the message and stacktrace of the throwable in the parameters.

cancel

public HandleI.Cancel cancel(omero.cmd.ERR err,
                             Throwable t,
                             String name,
                             String... paramList)

Calls cancel(ERR, Throwable, String, Map) with the output of params(String...). See the statement about the return value.

cancel

public HandleI.Cancel cancel(omero.cmd.ERR err,
                             Throwable t,
                             String name,
                             Map<String,String> params)

Like fail(ERR, Throwable, String, String...) throws a HandleI.Cancel exception. A HandleI.Cancel is thrown, even though one is also specified as the return value. This permits:

 } catch (Throwable t) {
     throw helper.cancel(new ERR(), t);
 }
 

since omitting the "throw" within the catch clauses forces one to enter a number of "return null; // Never reached" lines.

assertStep

public void assertStep(int i,
                       int step)

Throws an exception if the current step is not the expected value. The boolean returns value has been added so it can be used as:

 public boolean step(int i) {
     if (helper.assertStep(0, i)) {
         return null;
     }
 

Parameters:

i - the expected step number

step - the actual step number

assertStep

public void assertStep(int step)

Checks the given steps against the number of times that this method has been called on this instance and then increments the call count.

Parameters:

step - the new step number

assertResponse

public void assertResponse(int step)

Checks the given steps against the number of times that this method has been called on this instance and then increments the call count.

Parameters:

step - the step number for the new response

isLast

public boolean isLast(int step)

Returns true if this is the last step for the given request.

Parameters:

step - the step number

Returns:

if the given step is the last

getEventContext

public EventContext getEventContext()

Provides an EventContext instance without reloading the session, via LocalAdmin.getEventContextQuiet().

Returns:

the event context