com.yahoo.elide

Class Elide

java.lang.Object

com.yahoo.elide.Elide

public class Elide
extends Object

REST Entry point handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Elide.Handler<DataStoreTransaction,User,HandlerResult> A function that sets up the request handling objects.
protected static class	Elide.HandlerResult A wrapper to return multiple values, less verbose than Pair.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSONAPI_CONTENT_TYPE
static String	JSONAPI_CONTENT_TYPE_WITH_JSON_PATCH_EXTENSION

Constructor Summary

Constructors

Constructor and Description
Elide(ElideSettings elideSettings) Instantiates a new Elide instance.

Method Summary

Modifier and Type	Method and Description
protected ElideResponse	buildErrorResponse(HttpStatusException error, boolean isVerbose)
protected ElideResponse	buildResponse(org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode> response)
ElideResponse	delete(String baseUrlEndPoint, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Map<String,List<String>> requestHeaders, User opaqueUser, String apiVersion, UUID requestId) Handle DELETE.
ElideResponse	delete(String baseUrlEndPoint, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, User opaqueUser, String apiVersion, UUID requestId) Handle DELETE.
ElideResponse	delete(String baseUrlEndPoint, String path, String jsonApiDocument, User opaqueUser, String apiVersion) Handle DELETE.
ElideResponse	get(String baseUrlEndPoint, String path, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Map<String,List<String>> requestHeaders, User opaqueUser, String apiVersion, UUID requestId) Handle GET.
ElideResponse	get(String baseUrlEndPoint, String path, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, User opaqueUser, String apiVersion) Handle GET.
ElideResponse	get(String baseUrlEndPoint, String path, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, User opaqueUser, String apiVersion, UUID requestId) Handle GET.
protected ElideResponse	handleRequest(boolean isReadOnly, User user, Supplier<DataStoreTransaction> transaction, UUID requestId, Elide.Handler<DataStoreTransaction,User,Elide.HandlerResult> handler) Handle JSON API requests.
ElideResponse	patch(String baseUrlEndPoint, String contentType, String accept, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Map<String,List<String>> requestHeaders, User opaqueUser, String apiVersion, UUID requestId) Handle PATCH.
ElideResponse	patch(String baseUrlEndPoint, String contentType, String accept, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, User opaqueUser, String apiVersion, UUID requestId) Handle PATCH.
ElideResponse	patch(String baseUrlEndPoint, String contentType, String accept, String path, String jsonApiDocument, User opaqueUser, String apiVersion) Handle PATCH.
ElideResponse	post(String baseUrlEndPoint, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, Map<String,List<String>> requestHeaders, User opaqueUser, String apiVersion, UUID requestId) Handle POST.
ElideResponse	post(String baseUrlEndPoint, String path, String jsonApiDocument, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, User opaqueUser, String apiVersion, UUID requestId) Handle POST.
ElideResponse	post(String baseUrlEndPoint, String path, String jsonApiDocument, User opaqueUser, String apiVersion) Handle POST.
protected void	registerCustomSerde()
protected void	registerCustomSerde(Class<?> type, Serde serde, String name)
protected void	registerCustomSerdeInObjectMapper(Class<?> type, Serde serde, String name)
protected Set<Class<?>>	registerCustomSerdeScan()
Elide.HandlerResult	visit(String path, RequestScope requestScope, BaseVisitor visitor)

Methods inherited from class java.lang.Object

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

Field Detail

JSONAPI_CONTENT_TYPE

public static final String JSONAPI_CONTENT_TYPE

See Also:

Constant Field Values

JSONAPI_CONTENT_TYPE_WITH_JSON_PATCH_EXTENSION

public static final String JSONAPI_CONTENT_TYPE_WITH_JSON_PATCH_EXTENSION

See Also:

Constant Field Values

Constructor Detail

Elide

public Elide(ElideSettings elideSettings)

Instantiates a new Elide instance.

Parameters:

elideSettings - Elide settings object

Method Detail

registerCustomSerde

protected void registerCustomSerde()

registerCustomSerde

protected void registerCustomSerde(Class<?> type,
                                   Serde serde,
                                   String name)

registerCustomSerdeInObjectMapper

protected void registerCustomSerdeInObjectMapper(Class<?> type,
                                                 Serde serde,
                                                 String name)

registerCustomSerdeScan

protected Set<Class<?>> registerCustomSerdeScan()

get

public ElideResponse get(String baseUrlEndPoint,
                         String path,
                         javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                         User opaqueUser,
                         String apiVersion)

Handle GET.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

queryParams - the query params

opaqueUser - the opaque user

apiVersion - the API version

