Package org.nuxeo.ecm.restapi.server.management

Class StreamObject

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.restapi.server.management.StreamObject

All Implemented Interfaces:

Resource, Adaptable

@Produces("application/json")
public class StreamObject
extends AbstractResource<ResourceTypeImpl>

Nuxeo Stream Introspection endpoint

Since:

11.5

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ENABLED_OPTION
protected static final String	NO_CONSUMER
protected static final String	PUML_FORMAT

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
StreamObject()

Method Summary

Modifier and Type	Method	Description
protected void	checkStreamMetricEnabled()
String	doGet(String format)
String	doGetPuml()	Deprecated. since 2022.21 use doGet(String) with format=puml instead.
String	getConsumerPosition(String consumer, String stream)
protected String	getJson()
protected KeyValueStore	getKvStore()
protected String	lagAsJson(String consumer, String stream, List<LogLag> lags)
String	listConsumers(String stream)
String	listStreams()
protected String	positionChangeAsJson(String consumer, String stream, List<LogLag> before, List<LogLag> after)
String	scale()
String	setConsumerPositionAfterDate(String consumer, String stream, String dateTime)
String	setConsumerPositionToBeginning(String consumer, String stream)
String	setConsumerPositionToEnd(String consumer, String stream)
String	setConsumerPositionToOffset(String consumer, String stream, int partition, long offset)
void	startConsumer(String consumer)
void	stopConsumer(String consumer)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

PUML_FORMAT

protected static final String PUML_FORMAT

See Also:

• Constant Field Values

NO_CONSUMER

protected static final String NO_CONSUMER

See Also:

• Constant Field Values

ENABLED_OPTION

protected static final String ENABLED_OPTION

See Also:

• Constant Field Values

Constructor Details

StreamObject

public StreamObject()

Method Details

doGet

@GET
public String doGet(@QueryParam("format")
 String format)

doGetPuml

@Deprecated
@GET
@Path("/puml")
public String doGetPuml()

Deprecated.

since 2022.21 use doGet(String) with format=puml instead.

listStreams

@GET
@Path("/streams")
public String listStreams()

listConsumers

@GET
@Path("/consumers")
public String listConsumers(@QueryParam("stream")
 String stream)

stopConsumer

@PUT
@Path("/consumer/stop")
public void stopConsumer(@QueryParam("consumer")
 String consumer)

startConsumer

@PUT
@Path("/consumer/start")
public void startConsumer(@QueryParam("consumer")
 String consumer)

getConsumerPosition

@GET
@Path("/consumer/position")
public String getConsumerPosition(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream)

setConsumerPositionToEnd

@PUT
@Path("/consumer/position/end")
public String setConsumerPositionToEnd(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream)

positionChangeAsJson

protected String positionChangeAsJson(String consumer,
 String stream,
 List<LogLag> before,
 List<LogLag> after)

setConsumerPositionToBeginning

@PUT
@Path("/consumer/position/beginning")
public String setConsumerPositionToBeginning(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream)

setConsumerPositionToOffset

@PUT
@Path("/consumer/position/offset")
public String setConsumerPositionToOffset(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream,
 @QueryParam("partition")
 int partition,
 @QueryParam("offset")
 long offset)

setConsumerPositionAfterDate

@PUT
@Path("/consumer/position/after")
public String setConsumerPositionAfterDate(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream,
 @QueryParam("date")
 String dateTime)

lagAsJson

protected String lagAsJson(String consumer,
 String stream,
 List<LogLag> lags)

scale

@GET
@Path("/scale")
public String scale()

getJson

protected String getJson()

getKvStore

protected KeyValueStore getKvStore()

checkStreamMetricEnabled

protected void checkStreamMetricEnabled()