org.apache.pulsar.client.admin.internal

Class SourcesImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.ComponentResource

org.apache.pulsar.client.admin.internal.SourcesImpl

All Implemented Interfaces:

Source, Sources

public class SourcesImpl
extends ComponentResource
implements Sources, Source

Field Summary

Fields inherited from class org.apache.pulsar.client.admin.internal.BaseResource

auth, readTimeoutMs

Constructor Summary

Constructors

Constructor and Description
SourcesImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, org.asynchttpclient.AsyncHttpClient asyncHttpClient, long readTimeoutMs)

Method Summary

Modifier and Type	Method and Description
void	createSource(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName) Create a new source.
CompletableFuture<Void>	createSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName) Create a new source asynchronously.
void	createSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl) Create a new source with package url.
CompletableFuture<Void>	createSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl) Create a new source with package url asynchronously.
void	deleteSource(String cluster, String namespace, String function) Delete an existing source.
CompletableFuture<Void>	deleteSourceAsync(String tenant, String namespace, String function) Delete an existing source asynchronously.
List<org.apache.pulsar.common.io.ConnectorDefinition>	getBuiltInSources() Fetches a list of supported Pulsar IO sources currently running in cluster mode.
CompletableFuture<List<org.apache.pulsar.common.io.ConnectorDefinition>>	getBuiltInSourcesAsync() Fetches a list of supported Pulsar IO sources currently running in cluster mode asynchronously.
org.apache.pulsar.common.io.SourceConfig	getSource(String tenant, String namespace, String sourceName) Get the configuration for the specified source.
CompletableFuture<org.apache.pulsar.common.io.SourceConfig>	getSourceAsync(String tenant, String namespace, String sourceName) Get the configuration for the specified source asynchronously.
org.apache.pulsar.common.policies.data.SourceStatus	getSourceStatus(String tenant, String namespace, String sourceName) Gets the current status of a source.
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData	getSourceStatus(String tenant, String namespace, String sourceName, int id) Gets the current status of a source instance.
CompletableFuture<org.apache.pulsar.common.policies.data.SourceStatus>	getSourceStatusAsync(String tenant, String namespace, String sourceName) Gets the current status of a source asynchronously.
CompletableFuture<org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData>	getSourceStatusAsync(String tenant, String namespace, String sourceName, int id) Gets the current status of a source instance asynchronously.
List<String>	listSources(String tenant, String namespace) Get the list of sources.
CompletableFuture<List<String>>	listSourcesAsync(String tenant, String namespace) Get the list of sources asynchronously.
void	reloadBuiltInSources() Reload the available built-in connectors, include Source and Source.
CompletableFuture<Void>	reloadBuiltInSourcesAsync() Reload the available built-in connectors, include Source and Source asynchronously.
void	restartSource(String tenant, String namespace, String functionName) Restart all source instances.
void	restartSource(String tenant, String namespace, String functionName, int instanceId) Restart source instance.
CompletableFuture<Void>	restartSourceAsync(String tenant, String namespace, String functionName) Restart all source instances asynchronously.
CompletableFuture<Void>	restartSourceAsync(String tenant, String namespace, String functionName, int instanceId) Restart source instance asynchronously.
void	startSource(String tenant, String namespace, String sourceName) Start all source instances.
void	startSource(String tenant, String namespace, String sourceName, int instanceId) Start source instance.
CompletableFuture<Void>	startSourceAsync(String tenant, String namespace, String sourceName) Start all source instances asynchronously.
CompletableFuture<Void>	startSourceAsync(String tenant, String namespace, String sourceName, int instanceId) Start source instance asynchronously.
void	stopSource(String tenant, String namespace, String sourceName) Stop all source instances.
void	stopSource(String tenant, String namespace, String sourceName, int instanceId) Stop source instance.
CompletableFuture<Void>	stopSourceAsync(String tenant, String namespace, String sourceName) Stop all source instances asynchronously.
CompletableFuture<Void>	stopSourceAsync(String tenant, String namespace, String sourceName, int instanceId) Stop source instance asynchronously.
void	updateSource(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName) Update the configuration for a source.
void	updateSource(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a source.
CompletableFuture<Void>	updateSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName) Update the configuration for a source asynchronously.
CompletableFuture<Void>	updateSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a source asynchronously.
void	updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl) Update the configuration for a source.
void	updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a source.
CompletableFuture<Void>	updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl) Update the configuration for a source asynchronously.
CompletableFuture<Void>	updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a source asynchronously.

Methods inherited from class org.apache.pulsar.client.admin.internal.ComponentResource

addAuthHeaders

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

SourcesImpl

public SourcesImpl(javax.ws.rs.client.WebTarget web,
                   org.apache.pulsar.client.api.Authentication auth,
                   org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                   long readTimeoutMs)

Method Detail

listSources

public List<String> listSources(String tenant,
                                String namespace)
                         throws PulsarAdminException

Description copied from interface: Sources

Get the list of sources.

Get the list of all the Pulsar Sources.

Response Example:

 ["f1", "f2", "f3"]
 

Specified by:

