Package io.confluent.dekregistry.web.rest.resources

Class DekRegistryResource

java.lang.Object

io.confluent.dekregistry.web.rest.resources.SchemaRegistryResource

io.confluent.dekregistry.web.rest.resources.DekRegistryResource

@Path("/dek-registry/v1/keks")
@Singleton
@Produces({"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json; qs=0.9","application/json; qs=0.5"})
@Consumes({"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json","application/json","application/octet-stream"})
public class DekRegistryResource
extends SchemaRegistryResource

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NAME_MAX_LENGTH

Constructor Summary

Constructors

Constructor	Description
DekRegistryResource(SchemaRegistry schemaRegistry, AbstractDekRegistry dekRegistry)

Method Summary

Modifier and Type	Method	Description
void	createDek(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, @NotNull CreateDekRequest request)	Deprecated.
void	createDekWithSubject(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, String subject, boolean rewrap, @NotNull CreateDekRequest request)
void	createKek(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, boolean testSharing, @NotNull CreateKekRequest request)
void	deleteDekVersion(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, String subject, String version, DekFormat algorithm, boolean permanentDelete)
void	deleteDekVersions(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, String subject, DekFormat algorithm, boolean permanentDelete)
void	deleteKek(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String name, boolean permanentDelete)
Dek	getDek(String kekName, String subject, DekFormat algorithm, boolean lookupDeleted)
Dek	getDekByVersion(String kekName, String subject, String version, DekFormat algorithm, boolean lookupDeleted)
List<String>	getDekSubjects(String kekName, boolean lookupDeleted, int offset, int limit)
List<Integer>	getDekVersions(String kekName, String subject, DekFormat algorithm, boolean lookupDeleted, int offset, int limit)
Kek	getKek(String name, boolean lookupDeleted)
List<String>	getKekNames(List<String> subjectPrefix, boolean lookupDeleted, int offset, int limit)
void	putKek(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String name, boolean testSharing, @NotNull UpdateKekRequest request)
void	testKek(jakarta.ws.rs.container.AsyncResponse asyncResponse, String kekName)
void	undeleteDekVersion(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, String subject, String version, DekFormat algorithm)
void	undeleteDekVersions(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String kekName, String subject, DekFormat algorithm)
void	undeleteKek(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String name)

Methods inherited from class io.confluent.dekregistry.web.rest.resources.SchemaRegistryResource

getSchemaRegistry

Methods inherited from class java.lang.Object

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

Field Details

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

See Also:

• Constant Field Values

Constructor Details

DekRegistryResource

@Inject
public DekRegistryResource(SchemaRegistry schemaRegistry,
 AbstractDekRegistry dekRegistry)

Method Details

getKekNames

