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

Class PulsarAdminImpl

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, org.apache.pulsar.client.admin.PulsarAdmin
    public class PulsarAdminImpl
extends java.lang.Object
implements org.apache.pulsar.client.admin.PulsarAdmin
    Pulsar client admin API client.

    • Constructor Summary

      Constructors 
      Constructor Description
      PulsarAdminImpl​(java.lang.String serviceUrl, org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData)  
      PulsarAdminImpl​(java.lang.String serviceUrl, org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData, int connectTimeout, java.util.concurrent.TimeUnit connectTimeoutUnit, int readTimeout, java.util.concurrent.TimeUnit readTimeoutUnit, int requestTimeout, java.util.concurrent.TimeUnit requestTimeoutUnit, int autoCertRefreshTime, java.util.concurrent.TimeUnit autoCertRefreshTimeUnit, java.lang.ClassLoader clientBuilderClassLoader)  
      PulsarAdminImpl​(java.net.URL serviceUrl, java.lang.String authPluginClassName, java.lang.String authParamsString)
      Deprecated.
      Since 2.0.
      PulsarAdminImpl​(java.net.URL serviceUrl, java.lang.String authPluginClassName, java.util.Map<java.lang.String,​java.lang.String> authParams)
      Deprecated.
      Since 2.0.
      PulsarAdminImpl​(java.net.URL serviceUrl, org.apache.pulsar.client.api.Authentication auth)
      Deprecated.
      Since 2.0.

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_CONNECT_TIMEOUT_SECONDS

        public static final int DEFAULT_CONNECT_TIMEOUT_SECONDS
        See Also:
        Constant Field Values

      • DEFAULT_READ_TIMEOUT_SECONDS

        public static final int DEFAULT_READ_TIMEOUT_SECONDS
        See Also:
        Constant Field Values

      • DEFAULT_REQUEST_TIMEOUT_SECONDS

        public static final int DEFAULT_REQUEST_TIMEOUT_SECONDS
        See Also:
        Constant Field Values

      • DEFAULT_CERT_REFRESH_SECONDS

        public static final int DEFAULT_CERT_REFRESH_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 Detail

      • PulsarAdminImpl

        public PulsarAdminImpl​(java.lang.String serviceUrl,
                       org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData)
                throws org.apache.pulsar.client.api.PulsarClientException
        Throws:
        org.apache.pulsar.client.api.PulsarClientException

      • PulsarAdminImpl

        public PulsarAdminImpl​(java.lang.String serviceUrl,
                       org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData,
                       int connectTimeout,
                       java.util.concurrent.TimeUnit connectTimeoutUnit,
                       int readTimeout,
                       java.util.concurrent.TimeUnit readTimeoutUnit,
                       int requestTimeout,
                       java.util.concurrent.TimeUnit requestTimeoutUnit,
                       int autoCertRefreshTime,
                       java.util.concurrent.TimeUnit autoCertRefreshTimeUnit,
                       java.lang.ClassLoader clientBuilderClassLoader)
                throws org.apache.pulsar.client.api.PulsarClientException
        Throws:
        org.apache.pulsar.client.api.PulsarClientException

      • PulsarAdminImpl

        @Deprecated
