com.yahoo.elide.jsonapi.resources

Class JsonApiEndpoint

java.lang.Object

com.yahoo.elide.jsonapi.resources.JsonApiEndpoint

@Singleton
 @Produces(value="application/vnd.api+json")
 @Path(value="/")
public class JsonApiEndpoint
extends Object

Default endpoint/servlet for using Elide and JSONAPI.

Field Summary

Fields

Modifier and Type	Field and Description
protected Elide	elide

Constructor Summary

Constructors

Constructor and Description
JsonApiEndpoint(Elide elide)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(String path, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.SecurityContext securityContext, String jsonApiDocument) Delete relationship handler (expects body with resource ids and types).
javax.ws.rs.core.Response	get(String path, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.SecurityContext securityContext) Read handler.
protected String	getBaseUrlEndpoint(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	patch(String contentType, String accept, String path, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.SecurityContext securityContext, String jsonapiDocument) Update handler.
javax.ws.rs.core.Response	post(String path, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.SecurityContext securityContext, String jsonapiDocument) Create handler.

Methods inherited from class java.lang.Object

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

Field Detail

elide

protected final Elide elide

Constructor Detail

JsonApiEndpoint

@Inject
public JsonApiEndpoint(@Named(value="elide")
                               Elide elide)

Method Detail

post

@POST
 @Path(value="{path:.*}")
 @Consumes(value="application/vnd.api+json")
public javax.ws.rs.core.Response post(@PathParam(value="path")
                                                                                                                   String path,
                                                                                                                   @Context
                                                                                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                   @Context
                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                   @Context
                                                                                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                                                                                   String jsonapiDocument)

Create handler.

Parameters:

path - request path

uriInfo - URI info

headers - the request headers

securityContext - security context

jsonapiDocument - post data as jsonapi document

Returns:

response

get

@GET
 @Path(value="{path:.*}")
public javax.ws.rs.core.Response get(@PathParam(value="path")
                                                                    String path,
                                                                    @Context
                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                    @Context
                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                    @Context
                                                                    javax.ws.rs.core.SecurityContext securityContext)

Read handler.

Parameters:

path - request path

uriInfo - URI info

headers - the request headers

securityContext - security context

Returns:

response

patch

@Path(value="{path:.*}")
 @Consumes(value="application/vnd.api+json")
public javax.ws.rs.core.Response patch(@HeaderParam(value="Content-Type")
                                                                                                             String contentType,
                                                                                                             @HeaderParam(value="accept")
                                                                                                             String accept,
                                                                                                             @PathParam(value="path")
                                                                                                             String path,
                                                                                                             @Context
                                                                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                                                                             @Context
                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                             @Context
                                                                                                             javax.ws.rs.core.SecurityContext securityContext,
                                                                                                             String jsonapiDocument)

Update handler.

Parameters:

contentType - document MIME type

accept - response MIME type

path - request path

uriInfo - URI info

headers - the request headers

securityContext - security context

jsonapiDocument - patch data as jsonapi document

Returns:

response

delete

@DELETE
 @Path(value="{path:.*}")
 @Consumes(value="application/vnd.api+json")
public javax.ws.rs.core.Response delete(@PathParam(value="path")
                                                                                                                       String path,
                                                                                                                       @Context
                                                                                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                       @Context
                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                       @Context
                                                                                                                       javax.ws.rs.core.SecurityContext securityContext,
                                                                                                                       String jsonApiDocument)

Delete relationship handler (expects body with resource ids and types).

Parameters:

path - request path

uriInfo - URI info

headers - the request headers

securityContext - security context

jsonApiDocument - DELETE document

Returns:

response

getBaseUrlEndpoint

protected String getBaseUrlEndpoint(javax.ws.rs.core.UriInfo uriInfo)