com.yahoo.bard.webservice.web.endpoints

Class DimensionCacheLoaderServlet

java.lang.Object

com.yahoo.bard.webservice.web.endpoints.DimensionCacheLoaderServlet

@Path(value="cache")
 @Singleton
public class DimensionCacheLoaderServlet
extends Object

Web service endpoint to update the Dimension rows and dimension lastUpdated field.

Constructor Summary

Constructors

Constructor and Description
DimensionCacheLoaderServlet(DimensionDictionary dimensionDictionary, DataCache<?> dataCache, ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addReplaceDimensionRows(String dimensionName, String json) Endpoint to add/replace dimension rows.
javax.ws.rs.core.Response	addUpdateDimensionRows(String dimensionName, String json) Endpoint to add/update dimension rows, with update semantics.
javax.ws.rs.core.Response	deleteDataCache() clears cache.
javax.ws.rs.core.Response	getDimensionLastUpdated(String dimensionName) Get the lastUpdated date for a particular dimension.
javax.ws.rs.core.Response	getMsg() Get the status of the cache.
javax.ws.rs.core.Response	updateDimensionLastUpdated(String json) Endpoint to update cache status.
javax.ws.rs.core.Response	updateDimensionLastUpdated(String dimensionName, String json) Endpoint to update a dimensions lastUpdated field.

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionCacheLoaderServlet

@Inject
public DimensionCacheLoaderServlet(DimensionDictionary dimensionDictionary,
                                           @NotNull
                                           DataCache<?> dataCache,
                                           ObjectMappersSuite objectMappers)

Constructor.

Parameters:

dimensionDictionary - Set of dimensions to be aware of

dataCache - A cache that we can clear if told to

objectMappers - Shares mappers for dealing with JSON

Method Detail

updateDimensionLastUpdated

@POST
 @Timed
 @Path(value="/dimensions/{dimensionName}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateDimensionLastUpdated(@PathParam(value="dimensionName")
                                                                                                                                                           String dimensionName,
                                                                                                                                                           String json)

Endpoint to update a dimensions lastUpdated field.

Parameters:

dimensionName - name of the dimension whose lastUpdated is to be modified. (path parameter)

json - post data json containing the lastUpdated datetime. Expected JSON string:

 {
     "name":" <dimensionName>",
     "lastUpdated":" <ISO_8601_datetime_string>"
 }
 

Returns:

OK(200) if successfully updated else Bad Request(400)

getDimensionLastUpdated

@GET
 @Timed
 @Path(value="/dimensions/{dimensionName}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getDimensionLastUpdated(@PathParam(value="dimensionName")
                                                                                                                                                       String dimensionName)

Get the lastUpdated date for a particular dimension.

Parameters:

dimensionName - Name of the dimension to get the last updated date for.

Returns:

Response Format:

 {
     "name":" <dimensionName>",
     "lastUpdated":" <ISO_8601_datetime_string>"
 }
 

addReplaceDimensionRows

@POST
 @Timed
 @Path(value="/dimensions/{dimensionName}/dimensionRows")
 @Consumes(value="application/json; charset=utf-8")
public javax.ws.rs.core.Response addReplaceDimensionRows(@PathParam(value="dimensionName")
                                                                                                                                                                                     String dimensionName,
                                                                                                                                                                                     String json)

Endpoint to add/replace dimension rows.

If a row having the same ID already exists, it will be overwritten.

Parameters:

dimensionName - name of the dimension whose dimension rows are to be modified. (path parameter)

json - post data json containing a list of json objects which describe dimension rows

 {
     "dimensionRows": [
         { "id":"usa", "description":"United_States_of_America" },
         { "id":"can", "description":"Canada" }
     ]
 }
 

Returns:

OK(200) if successfully added/replaced else Bad Request(400)

addUpdateDimensionRows

@Timed
 @Path(value="/dimensions/{dimensionName}/dimensionRows")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addUpdateDimensionRows(@PathParam(value="dimensionName")
                                                                                                                                                              String dimensionName,
                                                                                                                                                              String json)

Endpoint to add/update dimension rows, with update semantics.

If (by ID) a given row doesn't exist, this acts like POST above. If (by ID) a given row *does* exist, this will perform a merge of the new row into the old row. Given the two existing rows

 {
     "dimensionRows": [
         { "id":"usa", "description":"States_United_of_America", "population":"320", "gdp":"" },
         { "id":"can", "description":"Canada", "population":"35", "gdp":"" }
     ]
 }
 

a PATCH with

 {
     "dimensionRows": [
         { "id":"usa", "description":"United_States_of_America", "gdp":"16.77" },
         { "id":"can", "description":"Canada", "gdp":"1.83" },
         { "id":"uk", "description":"United Kingdom", "gdp":"2.68" }
     ]
 }
 

will result in

 {
     "dimensionRows": [
         { "id":"usa", "description":"United_States_of_America", "population":"320", "gdp":"16.77" },
         { "id":"can", "description":"Canada", "population":"35", "gdp":"1.83" },
         { "id":"uk", "description":"United Kingdom", "population":"", "gdp":"2.68" }
     ]
 }
 

Notice that the population field is not touched, that description and gdp are both updated, and that United Kingom is added (with an empty population).

Parameters:

dimensionName - name of the dimension whose dimension rows are to be modified. (path parameter)

json - post data json containing a list of json objects which describe dimension rows

 {
     "dimensionRows": [
         { "id":"usa", "description":"United_States_of_America" },
         { "id":"can", "description":"Canada" }
     ]
 }
 

Returns:

OK(200) if successfully added/updated else Bad Request(400)

updateDimensionLastUpdated

@PUT
 @Timed
 @Path(value="/cacheStatus")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateDimensionLastUpdated(String json)

Endpoint to update cache status.

Parameters:

json - post data json containing the lastUpdated datetime.

Expected JSON string:

     {"lastUpdated":" <ISO_8601_datetime_string>"}
 
 

Returns:

OK(200) if successfully updated else Bad Request(400)

getMsg

@GET
 @Timed
 @Path(value="/cacheStatus")
public javax.ws.rs.core.Response getMsg()

Get the status of the cache.

Returns:

the cache status message as a Response

deleteDataCache

@DELETE
 @Timed
 @Path(value="/data")
public javax.ws.rs.core.Response deleteDataCache()

clears cache.

curl -X DELETE "http://localhost:4080/v1/cache/data"

Returns:

OK