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	D2_FORMAT
protected static final String	ENABLED_OPTION
protected static final String	NO_CONSUMER
protected static final String	PUML_FORMAT
protected static final Function<StreamIntrospection,ScaleActivity>	TO_SCALE_ACTIVITY

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()
jakarta.ws.rs.core.Response	doGet(String format, jakarta.ws.rs.core.HttpHeaders headers)
jakarta.ws.rs.core.Response	doGetPuml(jakarta.ws.rs.core.HttpHeaders headers)	Deprecated. since 2021.21 use doGet(String, HttpHeaders) with format=puml instead.
StreamLag	getConsumerPosition(String consumer, String stream)
protected KeyValueStore	getKvStore()
protected StreamIntrospection	getStreamIntrospection()
List<StreamIntrospection.ProcessorTopology>	listConsumers(String stream, RenderingContext renderingContext)
List<StreamIntrospection.Stream>	listStreams()
ScaleActivity	scale()
StreamLagChange	setConsumerPositionAfterDate(String consumer, String stream, String dateTime)
StreamLagChange	setConsumerPositionToBeginning(String consumer, String stream)
StreamLagChange	setConsumerPositionToEnd(String consumer, String stream)
StreamLagChange	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

D2_FORMAT

protected static final String D2_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

TO_SCALE_ACTIVITY

protected static final Function<StreamIntrospection,ScaleActivity> TO_SCALE_ACTIVITY

Constructor Details

StreamObject

public StreamObject()

Method Details

doGet

@GET
@Produces("*/*")
public jakarta.ws.rs.core.Response doGet(@QueryParam("format")
 String format,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers)

doGetPuml

@Deprecated
@GET
@Path("/puml")
public jakarta.ws.rs.core.Response doGetPuml(@Context
 jakarta.ws.rs.core.HttpHeaders headers)

Deprecated.

since 2021.21 use doGet(String, HttpHeaders) with format=puml instead.

listStreams

@GET
@Path("/streams")
public List<StreamIntrospection.Stream> listStreams()

listConsumers

@GET
@Path("/consumers")
public List<StreamIntrospection.ProcessorTopology> listConsumers(@QueryParam("stream")
 String stream,
 @Context
 RenderingContext renderingContext)

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 StreamLag getConsumerPosition(@QueryParam("consumer")
 String consumer,
 @QueryParam("stream")
 String stream)

setConsumerPositionToEnd

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

setConsumerPositionToBeginning

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

setConsumerPositionToOffset

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

setConsumerPositionAfterDate

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

scale

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

getStreamIntrospection

protected StreamIntrospection getStreamIntrospection()

getKvStore

protected KeyValueStore getKvStore()

checkStreamMetricEnabled

protected void checkStreamMetricEnabled()