AbstractResource (EHRI Backend 0.13.10 API)

java.lang.Object
- eu.ehri.extension.base.AbstractResource

All Implemented Interfaces:

TxCheckedResource

Direct Known Subclasses:

AbstractAccessibleResource, AdminResource, BatchResource, ImportResource, OaiPmhResource, PermissionGrantResource, PermissionsResource, ToolsResource
```
public abstract class AbstractResource
extends Object
implements TxCheckedResource
```
Base class for web service resources.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESSOR_PARAM`
`static String`	`ALL_PARAM`
`static String`	`AUTH_HEADER_NAME`
`static String`	`COMMIT_PARAM`
`static String`	`CSV_MEDIA_TYPE`
`static int`	`DEFAULT_LIST_LIMIT`
`static String`	`FILTER_PARAM`
`protected com.tinkerpop.frames.FramedGraph<? extends TxGraph>`	`graph`
`static String`	`GROUP_PARAM`
`static String`	`ID_PARAM`
`static String`	`INCLUDE_PROPS_PARAM` Serialization config parameters.
`static int`	`ITEM_CACHE_TIME`
`protected static com.fasterxml.jackson.core.JsonFactory`	`jsonFactory`
`protected static com.fasterxml.jackson.databind.ObjectMapper`	`jsonMapper`
`static String`	`LIMIT_PARAM`
`static String`	`LOG_MESSAGE_HEADER_NAME`
`static String`	`LOG_PARAM`
`protected static org.slf4j.Logger`	`logger`
`protected GraphManager`	`manager`
`static String`	`N3_MIMETYPE`
`static String`	`OFFSET_PARAM`
`static String`	`PATCH_HEADER_NAME`
`static String`	`RANGE_HEADER_NAME` Header names
`protected com.google.common.collect.BiMap<String,String>`	`RDF_MIMETYPE_FORMATS`
`static String`	`RDF_XML_MIMETYPE`
`protected javax.ws.rs.core.Request`	`request`
`protected javax.ws.rs.core.HttpHeaders`	`requestHeaders` With each request the headers of that request are injected into the requestHeaders parameter.
`static String`	`RESOURCE_ENDPOINT_PREFIX`
`static String`	`SCOPE_PARAM`
`static String`	`SORT_PARAM` Query arguments.
`static String`	`STREAM_HEADER_NAME`
`static String`	`TOLERANT_PARAM`
`static String`	`TURTLE_MIMETYPE` RDF Mimetypes and formatting mappings
`protected javax.ws.rs.core.UriInfo`	`uriInfo` With each request URI info is injected into the uriInfo parameter.
`static String`	`VERSION_PARAM`

Constructor Summary

Constructors
Constructor and Description

AbstractResource(org.neo4j.graphdb.GraphDatabaseService database)
Constructer.

Constructors
Constructor and Description
`AbstractResource(org.neo4j.graphdb.GraphDatabaseService database)` Constructer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Api`	`anonymousApi()` Fetch an instance of the API for anonymous access.
`protected Api`	`api()` Fetch an instance of the API with the current user.
`protected Tx`	`beginTx()` Open a transaction on the graph.
`protected javax.ws.rs.core.Response`	`creationResponse(Entity frame)` Return a response from a new item with a 201 CREATED status.
`protected <T extends Entity> javax.ws.rs.core.CacheControl`	`getCacheControl(T item)` Get a cache control header based on the access restrictions set on the item.
`protected Actioner`	`getCurrentActioner()` Retrieve the current actioner, which may be a user or a group, throwing a bad request if it's invalid.
`protected UserProfile`	`getCurrentUser()` Retrieve the profile of the current user, throwing a BadRequest if it's invalid or not a user.
`com.tinkerpop.frames.FramedGraph<? extends TxGraph>`	`getGraph()` Fetch the graph associated with the resource.
`protected int`	`getIntQueryParam(String key, int defaultValue)` Get an integer value for a given query parameter, falling back on a default.
`protected URI`	`getItemUri(Entity item)` Get the URI for a given item.
`protected Optional<String>`	`getLogMessage()` Retrieve an action log message from the request header.
`protected QueryApi`	`getQuery()` Get a query object configured according to incoming parameters.
`protected String`	`getRdfFormat(String format, String defaultFormat)` Get an RDF format for content-negotiation form
`protected Accessor`	`getRequesterUserProfile()` Retrieve the account of the current user, who may be anonymous.
`protected Serializer`	`getSerializer()` Get a serializer according to passed-in serialization config.
`protected List<String>`	`getStringListQueryParam(String key)` Get a list of values for a given query parameter key.
`protected Boolean`	`isPatch()` Determine if a PATCH header is present.
`protected boolean`	`isStreaming()` Determine if the X-Stream header is present.
`protected <T extends Entity> javax.ws.rs.core.Response`	`single(T item)` Return a default response from a single frame item.
`protected <T extends Entity> javax.ws.rs.core.Response`	`streamingList(Supplier<Iterable<T>> list)` Return a streaming response from an iterable.
`protected <T extends Entity> javax.ws.rs.core.Response`	`streamingList(Supplier<Iterable<T>> list, Serializer serializer)` Return a streaming response from an iterable, using the given entity converter.
`protected <T extends Entity> javax.ws.rs.core.Response`	`streamingListOfLists(Supplier<Iterable<? extends Collection<T>>> lists)` Return a streaming response from an iterable of item lists.
`protected <T extends Entity> javax.ws.rs.core.Response`	`streamingPage(Supplier<QueryApi.Page<T>> page)` Stream a single page with total, limit, and offset info.
`protected <T extends Entity> javax.ws.rs.core.Response`	`streamingPage(Supplier<QueryApi.Page<T>> page, Serializer serializer)` Stream a single page with total, limit, and offset info, using the given entity converter.
`protected javax.ws.rs.core.Response`	`streamingVertexList(Supplier<Iterable<com.tinkerpop.blueprints.Vertex>> vertices)` Stream an iterable of vertices.
`protected javax.ws.rs.core.Response`	`streamingVertexList(Supplier<Iterable<com.tinkerpop.blueprints.Vertex>> vertices, Serializer serializer)` Stream an iterable of vertices.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LIST_LIMIT
```
public static final int DEFAULT_LIST_LIMIT
```
    See Also:
    
    Constant Field Values
  - ITEM_CACHE_TIME
