Package 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.impl.SchemasResourceBase

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

@Path("/schemas")
public class SchemasResource
extends SchemasResourceBase

Field Summary

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

namespaceName, topicName

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

httpRequest, servletContext, uri

Constructor Summary

Constructors

Constructor	Description
SchemasResource()

Method Summary

Modifier and Type	Method	Description
void	deleteSchema(String tenant, String namespace, String topic, boolean authoritative, boolean force, 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.impl.SchemasResourceBase

convertToAllVersionsSchemaResponse, convertToSchemaResponse, deleteSchema, deleteSchemaAsync, domain, getAllSchemas, getAllSchemasAsync, getLongSchemaVersion, getSchema, getSchema, getSchemaAsync, getSchemaAsync, getVersionBySchema, getVersionBySchemaAsync, handleGetSchemaResponse, postSchema, postSchemaAsync, shouldPrintErrorLog, testCompatibility, testCompatibilityAsync

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

bookKeeper, checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, checkTopicLevelPolicyEnable, clusters, clustersAsync, dispatchRate, fetchPartitionedTopicMetadata, fetchPartitionedTopicMetadataCheckAllowAutoCreation, filterSystemTopic, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClusters, getNamespaceReplicatedClustersAsync, getPartitionedTopicList, getPartitionedTopicListAsync, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getPartitionedTopicNotFoundErrorMessage, getSchemaCompatibilityStrategyAsync, getSchemaCompatibilityStrategyAsyncWithoutAuth, getSubNotFoundErrorMessage, getTopicNotFoundErrorMessage, getTopicPartitionList, getTopicPoliciesAsyncWithRetry, getTopicPoliciesAsyncWithRetry, internalCreatePartitionedTopic, internalCreatePartitionedTopic, isLeaderBroker, isManagedLedgerNotFoundException, isNamespaceReplicated, isNotFoundException, isRedirectException, jsonMapper, namespaceBacklogQuota, replicatorDispatchRate, setServletContext, subscribeRate, subscriptionDispatchRate, tryCreateExtendedPartitionsAsync, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateAndGetWorkerService, validateBundleOwnership, validateClusterExists, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validatePartitionedTopicMetadataAsync, validatePartitionedTopicName, validatePersistencePolicies, validatePersistentTopicName, validatePersistentTopicName, validatePoliciesReadOnlyAccess, validatePoliciesReadOnlyAccessAsync, validateSuperUserAccess, validateTopicName, validateTopicName

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

bookieResources, canUpdateCluster, checkAuthorizationAsync, checkLocalOrGetPeerReplicationCluster, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getLocalPolicies, getPulsarResources, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, namespaceIsolationPolicies, namespaceResources, originalPrincipal, pulsar, resourceGroupResources, resumeAsyncResponseExceptionally, setPulsar, splitPath, sync, tenantResources, topicResources, validateAdminAccessForTenant, validateAdminAccessForTenantAsync, validateAdminAccessForTenantAsync, validateBrokerName, validateBundleOwnership, validateBundleOwnershipAsync, validateClusterForTenant, validateClusterForTenantAsync, validateClusterOwnership, validateClusterOwnershipAsync, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleOwnershipAsync, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespaceOperationAsync, validateNamespacePolicyOperation, validateNamespacePolicyOperationAsync, validatePeerClusterConflict, validatePeerClusterConflictAsync, validateSuperUserAccessAsync, validateTenantOperation, validateTenantOperationAsync, validateTopicOperation, validateTopicOperation, validateTopicOperationAsync, validateTopicOperationAsync, validateTopicOwnership, validateTopicOwnershipAsync, validateTopicPolicyOperation, validateTopicPolicyOperationAsync

Methods inherited from class java.lang.Object

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

Constructor Details

SchemasResource

public SchemasResource()

Method Details

getSchema

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

getSchema

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

getAllSchemas

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

deleteSchema

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

postSchema

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

testCompatibility

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

getVersionBySchema

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