com.yahoo.elide.core

Class RequestScope

java.lang.Object

com.yahoo.elide.core.RequestScope

All Implemented Interfaces:

RequestScope

Direct Known Subclasses:

PatchRequestScope

public class RequestScope
extends Object
implements RequestScope

Request scope object for relaying request-related data to various subsystems.

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityDictionary	dictionary

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestScope(String path, String apiVersion, JsonApiDocument jsonApiDocument, RequestScope outerRequestScope) Special copy constructor for use by PatchRequestScope.
	RequestScope(String baseUrlEndPoint, String path, String apiVersion, JsonApiDocument jsonApiDocument, DataStoreTransaction transaction, User user, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Map<String,List<String>> requestHeaders, UUID requestId, ElideSettings elideSettings) Create a new RequestScope with specified update status code.

Method Summary

Modifier and Type	Method and Description
Optional<FilterExpression>	getExpressionForRelation(Type<?> parentType, String relationName) Get the filter expression for a particular relationship.
Optional<FilterExpression>	getFilterExpressionByType(String type) Get filter expression for a specific collection type.
Optional<FilterExpression>	getFilterExpressionByType(Type<?> entityClass) Get filter expression for a specific collection type.
Optional<FilterExpression>	getLoadFilterExpression(Type<?> loadClass) Get the global/cross-type filter expression.
Set<PersistentResource>	getNewResources()
Object	getObjectById(Type<?> type, String id)
String	getRequestHeaderByName(String headerName)
String	getUUIDFor(Object o)
boolean	isNewResource(Object entity)
static Map<String,Set<String>>	parseSparseFields(javax.ws.rs.core.MultivaluedMap<String,String> queryParams) Parses queryParams and produces sparseFields map.
protected void	publishLifecycleEvent(PersistentResource<?> resource, LifeCycleHookBinding.Operation crudAction) Publishes a lifecycle event to all listeners.
protected void	publishLifecycleEvent(PersistentResource<?> resource, String fieldName, LifeCycleHookBinding.Operation crudAction, Optional<ChangeSpec> changeSpec) Publishes a lifecycle event to all listeners.
void	runQueuedPostCommitTriggers() Run queued post-commit lifecycle triggers.
void	runQueuedPreCommitTriggers() Run queued pre-commit lifecycle triggers.
void	runQueuedPreSecurityTriggers() Run queued pre-security lifecycle triggers.
void	saveOrCreateObjects()
void	setUUIDForObject(Type<?> type, String id, Object object)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.elide.core.security.RequestScope

getApiVersion, getBaseUrlEndPoint, getQueryParams, getUser

Field Detail

dictionary

protected final EntityDictionary dictionary

Constructor Detail

RequestScope

public RequestScope(String baseUrlEndPoint,
                    String path,
                    String apiVersion,
                    JsonApiDocument jsonApiDocument,
                    DataStoreTransaction transaction,
                    User user,
                    javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                    Map<String,List<String>> requestHeaders,
                    UUID requestId,
                    ElideSettings elideSettings)

Create a new RequestScope with specified update status code.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the URL path

apiVersion - the API version.

jsonApiDocument - the document for this request

transaction - the transaction for this request

user - the user making this request

queryParams - the query parameters

requestHeaders - the requestHeaders

elideSettings - Elide settings object

RequestScope

protected RequestScope(String path,
                       String apiVersion,
                       JsonApiDocument jsonApiDocument,
                       RequestScope outerRequestScope)

Special copy constructor for use by PatchRequestScope.

Parameters:

path - the URL path

apiVersion - the API version

jsonApiDocument - the json api document

outerRequestScope - the outer request scope

Method Detail

getNewResources

public Set<PersistentResource> getNewResources()

isNewResource

public boolean isNewResource(Object entity)

parseSparseFields

public static Map<String,Set<String>> parseSparseFields(javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

Parses queryParams and produces sparseFields map.

Parameters:

queryParams - The request query parameters

Returns:

Parsed sparseFields map

getFilterExpressionByType

public Optional<FilterExpression> getFilterExpressionByType(String type)

Get filter expression for a specific collection type.

Parameters:

type - The name of the type

Returns:

The filter expression for the given type

getFilterExpressionByType

public Optional<FilterExpression> getFilterExpressionByType(Type<?> entityClass)

Get filter expression for a specific collection type.

Parameters:

entityClass - The class to lookup

Returns:

The filter expression for the given type

getLoadFilterExpression

public Optional<FilterExpression> getLoadFilterExpression(Type<?> loadClass)

Get the global/cross-type filter expression.

Parameters:

loadClass - Entity class

Returns:

The global filter expression evaluated at the first load

getExpressionForRelation

public Optional<FilterExpression> getExpressionForRelation(Type<?> parentType,
                                                           String relationName)

Get the filter expression for a particular relationship.

Parameters:

parentType - The parent type which has the relationship

relationName - The relationship name

Returns:

A type specific filter expression for the given relationship

runQueuedPreSecurityTriggers

public void runQueuedPreSecurityTriggers()

Run queued pre-security lifecycle triggers.

runQueuedPreCommitTriggers

public void runQueuedPreCommitTriggers()

Run queued pre-commit lifecycle triggers.

runQueuedPostCommitTriggers

public void runQueuedPostCommitTriggers()

Run queued post-commit lifecycle triggers.

publishLifecycleEvent

protected void publishLifecycleEvent(PersistentResource<?> resource,
                                     LifeCycleHookBinding.Operation crudAction)

Publishes a lifecycle event to all listeners.

Parameters:

resource - Resource on which to execute trigger

crudAction - CRUD action

publishLifecycleEvent

protected void publishLifecycleEvent(PersistentResource<?> resource,
                                     String fieldName,
                                     LifeCycleHookBinding.Operation crudAction,
                                     Optional<ChangeSpec> changeSpec)

Publishes a lifecycle event to all listeners.

Parameters:

resource - Resource on which to execute trigger

fieldName - Field name for which to specify trigger

crudAction - CRUD Action

changeSpec - Optional ChangeSpec to pass to the lifecycle hook

saveOrCreateObjects

public void saveOrCreateObjects()

getUUIDFor

public String getUUIDFor(Object o)

getObjectById

public Object getObjectById(Type<?> type,
                            String id)

setUUIDForObject

public void setUUIDForObject(Type<?> type,
                             String id,
                             Object object)

getRequestHeaderByName

public String getRequestHeaderByName(String headerName)

Specified by:

getRequestHeaderByName in interface RequestScope