```
public static final int ITEM_CACHE_TIME
```
    See Also:
    
    Constant Field Values
  - RESOURCE_ENDPOINT_PREFIX
```
public static final String RESOURCE_ENDPOINT_PREFIX
```
    See Also:
    
    Constant Field Values
  - jsonMapper
```
protected static final com.fasterxml.jackson.databind.ObjectMapper jsonMapper
```
  - jsonFactory
```
protected static final com.fasterxml.jackson.core.JsonFactory jsonFactory
```
  - logger
```
protected static final org.slf4j.Logger logger
```
  - CSV_MEDIA_TYPE
```
public static final String CSV_MEDIA_TYPE
```
    See Also:
    
    Constant Field Values
  - TURTLE_MIMETYPE
```
public static final String TURTLE_MIMETYPE
```
    RDF Mimetypes and formatting mappings
    
    See Also:
    
    Constant Field Values
  - RDF_XML_MIMETYPE
```
public static final String RDF_XML_MIMETYPE
```
    See Also:
    
    Constant Field Values
  - N3_MIMETYPE
```
public static final String N3_MIMETYPE
```
    See Also:
    
    Constant Field Values
  - RDF_MIMETYPE_FORMATS
```
protected final com.google.common.collect.BiMap<String,String> RDF_MIMETYPE_FORMATS
```
  - SORT_PARAM
```
public static final String SORT_PARAM
```
    Query arguments.
    
    See Also:
    
    Constant Field Values
  - FILTER_PARAM
```
public static final String FILTER_PARAM
```
    See Also:
    
    Constant Field Values
  - LIMIT_PARAM
```
public static final String LIMIT_PARAM
```
    See Also:
    
    Constant Field Values
  - OFFSET_PARAM
```
public static final String OFFSET_PARAM
```
    See Also:
    
    Constant Field Values
  - ACCESSOR_PARAM
```
public static final String ACCESSOR_PARAM
```
    See Also:
    
    Constant Field Values
  - GROUP_PARAM
```
public static final String GROUP_PARAM
```
    See Also:
    
    Constant Field Values
  - ALL_PARAM
```
public static final String ALL_PARAM
```
    See Also:
    
    Constant Field Values
  - ID_PARAM
```
public static final String ID_PARAM
```
    See Also:
    
    Constant Field Values
  - LOG_PARAM
```
public static final String LOG_PARAM
```
    See Also:
    
    Constant Field Values
  - VERSION_PARAM
```
public static final String VERSION_PARAM
```
    See Also:
    
    Constant Field Values
  - SCOPE_PARAM
```
public static final String SCOPE_PARAM
```
    See Also:
    
    Constant Field Values
  - TOLERANT_PARAM
```
public static final String TOLERANT_PARAM
```
    See Also:
    
    Constant Field Values
  - COMMIT_PARAM
```
public static final String COMMIT_PARAM
```
    See Also:
    
    Constant Field Values
  - INCLUDE_PROPS_PARAM