listSources in interface Sources

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

listSourcesAsync

public CompletableFuture<List<String>> listSourcesAsync(String tenant,
                                                        String namespace)

Description copied from interface: Sources

Get the list of sources asynchronously.

Get the list of all the Pulsar Sources.

Response Example:

 ["f1", "f2", "f3"]
 

Specified by:

listSourcesAsync in interface Sources

getSource

public org.apache.pulsar.common.io.SourceConfig getSource(String tenant,
                                                          String namespace,
                                                          String sourceName)
                                                   throws PulsarAdminException

Description copied from interface: Sources

Get the configuration for the specified source.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Specified by:

getSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

Returns:

the source configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getSourceAsync

public CompletableFuture<org.apache.pulsar.common.io.SourceConfig> getSourceAsync(String tenant,
                                                                                  String namespace,
                                                                                  String sourceName)

Description copied from interface: Sources

Get the configuration for the specified source asynchronously.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Specified by:

getSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

Returns:

the source configuration

getSourceStatus

public org.apache.pulsar.common.policies.data.SourceStatus getSourceStatus(String tenant,
                                                                           String namespace,
                                                                           String sourceName)
                                                                    throws PulsarAdminException

Description copied from interface: Sources

Gets the current status of a source.

Specified by:

getSourceStatus in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

Throws:

PulsarAdminException - Unexpected error

getSourceStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.SourceStatus> getSourceStatusAsync(String tenant,
                                                                                                   String namespace,
                                                                                                   String sourceName)

Description copied from interface: Sources

Gets the current status of a source asynchronously.

Specified by:

getSourceStatusAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

getSourceStatus

public org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData getSourceStatus(String tenant,
                                                                                                                         String namespace,
                                                                                                                         String sourceName,
                                                                                                                         int id)
                                                                                                                  throws PulsarAdminException

Description copied from interface: Sources

Gets the current status of a source instance.

Specified by:

getSourceStatus in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

id - Source instance-id

Returns:

Throws:

PulsarAdminException

getSourceStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData> getSourceStatusAsync(String tenant,
                                                                                                                                                 String namespace,
                                                                                                                                                 String sourceName,
                                                                                                                                                 int id)

Description copied from interface: Sources

Gets the current status of a source instance asynchronously.

Specified by:

getSourceStatusAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

id - Source instance-id

Returns:

createSource

public void createSource(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                         String fileName)
                  throws PulsarAdminException

Description copied from interface: Sources

Create a new source.

Specified by:

createSource in interface Sources

Parameters:

sourceConfig - the source configuration object

Throws:

PulsarAdminException - Unexpected error

createSourceAsync

public CompletableFuture<Void> createSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                 String fileName)

Description copied from interface: Sources

Create a new source asynchronously.

Specified by:

createSourceAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

createSourceWithUrl

public void createSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                String pkgUrl)
                         throws PulsarAdminException

Description copied from interface: Sources

Create a new source with package url.

Create a new source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

createSourceWithUrl in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException

createSourceWithUrlAsync

public CompletableFuture<Void> createSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                        String pkgUrl)

Description copied from interface: Sources

Create a new source with package url asynchronously.

Create a new source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

createSourceWithUrlAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

deleteSource

public void deleteSource(String cluster,
                         String namespace,
                         String function)
                  throws PulsarAdminException

Description copied from interface: Sources

Delete an existing source.

Delete a source

Specified by:

deleteSource in interface Sources

Parameters:

cluster - Tenant name

namespace - Namespace name

function - Source name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Cluster does not exist

PulsarAdminException.PreconditionFailedException - Cluster is not empty

PulsarAdminException - Unexpected error

deleteSourceAsync

public CompletableFuture<Void> deleteSourceAsync(String tenant,
                                                 String namespace,
                                                 String function)

Description copied from interface: Sources

Delete an existing source asynchronously.

Delete a source

Specified by:

deleteSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Source name

updateSource

public void updateSource(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                         String fileName,
                         org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                  throws PulsarAdminException

Description copied from interface: Sources

Update the configuration for a source.

Specified by:

updateSource in interface Sources

Parameters:

sourceConfig - the source configuration object

updateOptions - options for the update operations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSourceAsync

public CompletableFuture<Void> updateSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                 String fileName,
                                                 org.apache.pulsar.common.functions.UpdateOptions updateOptions)

Description copied from interface: Sources

Update the configuration for a source asynchronously.

Specified by:

updateSourceAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

updateOptions - options for the update operations

updateSource

public void updateSource(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                         String fileName)
                  throws PulsarAdminException

Description copied from interface: Sources

Update the configuration for a source.

Specified by:

updateSource in interface Sources

Parameters:

sourceConfig - the source configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSourceAsync

public CompletableFuture<Void> updateSourceAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                 String fileName)

Description copied from interface: Sources

Update the configuration for a source asynchronously.

Specified by:

updateSourceAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

updateSourceWithUrl

public void updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                String pkgUrl,
                                org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                         throws PulsarAdminException

Description copied from interface: Sources

Update the configuration for a source.

Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateSourceWithUrl in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSourceWithUrlAsync

