Package lumis.portal.monitor.impl.rest

Class MonitorV1Resource

java.lang.Object

lumis.portal.monitor.impl.rest.MonitorV1Resource

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

Monitor V1 REST resource.

Since:

11.0.0

Version:

$Revision: 24920 $ $Date: 2022-04-06 15:29:01 -0300 (Wed, 06 Apr 2022) $

Constructor Summary

Constructors

Constructor	Description
MonitorV1Resource()

Method Summary

Modifier and Type	Method	Description
Response	addEventData(HttpServletRequest request, @NotNull String eventId, @NotNull String reqData, Boolean fromEventClient)	Adds an occurrence to a monitor event.
Response	addUpdateMonitorUsers(@NotNull String reqData)	Add or update a monitor user.
Response	identifyMonitorUser(@NotNull String trackId, @NotNull String reqData)	Identify monitor user.
Response	updateMonitorUser(@NotNull String trackId, @NotNull String reqData)	Update the requested monitor user.
Response	updateMonitorUserPost(@NotNull String trackId, @NotNull 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("/events/{eventId}/data")
@POST
@Consumes({"application/json","text/plain"})
@Produces("application/json")
public Response addEventData(@Context
                             HttpServletRequest request,
                             @NotNull @PathParam("eventId")
                             @NotNull String eventId,
                             @NotNull
                             @NotNull String reqData,
                             @QueryParam("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("/users")
@POST
@Consumes({"application/json","text/plain"})
@Produces("application/json")
public Response addUpdateMonitorUsers(@NotNull
                                      @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

updateMonitorUserPost

@Path("/users/{trackId}")
@POST
@Consumes("text/plain")
@Produces("application/json")
public Response updateMonitorUserPost(@NotNull @PathParam("trackId")
                                      @NotNull String trackId,
                                      @NotNull
                                      @NotNull String reqData)
                               throws Exception

Update the requested monitor user. For internal use only and not part of public documented REST API.

Parameters:

trackId - the monitor user track identifier.

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

Returns:

response with a json object.

Throws:

Exception

Since:

11.1.0

updateMonitorUser

@Path("/users/{trackId}")
@PATCH
@Consumes("application/merge-patch+json")
@Produces("application/json")
public Response updateMonitorUser(@NotNull @PathParam("trackId")
                                  @NotNull String trackId,
                                  @NotNull
                                  @NotNull String reqData)
                           throws PortalException

Update the requested monitor user.

Parameters:

trackId - the monitor user track identifier.

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

Returns:

response with a json object.

Throws:

PortalException

Since:

11.0.0

identifyMonitorUser

@Path("/users/{trackId}/identify")
@POST
@Consumes({"application/json","text/plain"})
@Produces("application/json")
public Response identifyMonitorUser(@NotNull @PathParam("trackId")
                                    @NotNull String trackId,
                                    @NotNull
                                    @NotNull String reqData)
                             throws PortalException

Identify monitor user.

Parameters:

trackId - the monitor user track identifier.

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

Returns:

response with a json object.

Throws:

PortalException

Since:

11.0.0