```
public static final String INCLUDE_PROPS_PARAM
```
    Serialization config parameters.
    
    See Also:
    
    Constant Field Values
  - RANGE_HEADER_NAME
```
public static final String RANGE_HEADER_NAME
```
    Header names
    
    See Also:
    
    Constant Field Values
  - PATCH_HEADER_NAME
```
public static final String PATCH_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - AUTH_HEADER_NAME
```
public static final String AUTH_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - LOG_MESSAGE_HEADER_NAME
```
public static final String LOG_MESSAGE_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - STREAM_HEADER_NAME
```
public static final String STREAM_HEADER_NAME
```
    See Also:
    
    Constant Field Values
  - requestHeaders
```
@Context
protected javax.ws.rs.core.HttpHeaders requestHeaders
```
    With each request the headers of that request are injected into the requestHeaders parameter.
  - request
```
@Context
protected javax.ws.rs.core.Request request
```
  - uriInfo
```
@Context
protected javax.ws.rs.core.UriInfo uriInfo
```
    With each request URI info is injected into the uriInfo parameter.
  - graph
```
protected final com.tinkerpop.frames.FramedGraph<? extends TxGraph> graph
```
  - manager
```
protected final GraphManager manager
```
- Constructor Detail
  - AbstractResource
```
public AbstractResource(@Context
                        org.neo4j.graphdb.GraphDatabaseService database)
```
    Constructer.
    
    Parameters:
    
    database - A Neo4j graph database
- Method Detail
  - getGraph
```
public com.tinkerpop.frames.FramedGraph<? extends TxGraph> getGraph()
```
    Description copied from interface: TxCheckedResource
    
    Fetch the graph associated with the resource.
    
    Specified by:
    
    getGraph in interface TxCheckedResource
    
    Returns:
    
    a transactional graph database.
  - beginTx
```
protected Tx beginTx()
```
    Open a transaction on the graph.
    
    Returns:
    
    the transaction object
  - getSerializer
```
protected Serializer getSerializer()
```
    Get a serializer according to passed-in serialization config.
    Currently the only parameter is _ip=[propertyName] which ensures a given property is always included in the output.
    
    Returns:
    
    a vertex serializer
  - getStringListQueryParam
```
protected List<String> getStringListQueryParam(String key)
```
    Get a list of values for a given query parameter key.
    
    Parameters:
    
    key - the parameter name
    
    Returns:
    
    a list of string values
  - getIntQueryParam
```
protected int getIntQueryParam(String key,
                               int defaultValue)
```
    Get an integer value for a given query parameter, falling back on a default.
    
    Parameters:
    
    key - the parameter name
    
    defaultValue - the default value
    
    Returns:
    
    an integer value
  - getQuery
```
protected QueryApi getQuery()
```
    Get a query object configured according to incoming parameters.
    
    Returns:
    
    a query object
  - getRequesterUserProfile
```
protected Accessor getRequesterUserProfile()
```
    Retrieve the account of the current user, who may be anonymous.
    
    Returns:
    
    The UserProfile
  - api
```
protected Api api()
```
    Fetch an instance of the API with the current user.
    
    Returns:
    
    an Api instance
  - anonymousApi
```
protected Api anonymousApi()
```
    Fetch an instance of the API for anonymous access.
    
    Returns:
    
    an Api instance
  - getCurrentUser
```
protected UserProfile getCurrentUser()
```
    Retrieve the profile of the current user, throwing a BadRequest if it's invalid or not a user.
    
    Returns:
    
    the current user profile
  - getCurrentActioner
```
protected Actioner getCurrentActioner()
```
    Retrieve the current actioner, which may be a user or a group, throwing a bad request if it's invalid.
    
    Returns:
    
    an actioner frame
  - getLogMessage
```
protected Optional<String> getLogMessage()
```
    Retrieve an action log message from the request header.
    
    Returns:
    
    An optional log message
  - isPatch
```
protected Boolean isPatch()
```
    Determine if a PATCH header is present. Ideally, Jersey would support the HTTP PATCH method, but it doesn't so we have to user a header.
    
    Returns:
    
    Patch is given
  - isStreaming
```
protected boolean isStreaming()
```
    Determine if the X-Stream header is present. This changes the semantics of paged results so that no full count is fetched (making it more efficient.)
    
    Returns:
    
    Patch is given
  - single
```
protected <T extends Entity> javax.ws.rs.core.Response single(T item)
```
    Return a default response from a single frame item.
    
    Type Parameters:
    
    T - the item's generic type
    
    Parameters:
    
    item - the item
    
    Returns:
    
    a serialized representation, with location and cache control headers.
  - streamingPage
```
protected <T extends Entity> javax.ws.rs.core.Response streamingPage(Supplier<QueryApi.Page<T>> page)
```
    Stream a single page with total, limit, and offset info.
    
    Parameters:
    
    page - A page of data
    
    Returns:
    
    A streaming response
  - streamingPage
```
protected <T extends Entity> javax.ws.rs.core.Response streamingPage(Supplier<QueryApi.Page<T>> page,
                                                                     Serializer serializer)