public CompletableFuture<Void> updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                        String pkgUrl,
                                                        org.apache.pulsar.common.functions.UpdateOptions updateOptions)

Description copied from interface: Sources

Update the configuration for a source asynchronously.

Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateSourceWithUrlAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

updateSourceWithUrl

public void updateSourceWithUrl(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                String pkgUrl)
                         throws PulsarAdminException

Description copied from interface: Sources

Update the configuration for a source.

Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateSourceWithUrl in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSourceWithUrlAsync

public CompletableFuture<Void> updateSourceWithUrlAsync(org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                                        String pkgUrl)

Description copied from interface: Sources

Update the configuration for a source asynchronously.

Update a source by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateSourceWithUrlAsync in interface Sources

Parameters:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

restartSource

public void restartSource(String tenant,
                          String namespace,
                          String functionName,
                          int instanceId)
                   throws PulsarAdminException

Description copied from interface: Sources

Restart source instance.

Specified by:

restartSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

restartSourceAsync

public CompletableFuture<Void> restartSourceAsync(String tenant,
                                                  String namespace,
                                                  String functionName,
                                                  int instanceId)

Description copied from interface: Sources

Restart source instance asynchronously.

Specified by:

restartSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Source name

instanceId - Source instanceId

restartSource

public void restartSource(String tenant,
                          String namespace,
                          String functionName)
                   throws PulsarAdminException

Description copied from interface: Sources

Restart all source instances.

Specified by:

restartSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Source name

Throws:

PulsarAdminException - Unexpected error

restartSourceAsync

public CompletableFuture<Void> restartSourceAsync(String tenant,
                                                  String namespace,
                                                  String functionName)

Description copied from interface: Sources

Restart all source instances asynchronously.

Specified by:

restartSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Source name

stopSource

public void stopSource(String tenant,
                       String namespace,
                       String sourceName,
                       int instanceId)
                throws PulsarAdminException

Description copied from interface: Sources

Stop source instance.

Specified by:

stopSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

stopSourceAsync

public CompletableFuture<Void> stopSourceAsync(String tenant,
                                               String namespace,
                                               String sourceName,
                                               int instanceId)

Description copied from interface: Sources

Stop source instance asynchronously.

Specified by:

stopSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

instanceId - Source instanceId

stopSource

public void stopSource(String tenant,
                       String namespace,
                       String sourceName)
                throws PulsarAdminException

Description copied from interface: Sources

Stop all source instances.

Specified by:

stopSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

Throws:

PulsarAdminException - Unexpected error

stopSourceAsync

public CompletableFuture<Void> stopSourceAsync(String tenant,
                                               String namespace,
                                               String sourceName)

Description copied from interface: Sources

Stop all source instances asynchronously.

Specified by:

stopSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

startSource

public void startSource(String tenant,
                        String namespace,
                        String sourceName,
                        int instanceId)
                 throws PulsarAdminException

Description copied from interface: Sources

Start source instance.

Specified by:

startSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

startSourceAsync

public CompletableFuture<Void> startSourceAsync(String tenant,
                                                String namespace,
                                                String sourceName,
                                                int instanceId)

Description copied from interface: Sources

Start source instance asynchronously.

Specified by:

startSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

instanceId - Source instanceId

startSource

public void startSource(String tenant,
                        String namespace,
                        String sourceName)
                 throws PulsarAdminException

Description copied from interface: Sources

Start all source instances.

Specified by:

startSource in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

Throws:

PulsarAdminException - Unexpected error

startSourceAsync

public CompletableFuture<Void> startSourceAsync(String tenant,
                                                String namespace,
                                                String sourceName)

Description copied from interface: Sources

Start all source instances asynchronously.

Specified by:

startSourceAsync in interface Sources

Parameters:

tenant - Tenant name

namespace - Namespace name

sourceName - Source name

getBuiltInSources

public List<org.apache.pulsar.common.io.ConnectorDefinition> getBuiltInSources()
                                                                        throws PulsarAdminException

Description copied from interface: Sources

Fetches a list of supported Pulsar IO sources currently running in cluster mode.

Specified by:

getBuiltInSources in interface Sources

Throws:

PulsarAdminException - Unexpected error

getBuiltInSourcesAsync

public CompletableFuture<List<org.apache.pulsar.common.io.ConnectorDefinition>> getBuiltInSourcesAsync()

Description copied from interface: Sources

Fetches a list of supported Pulsar IO sources currently running in cluster mode asynchronously.

Specified by:

getBuiltInSourcesAsync in interface Sources

reloadBuiltInSources

public void reloadBuiltInSources()
                          throws PulsarAdminException

Description copied from interface: Sources

Reload the available built-in connectors, include Source and Source.

Specified by:

reloadBuiltInSources in interface Sources

Throws:

PulsarAdminException - Unexpected error

reloadBuiltInSourcesAsync

public CompletableFuture<Void> reloadBuiltInSourcesAsync()

Description copied from interface: Sources

Reload the available built-in connectors, include Source and Source asynchronously.

Specified by:

reloadBuiltInSourcesAsync in interface Sources