@GET
@PerformanceMetric("keks.list")
@DocumentedName("getKekNames")
public List<String> getKekNames(@QueryParam("subjectPrefix")
 List<String> subjectPrefix,
 @QueryParam("deleted")
 boolean lookupDeleted,
 @DefaultValue("0") @QueryParam("offset")
 int offset,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

getKek

@GET
@Path("/{name}")
@PerformanceMetric("keks.get")
@DocumentedName("getKek")
public Kek getKek(@PathParam("name")
 String name,
 @QueryParam("deleted")
 boolean lookupDeleted)

getDekSubjects

@GET
@Path("/{name}/deks")
@PerformanceMetric("deks.list")
@DocumentedName("getDekSubjects")
public List<String> getDekSubjects(@PathParam("name")
 String kekName,
 @QueryParam("deleted")
 boolean lookupDeleted,
 @DefaultValue("0") @QueryParam("offset")
 int offset,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

getDek

@GET
@Path("/{name}/deks/{subject}")
@PerformanceMetric("deks.get")
@DocumentedName("getDek")
public Dek getDek(@PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @QueryParam("algorithm")
 DekFormat algorithm,
 @QueryParam("deleted")
 boolean lookupDeleted)

getDekVersions

@GET
@Path("/{name}/deks/{subject}/versions")
@PerformanceMetric("deks.versions.list")
@DocumentedName("getAllDekVersions")
public List<Integer> getDekVersions(@PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @QueryParam("algorithm")
 DekFormat algorithm,
 @QueryParam("deleted")
 boolean lookupDeleted,
 @DefaultValue("0") @QueryParam("offset")
 int offset,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

getDekByVersion

@GET
@Path("/{name}/deks/{subject}/versions/{version}")
@PerformanceMetric("deks.versions.get")
@DocumentedName("getDekByVersion")
public Dek getDekByVersion(@PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @PathParam("version")
 String version,
 @QueryParam("algorithm")
 DekFormat algorithm,
 @QueryParam("deleted")
 boolean lookupDeleted)

createKek

@POST
@PerformanceMetric("keks.create")
@DocumentedName("registerKek")
public void createKek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @QueryParam("testSharing")
 boolean testSharing,
 @NotNull
 @NotNull CreateKekRequest request)

testKek

@POST
@Path("/{name}/test")
@PerformanceMetric("keks.test")
@DocumentedName("testKek")
public void testKek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @PathParam("name")
 String kekName)

createDek

@Deprecated
@POST
@Path("/{name}/deks")
@PerformanceMetric("deks.create")
@DocumentedName("registerDek")
public void createDek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @NotNull
 @NotNull CreateDekRequest request)

Deprecated.

createDekWithSubject

@POST
@Path("/{name}/deks/{subject}")
@PerformanceMetric("deks.create")
@DocumentedName("registerDekWithSubject")
public void createDekWithSubject(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @QueryParam("rewrap")
 boolean rewrap,
 @NotNull
 @NotNull CreateDekRequest request)

putKek

@PUT
@Path("/{name}")
@PerformanceMetric("keks.put")
@DocumentedName("updateKek")
public void putKek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name,
 @QueryParam("testSharing")
 boolean testSharing,
 @NotNull
 @NotNull UpdateKekRequest request)

deleteKek

@DELETE
@Path("/{name}")
@PerformanceMetric("keks.delete")
@DocumentedName("deregisterKek")
public void deleteKek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name,
 @QueryParam("permanent")
 boolean permanentDelete)

deleteDekVersions

@DELETE
@Path("/{name}/deks/{subject}")
@PerformanceMetric("deks.delete")
@DocumentedName("deregisterDekVersions")
public void deleteDekVersions(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @QueryParam("algorithm")
 DekFormat algorithm,
 @QueryParam("permanent")
 boolean permanentDelete)

deleteDekVersion

@DELETE
@Path("/{name}/deks/{subject}/versions/{version}")
@PerformanceMetric("deks.versions.delete")
@DocumentedName("deregisterDekVersion")
public void deleteDekVersion(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @PathParam("version")
 String version,
 @QueryParam("algorithm")
 DekFormat algorithm,
 @QueryParam("permanent")
 boolean permanentDelete)

undeleteKek

@POST
@Path("/{name}/undelete")
@PerformanceMetric("keks.undelete")
@DocumentedName("undeleteKek")
public void undeleteKek(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String name)

undeleteDekVersions

@POST
@Path("/{name}/deks/{subject}/undelete")
@PerformanceMetric("deks.undelete")
@DocumentedName("undeleteDekVersions")
public void undeleteDekVersions(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @QueryParam("algorithm")
 DekFormat algorithm)

undeleteDekVersion

@POST
@Path("/{name}/deks/{subject}/versions/{version}/undelete")
@PerformanceMetric("deks.versions.undelete")
@DocumentedName("undeleteDekVersion")
public void undeleteDekVersion(@Suspended
 jakarta.ws.rs.container.AsyncResponse asyncResponse,
 @Context
 jakarta.ws.rs.core.HttpHeaders headers,
 @PathParam("name")
 String kekName,
 @PathParam("subject")
 String subject,
 @PathParam("version")
 String version,
 @QueryParam("algorithm")
 DekFormat algorithm)