org.apache.pulsar.broker.admin.v2

Class SchemasResource

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

org.apache.pulsar.broker.admin.v2.SchemasResource

@Path(value="/schemas")
public class SchemasResource
extends AdminResource

Field Summary

Fields inherited from class org.apache.pulsar.broker.admin.AdminResource

namespaceName, PARTITIONED_TOPIC_PATH_ZNODE, topicName

Fields inherited from class org.apache.pulsar.broker.web.PulsarWebResource

httpRequest, NOT_IMPLEMENTED, servletContext, uri

Constructor Summary

Constructors

Constructor and Description
SchemasResource()
SchemasResource(Clock clock)

Method Summary

Modifier and Type	Method and Description
void	deleteSchema(String tenant, String namespace, String topic, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	getAllSchemas(String tenant, String namespace, String topic, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	getSchema(String tenant, String namespace, String topic, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	getSchema(String tenant, String namespace, String topic, String version, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	getVersionBySchema(String tenant, String namespace, String topic, org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	postSchema(String tenant, String namespace, String topic, org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload, boolean authoritative, javax.ws.rs.container.AsyncResponse response)
void	testCompatibility(String tenant, String namespace, String topic, org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload, boolean authoritative, javax.ws.rs.container.AsyncResponse response)

Methods inherited from class org.apache.pulsar.broker.admin.AdminResource

checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, checkTopicLevelPolicyEnable, clusters, clustersCache, clustersListCache, dispatchRate, domain, failureDomainCache, failureDomainListCache, fetchPartitionedTopicMetadata, fetchPartitionedTopicMetadataCheckAllowAutoCreation, getListOfNamespaces, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClusters, getPartitionedTopicList, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getTopicPolicies, globalZk, globalZkCache, internalCreatePartitionedTopic, isLeaderBroker, isNamespaceReplicated, jsonMapper, localCacheService, localPoliciesCache, localZk, localZkCache, managedLedgerListCache, mergeNamespaceWithDefaults, namespaceBacklogQuota, namespaceIsolationPoliciesCache, policiesCache, resumeAsyncResponseExceptionally, setServletContext, subscribeRate, subscriptionDispatchRate, tenantsCache, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateBrokerName, validateBundleOwnership, validateClusterExists, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validateNamespaceOwnershipWithBundles, validatePartitionedTopicMetadata, validatePartitionedTopicName, validatePersistencePolicies, validatePoliciesReadOnlyAccess, validateSuperUserAccess, validateTopicExistedAndCheckAllowAutoCreation, validateTopicName, validateTopicName, zkCreate, zkCreateOptimistic, zkCreateOptimisticAsync, zkPathExists, zkSync

Methods inherited from class org.apache.pulsar.broker.web.PulsarWebResource

checkAuthorization, checkConnect, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, config, getClusterDataIfDifferentCluster, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, joinPath, originalPrincipal, path, pulsar, setPulsar, splitPath, validateAdminAccessForTenant, validateBundleOwnership, validateClusterForTenant, validateClusterOwnership, validateGlobalNamespaceOwnership, validateNamespaceBundleOwnership, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespacePolicyOperation, validateTenantOperation, validateTopicOwnership

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemasResource

public SchemasResource()

SchemasResource

public SchemasResource(Clock clock)

Method Detail

getSchema

@GET
 @Path(value="/{tenant}/{namespace}/{topic}/schema")
 @Produces(value="application/json")
public void getSchema(@PathParam(value="tenant")
                                                                                                                     String tenant,
                                                                                                                     @PathParam(value="namespace")
                                                                                                                     String namespace,
                                                                                                                     @PathParam(value="topic")
                                                                                                                     String topic,
                                                                                                                     @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                     boolean authoritative,
                                                                                                                     @Suspended
                                                                                                                     javax.ws.rs.container.AsyncResponse response)

getSchema

@GET
 @Path(value="/{tenant}/{namespace}/{topic}/schema/{version}")
 @Produces(value="application/json")
public void getSchema(@PathParam(value="tenant")
                                                                                                                               String tenant,
                                                                                                                               @PathParam(value="namespace")
                                                                                                                               String namespace,
                                                                                                                               @PathParam(value="topic")
                                                                                                                               String topic,
                                                                                                                               @PathParam(value="version") @Encoded
                                                                                                                               String version,
                                                                                                                               @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                               boolean authoritative,
                                                                                                                               @Suspended
                                                                                                                               javax.ws.rs.container.AsyncResponse response)

getAllSchemas

@GET
 @Path(value="/{tenant}/{namespace}/{topic}/schemas")
 @Produces(value="application/json")
public void getAllSchemas(@PathParam(value="tenant")
                                                                                                                          String tenant,
                                                                                                                          @PathParam(value="namespace")
                                                                                                                          String namespace,
                                                                                                                          @PathParam(value="topic")
                                                                                                                          String topic,
                                                                                                                          @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                          boolean authoritative,
                                                                                                                          @Suspended
                                                                                                                          javax.ws.rs.container.AsyncResponse response)

deleteSchema

@DELETE
 @Path(value="/{tenant}/{namespace}/{topic}/schema")
 @Produces(value="application/json")
public void deleteSchema(@PathParam(value="tenant")
                                                                                                                           String tenant,
                                                                                                                           @PathParam(value="namespace")
                                                                                                                           String namespace,
                                                                                                                           @PathParam(value="topic")
                                                                                                                           String topic,
                                                                                                                           @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                           boolean authoritative,
                                                                                                                           @Suspended
                                                                                                                           javax.ws.rs.container.AsyncResponse response)

postSchema

@POST
 @Path(value="/{tenant}/{namespace}/{topic}/schema")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public void postSchema(@PathParam(value="tenant")
                                                                                                                                                            String tenant,
                                                                                                                                                            @PathParam(value="namespace")
                                                                                                                                                            String namespace,
                                                                                                                                                            @PathParam(value="topic")
                                                                                                                                                            String topic,
                                                                                                                                                            org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload,
                                                                                                                                                            @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                                                            boolean authoritative,
                                                                                                                                                            @Suspended
                                                                                                                                                            javax.ws.rs.container.AsyncResponse response)

testCompatibility

@POST
 @Path(value="/{tenant}/{namespace}/{topic}/compatibility")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public void testCompatibility(@PathParam(value="tenant")
                                                                                                                                                                          String tenant,
                                                                                                                                                                          @PathParam(value="namespace")
                                                                                                                                                                          String namespace,
                                                                                                                                                                          @PathParam(value="topic")
                                                                                                                                                                          String topic,
                                                                                                                                                                          org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload,
                                                                                                                                                                          @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                                                                          boolean authoritative,
                                                                                                                                                                          @Suspended
                                                                                                                                                                          javax.ws.rs.container.AsyncResponse response)

getVersionBySchema

@POST
 @Path(value="/{tenant}/{namespace}/{topic}/version")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public void getVersionBySchema(@PathParam(value="tenant")
                                                                                                                                                                     String tenant,
                                                                                                                                                                     @PathParam(value="namespace")
                                                                                                                                                                     String namespace,
                                                                                                                                                                     @PathParam(value="topic")
                                                                                                                                                                     String topic,
                                                                                                                                                                     org.apache.pulsar.common.protocol.schema.PostSchemaPayload payload,
                                                                                                                                                                     @QueryParam(value="authoritative") @DefaultValue(value="false")
                                                                                                                                                                     boolean authoritative,
                                                                                                                                                                     @Suspended
                                                                                                                                                                     javax.ws.rs.container.AsyncResponse response)