sirius.web.services

Class ServiceCall

java.lang.Object

sirius.web.services.ServiceCall

public abstract class ServiceCall
extends Object

Provides access to the underlying request of a call to a StructuredService

Field Summary

Fields

Modifier and Type	Field and Description
protected WebContext	ctx
protected static sirius.kernel.health.Log	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceCall(WebContext ctx)

Method Summary

Modifier and Type	Method and Description
protected abstract sirius.kernel.xml.StructuredOutput	createOutput() Creates the output used to render the result of the service call.
sirius.kernel.commons.Value	get(String... keys) Returns the value provided for the given key(s).
WebContext	getContext() Provides access to the underlying request.
List<String>	getParameters(String... keys) Returns all query string or POST parameters provided for the given key(s).
sirius.kernel.health.HandledException	handle(Throwable error) Handles the given exception by creating an error response.
protected void	invoke(StructuredService serv) Calls the given service.
void	markCallFailed(sirius.kernel.xml.StructuredOutput out, String message) Marks the call as failed by adding the well known error, successfalse and message properties to the given output.
void	markCallSuccessful(sirius.kernel.xml.StructuredOutput out) Marks the call as failed by adding the well known error and successfalse properties to the given output.
sirius.kernel.commons.Value	require(String... keys) Returns the value provided for the given key(s) or reports an error if no non empty value was found.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final sirius.kernel.health.Log LOG

ctx

protected WebContext ctx

Constructor Detail

ServiceCall

protected ServiceCall(WebContext ctx)

Method Detail

handle

public sirius.kernel.health.HandledException handle(Throwable error)

Handles the given exception by creating an error response.

Parameters:

error - the exception to report

Returns:

HandledException the handled Exception

markCallFailed

public void markCallFailed(sirius.kernel.xml.StructuredOutput out,
                           String message)

Marks the call as failed by adding the well known error, successfalse and message properties to the given output.

Parameters:

out - the output to write to

message - the message to report

markCallSuccessful

public void markCallSuccessful(sirius.kernel.xml.StructuredOutput out)

Marks the call as failed by adding the well known error and successfalse properties to the given output.

Parameters:

out - the output to write to

getContext

public WebContext getContext()

Provides access to the underlying request.

Returns:

the request which created the service call

get

public sirius.kernel.commons.Value get(String... keys)

Returns the value provided for the given key(s).

The first non empty value is used. If all values are empty, an empty value is returned.

Parameters:

keys - the keys to check for a value

Returns:

the first non empty value found for one of the given keys

getParameters

public List<String> getParameters(String... keys)

Returns all query string or POST parameters provided for the given key(s).

If no parameters are found, an empty list is returned.

Parameters:

keys - the keys to check for parameters

Returns:

a list of all parameters found for the given keys

require

public sirius.kernel.commons.Value require(String... keys)

Returns the value provided for the given key(s) or reports an error if no non empty value was found.

The first non empty value is used. If all values are empty, an exception is thrown.

Parameters:

keys - the keys to check for a value

Returns:

the first non empty value found for one of the given keys

invoke

protected void invoke(StructuredService serv)

Calls the given service.

Parameters:

serv - the service to call

createOutput

protected abstract sirius.kernel.xml.StructuredOutput createOutput()

Creates the output used to render the result of the service call.

Returns:

the created output