Package io.gravitee.gateway.api

Interface ExecutionContext

All Known Subinterfaces:

MutableExecutionContext

All Known Implementing Classes:

SimpleExecutionContext

public interface ExecutionContext

Author:

David BRASSELY (david.brassely at graviteesource.com), Azize ELAMRANI (azize.elamrani at graviteesource.com), Nicolas GERAUD (nicolas.geraud at graviteesource.com), GraviteeSource Team

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_API
static final String	ATTR_API_DEPLOYED_AT
static final String	ATTR_APPLICATION
static final String	ATTR_CLIENT_IDENTIFIER
static final String	ATTR_CONTEXT_PATH
static final String	ATTR_ENVIRONMENT
static final String	ATTR_FAILURE_ATTRIBUTE
static final String	ATTR_INVOKER
static final String	ATTR_INVOKER_SKIP
static final String	ATTR_MAPPED_PATH
static final String	ATTR_ORGANIZATION
static final String	ATTR_PLAN
static final String	ATTR_PREFIX
static final String	ATTR_QUOTA_COUNT
static final String	ATTR_QUOTA_LIMIT
static final String	ATTR_QUOTA_REMAINING
static final String	ATTR_QUOTA_RESET_TIME
static final String	ATTR_REQUEST_ENDPOINT
static final String	ATTR_REQUEST_METHOD
static final String	ATTR_RESOLVED_PATH
static final String	ATTR_SECURITY_SKIP	Skip security chain isn't prefixed to avoid breaking code where this constant isn't used.
static final String	ATTR_SUBSCRIPTION_ID
static final String	ATTR_USER
static final String	ATTR_USER_ROLES
static final String	ATTR_VALIDATE_SUBSCRIPTION

Method Summary

Modifier and Type	Method	Description
Object	getAttribute(String name)	Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
Enumeration<String>	getAttributeNames()	Returns an Enumeration containing the names of the attributes available to this request.
Map<String,Object>	getAttributes()
<T> T	getComponent(Class<T> componentClass)
io.gravitee.el.TemplateEngine	getTemplateEngine()
Tracer	getTracer()
void	removeAttribute(String name)	Removes an attribute from this request.
Request	request()
Response	response()
void	setAttribute(String name, Object value)	Stores an attribute in this request.

Field Details

ATTR_PREFIX

static final String ATTR_PREFIX

See Also:

• Constant Field Values

ATTR_CONTEXT_PATH

static final String ATTR_CONTEXT_PATH

See Also:

• Constant Field Values

ATTR_RESOLVED_PATH

static final String ATTR_RESOLVED_PATH

See Also:

• Constant Field Values

ATTR_APPLICATION

static final String ATTR_APPLICATION

See Also:

• Constant Field Values

ATTR_API

static final String ATTR_API

See Also:

• Constant Field Values

ATTR_API_DEPLOYED_AT

static final String ATTR_API_DEPLOYED_AT

See Also:

• Constant Field Values

ATTR_SUBSCRIPTION_ID

static final String ATTR_SUBSCRIPTION_ID

See Also:

• Constant Field Values

ATTR_PLAN

static final String ATTR_PLAN

See Also:

• Constant Field Values

ATTR_REQUEST_METHOD

static final String ATTR_REQUEST_METHOD

See Also:

• Constant Field Values

ATTR_REQUEST_ENDPOINT

static final String ATTR_REQUEST_ENDPOINT

See Also:

• Constant Field Values

ATTR_INVOKER

static final String ATTR_INVOKER

See Also:

• Constant Field Values

ATTR_QUOTA_COUNT

static final String ATTR_QUOTA_COUNT

See Also:

• Constant Field Values

ATTR_QUOTA_REMAINING

static final String ATTR_QUOTA_REMAINING

See Also:

• Constant Field Values

ATTR_QUOTA_LIMIT

static final String ATTR_QUOTA_LIMIT

See Also:

• Constant Field Values

ATTR_QUOTA_RESET_TIME

static final String ATTR_QUOTA_RESET_TIME

See Also:

• Constant Field Values

ATTR_USER

static final String ATTR_USER

See Also:

• Constant Field Values

ATTR_USER_ROLES

static final String ATTR_USER_ROLES

See Also:

• Constant Field Values

ATTR_ORGANIZATION

static final String ATTR_ORGANIZATION

See Also:

• Constant Field Values

ATTR_ENVIRONMENT

static final String ATTR_ENVIRONMENT

See Also:

• Constant Field Values

ATTR_FAILURE_ATTRIBUTE

static final String ATTR_FAILURE_ATTRIBUTE

See Also:

• Constant Field Values

ATTR_CLIENT_IDENTIFIER

static final String ATTR_CLIENT_IDENTIFIER

See Also:

• Constant Field Values

ATTR_SECURITY_SKIP

static final String ATTR_SECURITY_SKIP

Skip security chain isn't prefixed to avoid breaking code where this constant isn't used.

See Also:

• Constant Field Values

ATTR_INVOKER_SKIP

static final String ATTR_INVOKER_SKIP

See Also:

• Constant Field Values

ATTR_VALIDATE_SUBSCRIPTION

static final String ATTR_VALIDATE_SUBSCRIPTION

See Also:

• Constant Field Values

ATTR_MAPPED_PATH

static final String ATTR_MAPPED_PATH

See Also:

• Constant Field Values

Method Details

request

Request request()

response

Response response()

getComponent

<T> T getComponent(Class<T> componentClass)

setAttribute

void setAttribute(String name,
 Object value)

Stores an attribute in this request. Attributes are reset between requests.

Parameters:

name - a String specifying the name of the attribute

value - the Object to be stored

removeAttribute

void removeAttribute(String name)

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

Parameters:

name - a String specifying the name of the attribute to remove

getAttribute

Object getAttribute(String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

Enumeration<String> getAttributeNames()

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Returns:

an Enumeration of strings containing the names of the request's attributes

getAttributes

Map<String,Object> getAttributes()

getTemplateEngine

io.gravitee.el.TemplateEngine getTemplateEngine()

getTracer

Tracer getTracer()