Package pl.allegro.tech.hermes.management.api

Class SubscriptionsEndpoint

java.lang.Object

pl.allegro.tech.hermes.management.api.SubscriptionsEndpoint

@Path("topics/{topicName}/subscriptions")
public class SubscriptionsEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
SubscriptionsEndpoint(SubscriptionService subscriptionService, TopicService topicService, MultiDCAwareService multiDCAwareService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(String qualifiedTopicName, pl.allegro.tech.hermes.api.Subscription subscription, jakarta.ws.rs.container.ContainerRequestContext requestContext)
List<pl.allegro.tech.hermes.api.ConsumerGroup>	describeConsumerGroups(String qualifiedTopicName, String subscriptionName)
pl.allegro.tech.hermes.api.Subscription	get(String qualifiedTopicName, String subscriptionName)
pl.allegro.tech.hermes.api.SubscriptionHealth	getHealth(String qualifiedTopicName, String subscriptionName)
jakarta.ws.rs.core.Response	getLatestUndeliveredMessage(String qualifiedTopicName, String subscriptionName)
jakarta.ws.rs.core.Response	getLatestUndeliveredMessages(String qualifiedTopicName, String subscriptionName)
jakarta.ws.rs.core.Response	getMessageTrace(String qualifiedTopicName, String subscriptionName, String messageId)
pl.allegro.tech.hermes.api.SubscriptionMetrics	getMetrics(String qualifiedTopicName, String subscriptionName)
pl.allegro.tech.hermes.api.PersistentSubscriptionMetrics	getPersistentMetrics(String qualifiedTopicName, String subscriptionName)
pl.allegro.tech.hermes.api.Subscription.State	getState(String qualifiedTopicName, String subscriptionName)
List<String>	list(String qualifiedTopicName, boolean tracked)
jakarta.ws.rs.core.Response	moveOffsetsToTheEnd(String qualifiedTopicName, String subscriptionName)
List<String>	queryList(String qualifiedTopicName, pl.allegro.tech.hermes.api.Query<pl.allegro.tech.hermes.api.Subscription> query)
jakarta.ws.rs.core.Response	remove(String qualifiedTopicName, String subscriptionId, jakarta.ws.rs.container.ContainerRequestContext requestContext)
jakarta.ws.rs.core.Response	retransmit(String qualifiedTopicName, String subscriptionName, boolean dryRun, @Valid pl.allegro.tech.hermes.api.OffsetRetransmissionDate offsetRetransmissionDate, jakarta.ws.rs.container.ContainerRequestContext requestContext)
jakarta.ws.rs.core.Response	update(String qualifiedTopicName, String subscriptionName, pl.allegro.tech.hermes.api.PatchData patch, jakarta.ws.rs.container.ContainerRequestContext requestContext)
jakarta.ws.rs.core.Response	updateState(String qualifiedTopicName, String subscriptionName, pl.allegro.tech.hermes.api.Subscription.State state, jakarta.ws.rs.container.ContainerRequestContext requestContext)

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionsEndpoint

@Autowired
public SubscriptionsEndpoint(SubscriptionService subscriptionService,
 TopicService topicService,
 MultiDCAwareService multiDCAwareService)

Method Details

list

@GET
@Produces("application/json")
public List<String> list(@PathParam("topicName")
 String qualifiedTopicName,
 @DefaultValue("false") @QueryParam("tracked")
 boolean tracked)

queryList

@POST
@Consumes("application/json")
@Produces("application/json")
@Path("/query")
public List<String> queryList(@PathParam("topicName")
 String qualifiedTopicName,
 pl.allegro.tech.hermes.api.Query<pl.allegro.tech.hermes.api.Subscription> query)

create

@POST
@Consumes("application/json")
@RolesAllowed("any")
public jakarta.ws.rs.core.Response create(@PathParam("topicName")
 String qualifiedTopicName,
 pl.allegro.tech.hermes.api.Subscription subscription,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

get

@GET
@Produces("application/json")
@Path("/{subscriptionName}")
public pl.allegro.tech.hermes.api.Subscription get(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getState

@GET
@Produces("application/json")
@Path("/{subscriptionName}/state")
public pl.allegro.tech.hermes.api.Subscription.State getState(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getLatestUndeliveredMessage

@GET
@Produces("application/json")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
@Path("/{subscriptionName}/undelivered/last")
public jakarta.ws.rs.core.Response getLatestUndeliveredMessage(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getLatestUndeliveredMessages

@GET
@Produces("application/json")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
@Path("/{subscriptionName}/undelivered")
public jakarta.ws.rs.core.Response getLatestUndeliveredMessages(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getMetrics

@GET
@Produces("application/json")
@Path("/{subscriptionName}/metrics")
public pl.allegro.tech.hermes.api.SubscriptionMetrics getMetrics(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getPersistentMetrics

@GET
@Produces("application/json")
@Path("/{subscriptionName}/metrics/persistent")
public pl.allegro.tech.hermes.api.PersistentSubscriptionMetrics getPersistentMetrics(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getHealth

@GET
@Produces("application/json")
@Path("/{subscriptionName}/health")
public pl.allegro.tech.hermes.api.SubscriptionHealth getHealth(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

updateState

@PUT
@Consumes("application/json")
@Path("/{subscriptionName}/state")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
public jakarta.ws.rs.core.Response updateState(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName,
 pl.allegro.tech.hermes.api.Subscription.State state,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

remove

@DELETE
@Path("/{subscriptionName}")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
public jakarta.ws.rs.core.Response remove(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionId,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

update

@PUT
@Consumes("application/json")
@Path("/{subscriptionName}")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
public jakarta.ws.rs.core.Response update(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName,
 pl.allegro.tech.hermes.api.PatchData patch,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

retransmit

@PUT
@Consumes("application/json")
@Produces("application/json")
@Path("/{subscriptionName}/retransmission")
@RolesAllowed({"admin","topicOwner","subscriptionOwner"})
public jakarta.ws.rs.core.Response retransmit(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName,
 @DefaultValue("false") @QueryParam("dryRun")
 boolean dryRun,
 @Valid
 @Valid pl.allegro.tech.hermes.api.OffsetRetransmissionDate offsetRetransmissionDate,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

moveOffsetsToTheEnd

@POST
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("admin")
@Path("/{subscriptionName}/moveOffsetsToTheEnd")
public jakarta.ws.rs.core.Response moveOffsetsToTheEnd(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)

getMessageTrace

@GET
@Produces("application/json")
@Path("/{subscriptionName}/events/{messageId}/trace")
public jakarta.ws.rs.core.Response getMessageTrace(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName,
 @PathParam("messageId")
 String messageId)

describeConsumerGroups

@GET
@Produces("application/json")
@Path("/{subscriptionName}/consumer-groups")
public List<pl.allegro.tech.hermes.api.ConsumerGroup> describeConsumerGroups(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("subscriptionName")
 String subscriptionName)