public PulsarAdminImpl​(java.net.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​(java.net.URL serviceUrl,
                       java.lang.String authPluginClassName,
                       java.lang.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​(java.net.URL serviceUrl,
                       java.lang.String authPluginClassName,
                       java.util.Map<java.lang.String,​java.lang.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 Detail

      • clusters

        public org.apache.pulsar.client.admin.Clusters clusters()
        Specified by:
        clusters in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the clusters management object

      • brokers

        public org.apache.pulsar.client.admin.Brokers brokers()
        Specified by:
        brokers in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the brokers management object

      • tenants

        public org.apache.pulsar.client.admin.Tenants tenants()
        Specified by:
        tenants in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the tenants management object

      • resourcegroups

        public org.apache.pulsar.client.admin.ResourceGroups resourcegroups()
        Specified by:
        resourcegroups in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the resourcegroups management object

      • properties

        @Deprecated
public org.apache.pulsar.client.admin.Properties properties()
        Deprecated.
        since 2.0. See tenants()
        Specified by:
        properties in interface org.apache.pulsar.client.admin.PulsarAdmin

      • namespaces

        public org.apache.pulsar.client.admin.Namespaces namespaces()
        Specified by:
        namespaces in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the namespaces management object

      • topics

        public org.apache.pulsar.client.admin.Topics topics()
        Specified by:
        topics in interface org.apache.pulsar.client.admin.PulsarAdmin

      • topicPolicies

        public org.apache.pulsar.client.admin.TopicPolicies topicPolicies()
        Specified by:
        topicPolicies in interface org.apache.pulsar.client.admin.PulsarAdmin

      • topicPolicies

        public org.apache.pulsar.client.admin.TopicPolicies topicPolicies​(boolean isGlobal)
        Specified by:
        topicPolicies in interface org.apache.pulsar.client.admin.PulsarAdmin

      • bookies

        public org.apache.pulsar.client.admin.Bookies bookies()
        Specified by:
        bookies in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the bookies management object

      • nonPersistentTopics

        @Deprecated
public org.apache.pulsar.client.admin.NonPersistentTopics nonPersistentTopics()
        Deprecated.
        Since 2.0. See topics()
        Specified by:
        nonPersistentTopics in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the persistentTopics management object

      • resourceQuotas

        public org.apache.pulsar.client.admin.ResourceQuotas resourceQuotas()
        Specified by:
        resourceQuotas in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the resource quota management object

      • lookups

        public org.apache.pulsar.client.admin.Lookup lookups()
        Specified by:
        lookups in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        does a looks up for the broker serving the topic

      • functions

        public org.apache.pulsar.client.admin.Functions functions()
        Specified by:
        functions in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the functions management object

      • source

        @Deprecated
public org.apache.pulsar.client.admin.Source source()
        Deprecated.
        in favor of sources()
        Specified by:
        source in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the sources management object

      • sources

        public org.apache.pulsar.client.admin.Sources sources()
        Specified by:
        sources in interface org.apache.pulsar.client.admin.PulsarAdmin

      • sink

        @Deprecated
public org.apache.pulsar.client.admin.Sink sink()
        Deprecated.
        in favor of sinks
        Specified by:
        sink in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the sinks management object

      • sinks

        public org.apache.pulsar.client.admin.Sinks sinks()
        Specified by:
        sinks in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the sinks management object

      • worker

        public org.apache.pulsar.client.admin.Worker worker()
        Specified by:
        worker in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the Worker stats

      • brokerStats

        public org.apache.pulsar.client.admin.BrokerStats brokerStats()
        Specified by:
        brokerStats in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the broker statics

      • proxyStats

        public org.apache.pulsar.client.admin.ProxyStats proxyStats()
        Specified by:
        proxyStats in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the proxy statics

      • getServiceUrl

        public java.lang.String getServiceUrl()
        Specified by:
        getServiceUrl in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the service HTTP URL that is being used

      • getClientConfigData

        public org.apache.pulsar.client.impl.conf.ClientConfigurationData getClientConfigData()
        Returns:
        the client Configuration Data that is being used

      • schemas

        public org.apache.pulsar.client.admin.Schemas schemas()
        Specified by:
        schemas in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the schemas

      • packages

        public org.apache.pulsar.client.admin.Packages packages()
        Specified by:
        packages in interface org.apache.pulsar.client.admin.PulsarAdmin
        Returns:
        the packages management object

      • transactions

        public org.apache.pulsar.client.admin.Transactions transactions()
        Specified by:
        transactions in interface org.apache.pulsar.client.admin.PulsarAdmin

      • close

        public void close()
        Close the Pulsar admin client to release all the resources.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface org.apache.pulsar.client.admin.PulsarAdmin