Returns:

Elide response object

get

public ElideResponse get(String baseUrlEndPoint,
                         String path,
                         javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                         User opaqueUser,
                         String apiVersion,
                         UUID requestId)

Handle GET.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

queryParams - the query params

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

get

public ElideResponse get(String baseUrlEndPoint,
                         String path,
                         javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                         Map<String,List<String>> requestHeaders,
                         User opaqueUser,
                         String apiVersion,
                         UUID requestId)

Handle GET.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

queryParams - the query params

requestHeaders - the request headers

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

post

public ElideResponse post(String baseUrlEndPoint,
                          String path,
                          String jsonApiDocument,
                          User opaqueUser,
                          String apiVersion)

Handle POST.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

opaqueUser - the opaque user

apiVersion - the API version

Returns:

Elide response object

post

public ElideResponse post(String baseUrlEndPoint,
                          String path,
                          String jsonApiDocument,
                          javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                          User opaqueUser,
                          String apiVersion,
                          UUID requestId)

Handle POST.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

queryParams - the query params

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

post

public ElideResponse post(String baseUrlEndPoint,
                          String path,
                          String jsonApiDocument,
                          javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                          Map<String,List<String>> requestHeaders,
                          User opaqueUser,
                          String apiVersion,
                          UUID requestId)

Handle POST.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

queryParams - the query params

requestHeaders - the request headers

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

patch

public ElideResponse patch(String baseUrlEndPoint,
                           String contentType,
                           String accept,
                           String path,
                           String jsonApiDocument,
                           User opaqueUser,
                           String apiVersion)

Handle PATCH.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

contentType - the content type

accept - the accept

path - the path

jsonApiDocument - the json api document

opaqueUser - the opaque user

apiVersion - the API version

Returns:

Elide response object

patch

public ElideResponse patch(String baseUrlEndPoint,
                           String contentType,
                           String accept,
                           String path,
                           String jsonApiDocument,
                           javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                           User opaqueUser,
                           String apiVersion,
                           UUID requestId)

Handle PATCH.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

contentType - the content type

accept - the accept

path - the path

jsonApiDocument - the json api document

queryParams - the query params

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

patch

public ElideResponse patch(String baseUrlEndPoint,
                           String contentType,
                           String accept,
                           String path,
                           String jsonApiDocument,
                           javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                           Map<String,List<String>> requestHeaders,
                           User opaqueUser,
                           String apiVersion,
                           UUID requestId)

Handle PATCH.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

contentType - the content type

accept - the accept

path - the path

jsonApiDocument - the json api document

queryParams - the query params

requestHeaders - the request headers

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

delete

public ElideResponse delete(String baseUrlEndPoint,
                            String path,
                            String jsonApiDocument,
                            User opaqueUser,
                            String apiVersion)

Handle DELETE.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

opaqueUser - the opaque user

apiVersion - the API version

Returns:

Elide response object

delete

public ElideResponse delete(String baseUrlEndPoint,
                            String path,
                            String jsonApiDocument,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            User opaqueUser,
                            String apiVersion,
                            UUID requestId)

Handle DELETE.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

queryParams - the query params

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

delete

public ElideResponse delete(String baseUrlEndPoint,
                            String path,
                            String jsonApiDocument,
                            javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                            Map<String,List<String>> requestHeaders,
                            User opaqueUser,
                            String apiVersion,
                            UUID requestId)

Handle DELETE.

Parameters:

baseUrlEndPoint - base URL with prefix endpoint

path - the path

jsonApiDocument - the json api document

queryParams - the query params

requestHeaders - the request headers

opaqueUser - the opaque user

apiVersion - the API version

requestId - the request ID

Returns:

Elide response object

visit

public Elide.HandlerResult visit(String path,
                                 RequestScope requestScope,
                                 BaseVisitor visitor)

handleRequest

protected ElideResponse handleRequest(boolean isReadOnly,
                                      User user,
                                      Supplier<DataStoreTransaction> transaction,
                                      UUID requestId,
                                      Elide.Handler<DataStoreTransaction,User,Elide.HandlerResult> handler)

Handle JSON API requests.

Parameters:

isReadOnly - if the transaction is read only

user - the user object from the container

transaction - a transaction supplier

requestId - the Request ID

handler - a function that creates the request scope and request handler

Returns:

the response

buildErrorResponse

protected ElideResponse buildErrorResponse(HttpStatusException error,
                                           boolean isVerbose)

buildResponse

protected ElideResponse buildResponse(org.apache.commons.lang3.tuple.Pair<Integer,com.fasterxml.jackson.databind.JsonNode> response)