EventServiceEndpoint (Apache Unomi :: Root Project 2.7.0-SNAPSHOT API)

java.lang.Object
- org.apache.unomi.rest.endpoints.EventServiceEndpoint

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

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

Constructor Summary

Constructors
Constructor Description

EventServiceEndpoint()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Event`	`getEvents(String id)`	Allows to retrieve event by id.
`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("/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("/{id}")
public Event getEvents(@PathParam("id")
                       String id)
```
    Allows to retrieve event by id.
    
    Parameters:
    
    id - the event id.
    
    Returns:
    
    Event with the provided id.
  - getEventTypeNames
```
@GET
@Path("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.