```
    Stream a single page with total, limit, and offset info, using the given entity converter.
    
    Parameters:
    
    page - a page of data
    
    serializer - a custom serializer instance
    
    Returns:
    
    A streaming response
  - streamingVertexList
```
protected javax.ws.rs.core.Response streamingVertexList(Supplier<Iterable<com.tinkerpop.blueprints.Vertex>> vertices)
```
    Stream an iterable of vertices.
    
    Parameters:
    
    vertices - an iterable of vertices
    
    Returns:
    
    a streaming response
  - streamingVertexList
```
protected javax.ws.rs.core.Response streamingVertexList(Supplier<Iterable<com.tinkerpop.blueprints.Vertex>> vertices,
                                                        Serializer serializer)
```
    Stream an iterable of vertices.
    
    Parameters:
    
    vertices - an iterable of vertices
    
    serializer - a serializer instance
    
    Returns:
    
    a streaming response
  - streamingList
```
protected <T extends Entity> javax.ws.rs.core.Response streamingList(Supplier<Iterable<T>> list)
```
    Return a streaming response from an iterable.
    
    Parameters:
    
    list - A list of framed items
    
    Returns:
    
    A streaming response
  - streamingListOfLists
```
protected <T extends Entity> javax.ws.rs.core.Response streamingListOfLists(Supplier<Iterable<? extends Collection<T>>> lists)
```
    Return a streaming response from an iterable of item lists.
    
    Parameters:
    
    lists - an iterable of item groups
    
    Returns:
    
    a streaming response
  - streamingList
```
protected <T extends Entity> javax.ws.rs.core.Response streamingList(Supplier<Iterable<T>> list,
                                                                     Serializer serializer)
```
    Return a streaming response from an iterable, using the given entity converter.
    
    Parameters:
    
    list - A list of framed items
    
    Returns:
    
    A streaming response
  - getItemUri
```
protected URI getItemUri(Entity item)
```
    Get the URI for a given item.
    
    Parameters:
    
    item - The item
    
    Returns:
    
    The resource URI for that item.
  - creationResponse
```
protected javax.ws.rs.core.Response creationResponse(Entity frame)
```
    Return a response from a new item with a 201 CREATED status.
    
    Parameters:
    
    frame - A newly-created item
    
    Returns:
    
    a 201 response with the new item's location set
  - getCacheControl
```
protected <T extends Entity> javax.ws.rs.core.CacheControl getCacheControl(T item)
```
    Get a cache control header based on the access restrictions set on the item. If it is restricted, instruct clients not to cache the response.
    
    Parameters:
    
    item - The item
    
    Returns:
    
    A cache control object.
  - getRdfFormat
```
protected String getRdfFormat(String format,
                              String defaultFormat)
```
    Get an RDF format for content-negotiation form
    
    Parameters:
    
    format - a format string, possibly null
    
    defaultFormat - a default format
    
    Returns:
    
    an RDF format

Class AbstractResource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LIST_LIMIT

ITEM_CACHE_TIME

RESOURCE_ENDPOINT_PREFIX

jsonMapper

jsonFactory

logger

CSV_MEDIA_TYPE

TURTLE_MIMETYPE

RDF_XML_MIMETYPE

N3_MIMETYPE

RDF_MIMETYPE_FORMATS

SORT_PARAM

FILTER_PARAM

LIMIT_PARAM

OFFSET_PARAM

ACCESSOR_PARAM

GROUP_PARAM

ALL_PARAM

ID_PARAM

LOG_PARAM

VERSION_PARAM

SCOPE_PARAM

TOLERANT_PARAM

COMMIT_PARAM

INCLUDE_PROPS_PARAM

RANGE_HEADER_NAME

PATCH_HEADER_NAME

AUTH_HEADER_NAME

LOG_MESSAGE_HEADER_NAME

STREAM_HEADER_NAME

requestHeaders

request

uriInfo

graph

manager

Constructor Detail

AbstractResource

Method Detail

getGraph

beginTx

getSerializer

getStringListQueryParam

getIntQueryParam

getQuery

getRequesterUserProfile

api

anonymousApi

getCurrentUser

getCurrentActioner

getLogMessage

isPatch

isStreaming

single

streamingPage

streamingPage

streamingVertexList

streamingVertexList

streamingList

streamingListOfLists

streamingList

getItemUri

creationResponse

getCacheControl

getRdfFormat