Package org.apache.pulsar.client.admin.internal

Class PulsarAdminImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.PulsarAdminImpl

All Implemented Interfaces:

Closeable, AutoCloseable, PulsarAdmin

public class PulsarAdminImpl
extends Object
implements PulsarAdmin

Pulsar client admin API client.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.pulsar.client.api.Authentication	auth
static final int	DEFAULT_REQUEST_TIMEOUT_SECONDS
protected final javax.ws.rs.client.WebTarget	root

Constructor Summary

Constructors

Constructor	Description
PulsarAdminImpl(String serviceUrl, ClientConfigurationData clientConfigData, ClassLoader clientBuilderClassLoader)
PulsarAdminImpl(URL serviceUrl, String authPluginClassName, String authParamsString)	Deprecated. Since 2.0.
PulsarAdminImpl(URL serviceUrl, String authPluginClassName, Map<String,String> authParams)	Deprecated. Since 2.0.
PulsarAdminImpl(URL serviceUrl, org.apache.pulsar.client.api.Authentication auth)	Deprecated. Since 2.0.

Method Summary

Modifier and Type	Method	Description
Bookies	bookies()
Brokers	brokers()
BrokerStats	brokerStats()
void	close()	Close the Pulsar admin client to release all the resources.
Clusters	clusters()
Functions	functions()
ClientConfigurationData	getClientConfigData()
String	getServiceUrl()
Lookup	lookups()
Namespaces	namespaces()
NonPersistentTopics	nonPersistentTopics()	Deprecated. Since 2.0.
Packages	packages()
Properties	properties()	Deprecated. since 2.0.
ProxyStats	proxyStats()
ResourceGroups	resourcegroups()
ResourceQuotas	resourceQuotas()
Schemas	schemas()
Sink	sink()	Deprecated. in favor of sinks
Sinks	sinks()
Source	source()	Deprecated. in favor of sources()
Sources	sources()
Tenants	tenants()
TopicPolicies	topicPolicies()
TopicPolicies	topicPolicies(boolean isGlobal)
Topics	topics()
Transactions	transactions()
Worker	worker()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REQUEST_TIMEOUT_SECONDS

public static final int DEFAULT_REQUEST_TIMEOUT_SECONDS

See Also:

• Constant Field Values

root

protected final javax.ws.rs.client.WebTarget root

auth

protected final org.apache.pulsar.client.api.Authentication auth

Constructor Details

PulsarAdminImpl

public PulsarAdminImpl(String serviceUrl,
 ClientConfigurationData clientConfigData,
 ClassLoader clientBuilderClassLoader)
                throws org.apache.pulsar.client.api.PulsarClientException

Throws:

org.apache.pulsar.client.api.PulsarClientException

PulsarAdminImpl

@Deprecated
public PulsarAdminImpl(URL serviceUrl,
 org.apache.pulsar.client.api.Authentication auth)
                throws org.apache.pulsar.client.api.PulsarClientException

Deprecated.

Since 2.0. Use PulsarAdmin.builder() to construct a new PulsarAdmin instance.

Construct a new Pulsar Admin client object.

This client object can be used to perform many subsquent API calls

Parameters:

serviceUrl - the Pulsar service URL (eg. 'http://my-broker.example.com:8080')

auth - the Authentication object to be used to talk with Pulsar

Throws:

org.apache.pulsar.client.api.PulsarClientException

PulsarAdminImpl

@Deprecated
public PulsarAdminImpl(URL serviceUrl,
 String authPluginClassName,
 String authParamsString)
                throws org.apache.pulsar.client.api.PulsarClientException

Deprecated.

Since 2.0. Use PulsarAdmin.builder() to construct a new PulsarAdmin instance.

Construct a new Pulsar Admin client object.

This client object can be used to perform many subsquent API calls

Parameters:

serviceUrl - the Pulsar URL (eg. 'http://my-broker.example.com:8080')

authPluginClassName - name of the Authentication-Plugin you want to use

authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"

Throws:

org.apache.pulsar.client.api.PulsarClientException

PulsarAdminImpl

