org.apache.lens.server.query.save

Class SavedQueryResource

java.lang.Object

org.apache.lens.server.query.save.SavedQueryResource

@Path(value="/queryapi")
 @Produces(value={"application/xml","application/json"})
public class SavedQueryResource
extends Object

Constructor Summary

Constructors

Constructor and Description
SavedQueryResource()

Method Summary

Modifier and Type	Method and Description
ResourceModifiedResponse	create(LensSessionHandle sessionid, SavedQuery savedQuery, org.glassfish.grizzly.http.server.Response response) Creates a new saved query.
ResourceModifiedResponse	deleteById(LensSessionHandle sessionid, long id) Deletes the saved query with the given id.
SavedQuery	getByID(LensSessionHandle sessionid, long id) Gets the saved query with the given id.
ListResponse	getList(LensSessionHandle sessionid, javax.ws.rs.core.UriInfo info, int start, String count) Gets a list of saved queries matching the criteria (url parameters) windowed by count and start.
String	getMessage()
ParameterParserResponse	getParameters(LensSessionHandle sessionid, String query) Parses the query and returns parameters that are found in the query.
LensAPIResult<QueryHandle>	run(long id, javax.ws.rs.core.UriInfo info, LensSessionHandle sessionid, LensConf conf) Runs the saved query with the given id and returns a query handle.
ResourceModifiedResponse	update(LensSessionHandle sessionid, long id, SavedQuery savedQuery, org.glassfish.grizzly.http.server.Response response) Updates the saved query {id} with the new payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SavedQueryResource

public SavedQueryResource()

Method Detail

getMessage

@GET
 @Path(value="/savedqueries/health")
 @Produces(value="text/plain")
public String getMessage()

getList

@GET
 @Path(value="/savedqueries")
 @Consumes(value="application/x-www-form-urlencoded")
public ListResponse getList(@QueryParam(value="sessionid")
                                                                                                                     LensSessionHandle sessionid,
                                                                                                                     @Context
                                                                                                                     javax.ws.rs.core.UriInfo info,
                                                                                                                     @DefaultValue(value="0") @QueryParam(value="start")
                                                                                                                     int start,
                                                                                                                     @QueryParam(value="count")
                                                                                                                     String count)
                                                                                                              throws LensException

Gets a list of saved queries matching the criteria (url parameters) windowed by count and start.

Parameters:

sessionid - The sessionid in which user is working

info - URI context injected for query parameters

start - Offset to start from the search result

count - Number of records to fetch from start

Returns:

ListResponse ListResponse object

Throws:

LensException

getByID

@GET
 @Path(value="/savedqueries/{id}")
public SavedQuery getByID(@QueryParam(value="sessionid")
                                                                  LensSessionHandle sessionid,
                                                                  @PathParam(value="id")
                                                                  long id)
                                                           throws LensException

Gets the saved query with the given id.

Parameters:

sessionid - The sessionid in which user is working

id - id of the saved query

Returns:

SavedQuery SavedQuery object

Throws:

LensException

deleteById

@DELETE
 @Path(value="/savedqueries/{id}")
public ResourceModifiedResponse deleteById(@QueryParam(value="sessionid")
                                                                                      LensSessionHandle sessionid,
                                                                                      @PathParam(value="id")
                                                                                      long id)
                                                                               throws LensException

Deletes the saved query with the given id.

Parameters:

sessionid - The sessionid in which user is working

id - id of the saved query

Returns:

ResourceModifiedResponse ResourceModifiedResponse object

Throws:

LensException

create

@POST
 @Path(value="/savedqueries")
 @Consumes(value={"application/xml","application/json"})
public ResourceModifiedResponse create(@QueryParam(value="sessionid")
                                                                                                                                    LensSessionHandle sessionid,
                                                                                                                                    SavedQuery savedQuery,
                                                                                                                                    @Context
                                                                                                                                    org.glassfish.grizzly.http.server.Response response)
                                                                                                                             throws LensException,
                                                                                                                                    IOException

Creates a new saved query.

Parameters:

sessionid - The sessionid in which user is working

savedQuery - Saved query object

response - Injected response context object

Returns:

ResourceModifiedResponse ResourceModifiedResponse object

Throws:

LensException

IOException

update

@PUT
 @Path(value="/savedqueries/{id}")
 @Consumes(value={"application/xml","application/json"})
public ResourceModifiedResponse update(@QueryParam(value="sessionid")
                                                                                                                                        LensSessionHandle sessionid,
                                                                                                                                        @PathParam(value="id")
                                                                                                                                        long id,
                                                                                                                                        SavedQuery savedQuery,
                                                                                                                                        @Context
                                                                                                                                        org.glassfish.grizzly.http.server.Response response)
                                                                                                                                 throws LensException,
                                                                                                                                        IOException

Updates the saved query {id} with the new payload.

Parameters:

sessionid - The sessionid in which user is working

savedQuery - Saved query object

response - Injected response context object

Returns:

ResourceModifiedResponse ResourceModifiedResponse object

Throws:

LensException

IOException

getParameters

@POST
 @Path(value="/savedqueries/parameters")
public ParameterParserResponse getParameters(@QueryParam(value="sessionid")
                                                                                            LensSessionHandle sessionid,
                                                                                            String query)

Parses the query and returns parameters that are found in the query.

Parameters:

sessionid - The sessionid in which user is working

query - The HQL query

Returns:

ParameterParserResponse ParameterParserResponse object

run

@POST
 @Path(value="/savedqueries/{id}")
public LensAPIResult<QueryHandle> run(@PathParam(value="id")
                                                                               long id,
                                                                               @Context
                                                                               javax.ws.rs.core.UriInfo info,
                                                                               LensSessionHandle sessionid,
                                                                               LensConf conf)
                                                                        throws LensException

Runs the saved query with the given id and returns a query handle.

Parameters:

id - id of the saved query

info - Injected UriInfo context object

sessionid - The sessionid in which user is working

conf - Lens configuration overrides for the query

Returns:

LensAPIResult containing the query handle

Throws:

LensException