Skip navigation links

oracle.wcps.conductor.scenario
Interface IScenarioRequest

public interface IScenarioRequest

Represents the request to the current scenario.

Nested Class Summary

static class

IScenarioRequest.Projection Defines the requested projection from the client.

Method Summary

java.lang.Object	getHttpRequest() Get the HttpServletRequest associated with the current scenario context, if any.
java.lang.Object	getHttpResponse() Get the HttpServletResponse associated with the current scenario context, if any.
java.util.Locale	getLocale() Returns the specified locale within this scenario context.
java.lang.String	getNamespace() Returns the current namespace within the current scenario context.
java.lang.Integer	getPageSize() Returns the page size requested by the client.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Returns a map of input parameters associated with the current scenario context.
IScenarioRequest.Projection	getProjection() Returns the projection requested by the client.
java.lang.Integer	getStartIndex() Returns the start index requested by the client.
java.security.Principal	getUserPrincipal() Returns a java.security.Principal object containing the name of the current authenticated user.
void	setLocale(java.util.Locale locale) Sets the current locale for the current request
void	setNamespace(java.lang.String namespace) Sets the current namespace of the request.

Method Detail

getUserPrincipal

java.security.Principal getUserPrincipal()

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

Returns a map of input parameters associated with the current scenario context.

getLocale

java.util.Locale getLocale()

Returns the specified locale within this scenario context.

Default is Locale.getDefaultLocale()

Returns:

getNamespace

java.lang.String getNamespace()

Returns the current namespace within the current scenario context.

Returns:

The current namespace.

setNamespace

void setNamespace(java.lang.String namespace)

Sets the current namespace of the request.

Parameters:

namespace - The current namespace.

setLocale

void setLocale(java.util.Locale locale)

Sets the current locale for the current request

Parameters:

locale - The locale

getHttpRequest

java.lang.Object getHttpRequest()

Get the HttpServletRequest associated with the current scenario context, if any.

Returns:

The HttpServletRequest if available. Null otherwise.

getHttpResponse

java.lang.Object getHttpResponse()

Get the HttpServletResponse associated with the current scenario context, if any.

Returns:

The HttpServletResponse if available. Null otherwise.

getStartIndex

java.lang.Integer getStartIndex()

Returns the start index requested by the client.

Returns:

The start index.

getPageSize

java.lang.Integer getPageSize()

Returns the page size requested by the client.

Returns:

The page size for pagination.

getProjection

IScenarioRequest.Projection getProjection()

Returns the projection requested by the client.

Returns:

The requested projection.

Skip navigation links