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

Class TopicsEndpoint

java.lang.Object

pl.allegro.tech.hermes.management.api.TopicsEndpoint

@Component
@Path("/topics")
public class TopicsEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
TopicsEndpoint(TopicService topicService, ManagementRights managementRights, OwnerSources ownerSources)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(pl.allegro.tech.hermes.api.TopicWithSchema topicWithSchema, jakarta.ws.rs.container.ContainerRequestContext requestContext)
pl.allegro.tech.hermes.api.TopicWithSchema	get(String qualifiedTopicName)
pl.allegro.tech.hermes.api.TopicMetrics	getMetrics(String qualifiedTopicName)
List<pl.allegro.tech.hermes.api.MessageTextPreview>	getPreview(String qualifiedTopicName)
byte[]	getPreviewRaw(String qualifiedTopicName, Integer idx)
List<String>	list(String groupName, boolean tracked)
List<pl.allegro.tech.hermes.api.Topic>	listForOwner(String ownerSourceName, String id)
String	preview(String qualifiedTopicName, String brokersClusterName, Integer partition, Long offset)
List<String>	queryList(String groupName, pl.allegro.tech.hermes.api.Query<pl.allegro.tech.hermes.api.Topic> query)
jakarta.ws.rs.core.Response	remove(String qualifiedTopicName, jakarta.ws.rs.container.ContainerRequestContext requestContext)
jakarta.ws.rs.core.Response	update(String qualifiedTopicName, pl.allegro.tech.hermes.api.PatchData patch, 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

TopicsEndpoint

@Autowired
public TopicsEndpoint(TopicService topicService,
 ManagementRights managementRights,
 OwnerSources ownerSources)

Method Details

list

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

queryList

@POST
@Consumes("application/json")
@Produces("application/json")
@Path("/query")
public List<String> queryList(@DefaultValue("") @QueryParam("groupName")
 String groupName,
 pl.allegro.tech.hermes.api.Query<pl.allegro.tech.hermes.api.Topic> query)

create

@POST
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("any")
public jakarta.ws.rs.core.Response create(pl.allegro.tech.hermes.api.TopicWithSchema topicWithSchema,
 @Context
 jakarta.ws.rs.container.ContainerRequestContext requestContext)

remove

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

update

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

get

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

getMetrics

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

getPreview

@GET
@Produces("application/json")
@Path("/{topicName}/preview")
public List<pl.allegro.tech.hermes.api.MessageTextPreview> getPreview(@PathParam("topicName")
 String qualifiedTopicName)

getPreviewRaw

@GET
@Produces("application/octet-stream")
@Path("/{topicName}/preview/{idx}")
public byte[] getPreviewRaw(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("idx")
 Integer idx)

preview

@GET
@Produces("application/json")
@Path("/{topicName}/preview/cluster/{brokersClusterName}/partition/{partition}/offset/{offset}")
@RolesAllowed("admin")
public String preview(@PathParam("topicName")
 String qualifiedTopicName,
 @PathParam("brokersClusterName")
 String brokersClusterName,
 @PathParam("partition")
 Integer partition,
 @PathParam("offset")
 Long offset)

listForOwner

@GET
@Produces("application/json")
@Path("/owner/{ownerSourceName}/{ownerId}")
public List<pl.allegro.tech.hermes.api.Topic> listForOwner(@PathParam("ownerSourceName")
 String ownerSourceName,
 @PathParam("ownerId")
 String id)