lumis.portal.monitor.impl.rest

Class MonitorV1Resource

java.lang.Object

lumis.portal.monitor.impl.rest.MonitorV1Resource

@Path(value="/lumis/monitor/v1")
public class MonitorV1Resource
extends Object

Monitor V1 REST resource.

Since:

11.0.0

Version:

$Revision: 21881 $ $Date: 2018-09-21 20:09:37 +0000 (Fri, 21 Sep 2018) $

Constructor Summary

Constructors

Constructor and Description
MonitorV1Resource()

Method Summary

Modifier and Type	Method and Description
Response	addEventData(HttpServletRequest request, String eventId, String reqData, Boolean fromEventClient) Adds an occurrence to a monitor event.
Response	addUpdateMonitorUsers(String reqData) Add or update a monitor user.
Response	identifyMonitorUser(String id, String reqData) Identify monitor user.
Response	updateMonitorUser(String id, String reqData) Update the requested monitor user.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorV1Resource

public MonitorV1Resource()

Method Detail

addEventData

@Path(value="/events/{eventId}/data")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response addEventData(@Context
                                                                                                                                                    HttpServletRequest request,
                                                                                                                                                    @NotNull @PathParam(value="eventId")
                                                                                                                                                    String eventId,
                                                                                                                                                    @NotNull
                                                                                                                                                    String reqData,
                                                                                                                                                    @QueryParam(value="fromEventClient")
                                                                                                                                                    Boolean fromEventClient)
                                                                                                                                             throws Exception

Adds an occurrence to a monitor event.

Parameters:

eventId - the event identifier.

reqData - JSON object with event fields values to be registered.

Returns:

an empty 204 response for success.

Throws:

Exception

Since:

11.0.0

addUpdateMonitorUsers

@Path(value="/monitor-users")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response addUpdateMonitorUsers(@NotNull
                                                                                                                                                     String reqData)
                                                                                                                                              throws Exception

Add or update a monitor user.

Parameters:

reqData - the json object.

Returns:

response with a json object.

Throws:

DaoException

Exception

Since:

11.0.0

updateMonitorUser

@Path(value="/monitor-users/{id}")
 @PATCH
 @Consumes(value="application/merge-patch+json")
 @Produces(value="application/json")
public Response updateMonitorUser(@NotNull @PathParam(value="id")
                                                                                                                                                                   String id,
                                                                                                                                                                   @NotNull
                                                                                                                                                                   String reqData)
                                                                                                                                                            throws Exception

Update the requested monitor user.

Parameters:

id - the monitor user identifier.

reqData - JSON object with event fields values to be registered.

Returns:

response with a json object.

Throws:

Exception

Since:

11.0.0

identifyMonitorUser

@Path(value="/monitor-users/{id}/identify")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response identifyMonitorUser(@NotNull @PathParam(value="id")
                                                                                                                                                                 String id,
                                                                                                                                                                 @NotNull
                                                                                                                                                                 String reqData)
                                                                                                                                                          throws PortalException

Identify monitor user.

Parameters:

id - the monitor user identifier.

reqData - JSON object with event fields values to be registered.

Returns:

response with a json object.

Throws:

PortalException

Since:

11.0.0