com.yahoo.elide.jsonapi.parser.state

Class BaseState

java.lang.Object

com.yahoo.elide.jsonapi.parser.state.BaseState

Direct Known Subclasses:

CollectionTerminalState, RecordState, RecordTerminalState, RelationshipTerminalState, StartState

public abstract class BaseState
extends Object

Base class for state information.

Constructor Summary

Constructors

Constructor and Description
BaseState()

Method Summary

Modifier and Type	Method and Description
protected static Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>>	constructPatchResponse(PersistentResource record, StateContext stateContext) Construct PATCH response.
protected static com.fasterxml.jackson.databind.JsonNode	getResponseBody(PersistentResource resource, RequestScope requestScope)
void	handle(StateContext state, CoreParser.RootCollectionLoadEntitiesContext ctx) Handle void.
void	handle(StateContext state, CoreParser.RootCollectionLoadEntityContext ctx) Handle void.
void	handle(StateContext state, CoreParser.RootCollectionRelationshipContext ctx) Handle void.
void	handle(StateContext state, CoreParser.RootCollectionSubCollectionContext ctx) Handle void.
void	handle(StateContext state, CoreParser.SubCollectionReadCollectionContext ctx) Handle void.
void	handle(StateContext state, CoreParser.SubCollectionReadEntityContext ctx) Handle void.
void	handle(StateContext state, CoreParser.SubCollectionRelationshipContext ctx) Handle void.
void	handle(StateContext state, CoreParser.SubCollectionSubCollectionContext ctx) Handle void.
Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>>	handleDelete(StateContext state) Handle delete.
Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>>	handleGet(StateContext state) We return a Function because we may have to perform post-commit operations.
Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>>	handlePatch(StateContext state) Handle patch.
Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>>	handlePost(StateContext state) Handle post.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseState

public BaseState()

Method Detail

handle

public void handle(StateContext state,
                   CoreParser.RootCollectionLoadEntitiesContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.RootCollectionLoadEntityContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.RootCollectionSubCollectionContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.RootCollectionRelationshipContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.SubCollectionReadCollectionContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.SubCollectionReadEntityContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.SubCollectionSubCollectionContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handle

public void handle(StateContext state,
                   CoreParser.SubCollectionRelationshipContext ctx)

Handle void.

Parameters:

state - the state

ctx - the ctx

handleGet

public Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>> handleGet(StateContext state)
                                                                                                         throws HttpStatusException

We return a Function because we may have to perform post-commit operations. That is, we may need to perform extra operations after having closed a transaction. As a result, this method is invoked after committing a transaction in Elide.java.

Parameters:

state - the state

Returns:

the supplier

Throws:

HttpStatusException - the http status exception

handlePatch

public Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>> handlePatch(StateContext state)
                                                                                                           throws HttpStatusException

Handle patch.

Parameters:

state - the state

Returns:

the supplier

Throws:

HttpStatusException - the http status exception

handlePost

public Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>> handlePost(StateContext state)
                                                                                                          throws HttpStatusException

Handle post.

Parameters:

state - the state

Returns:

the supplier

Throws:

HttpStatusException - the http status exception

handleDelete

public Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>> handleDelete(StateContext state)
                                                                                                            throws HttpStatusException

Handle delete.

Parameters:

state - the state

Returns:

the supplier

Throws:

HttpStatusException - the http status exception

constructPatchResponse

protected static Supplier<org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode>> constructPatchResponse(PersistentResource record,
                                                                                                                                       StateContext stateContext)

Construct PATCH response.

Parameters:

record - a resource that has been updated

stateContext - a state that contains reference to request scope where we can get status code for update

Returns:

a supplier of PATH response

getResponseBody

protected static com.fasterxml.jackson.databind.JsonNode getResponseBody(PersistentResource resource,
                                                                         RequestScope requestScope)