@Deprecated
public PulsarAdminImpl(URL serviceUrl,
 String authPluginClassName,
 Map<String,String> authParams)
                throws org.apache.pulsar.client.api.PulsarClientException

Deprecated.

Since 2.0. Use PulsarAdmin.builder() to construct a new PulsarAdmin instance.

Construct a new Pulsar Admin client object.

This client object can be used to perform many subsquent API calls

Parameters:

serviceUrl - the Pulsar URL (eg. 'http://my-broker.example.com:8080')

authPluginClassName - name of the Authentication-Plugin you want to use

authParams - map which represents parameters for the Authentication-Plugin

Throws:

org.apache.pulsar.client.api.PulsarClientException

Method Details

clusters

public Clusters clusters()

Specified by:

clusters in interface PulsarAdmin

Returns:

the clusters management object

brokers

public Brokers brokers()

Specified by:

brokers in interface PulsarAdmin

Returns:

the brokers management object

tenants

public Tenants tenants()

Specified by:

tenants in interface PulsarAdmin

Returns:

the tenants management object

resourcegroups

public ResourceGroups resourcegroups()

Specified by:

resourcegroups in interface PulsarAdmin

Returns:

the resourcegroups management object

properties

@Deprecated
public Properties properties()

Deprecated.

since 2.0. See tenants()

Specified by:

properties in interface PulsarAdmin

namespaces

public Namespaces namespaces()

Specified by:

namespaces in interface PulsarAdmin

Returns:

the namespaces management object

topics

public Topics topics()

Specified by:

topics in interface PulsarAdmin

topicPolicies

public TopicPolicies topicPolicies()

Specified by:

topicPolicies in interface PulsarAdmin

topicPolicies

public TopicPolicies topicPolicies(boolean isGlobal)

Specified by:

topicPolicies in interface PulsarAdmin

bookies

public Bookies bookies()

Specified by:

bookies in interface PulsarAdmin

Returns:

the bookies management object

nonPersistentTopics

@Deprecated
public NonPersistentTopics nonPersistentTopics()

Deprecated.

Since 2.0. See topics()

Specified by:

nonPersistentTopics in interface PulsarAdmin

Returns:

the persistentTopics management object

resourceQuotas

public ResourceQuotas resourceQuotas()

Specified by:

resourceQuotas in interface PulsarAdmin

Returns:

the resource quota management object

lookups

public Lookup lookups()

Specified by:

lookups in interface PulsarAdmin

Returns:

does a looks up for the broker serving the topic

functions

public Functions functions()

Specified by:

functions in interface PulsarAdmin

Returns:

the functions management object

source

@Deprecated
public Source source()

Deprecated.

in favor of sources()

Specified by:

source in interface PulsarAdmin

Returns:

the sources management object

sources

public Sources sources()

Specified by:

sources in interface PulsarAdmin

sink

@Deprecated
public Sink sink()

Deprecated.

in favor of sinks

Specified by:

sink in interface PulsarAdmin

Returns:

the sinks management object

sinks

public Sinks sinks()

Specified by:

sinks in interface PulsarAdmin

Returns:

the sinks management object

worker

public Worker worker()

Specified by:

worker in interface PulsarAdmin

Returns:

the Worker stats

brokerStats

public BrokerStats brokerStats()

Specified by:

brokerStats in interface PulsarAdmin

Returns:

the broker statics

proxyStats

public ProxyStats proxyStats()

Specified by:

proxyStats in interface PulsarAdmin

Returns:

the proxy statics

getServiceUrl

public String getServiceUrl()

Specified by:

getServiceUrl in interface PulsarAdmin

Returns:

the service HTTP URL that is being used

getClientConfigData

public ClientConfigurationData getClientConfigData()

Returns:

the client Configuration Data that is being used

schemas

public Schemas schemas()

Specified by:

schemas in interface PulsarAdmin

Returns:

the schemas

packages

public Packages packages()

Specified by:

packages in interface PulsarAdmin

Returns:

the packages management object

transactions

public Transactions transactions()

Specified by:

transactions in interface PulsarAdmin

close

public void close()

Close the Pulsar admin client to release all the resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface PulsarAdmin