org.apache.unomi.rest.endpoints

Class EventServiceEndpoint

java.lang.Object

org.apache.unomi.rest.endpoints.EventServiceEndpoint

@Produces(value="application/json")
 @Path(value="/events")
public class EventServiceEndpoint
extends Object

A JAX-RS endpoint to access information about the context server's events.

Constructor Summary

Constructors

Constructor and Description
EventServiceEndpoint()

Method Summary

Modifier and Type	Method and Description
Event	getEvents(String id) Allows to retrieve event by id.
EventType	getEventType(String typeName) Returns the list of event properties
Set<String>	getEventTypeNames() Retrieves the list of event types identifiers that the server has processed.
PartialList<Event>	searchEvents(Query query) Allows to search events using a query.
void	setEventService(EventService eventService)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventServiceEndpoint

public EventServiceEndpoint()

Method Detail

setEventService

public void setEventService(EventService eventService)

searchEvents

@POST
 @Path(value="/search")
public PartialList<Event> searchEvents(Query query)

Allows to search events using a query.

Parameters:

query - the query object to use to search for events. You can specify offset and limits along with a condition tree.

Returns:

a partial list containing the events that match the query.

getEvents

@GET
 @Path(value="/{id}")
public Event getEvents(@PathParam(value="id")
                                                  String id)

Allows to retrieve event by id.

Parameters:

id - the event id.

Returns:

Event with the provided id.

getEventTypeNames

@GET
 @Path(value="types")
public Set<String> getEventTypeNames()

Retrieves the list of event types identifiers that the server has processed.

Returns:

a Set of strings that contain event type identifiers.

getEventType

@GET
 @Path(value="types/{typeName}")
public EventType getEventType(@PathParam(value="typeName")
                                                                    String typeName)

Returns the list of event properties

Parameters:

typeName - the type name identifier

Returns:

a List of EventProperty objects that make up the properties that the server has seen.