Package org.apache.kafka.clients.admin

Class KafkaAdminClient

java.lang.Object

org.apache.kafka.clients.admin.AdminClient

org.apache.kafka.clients.admin.KafkaAdminClient

@Evolving
public class KafkaAdminClient
extends AdminClient

The default implementation of AdminClient. An instance of this class is created by invoking one of the create() methods in AdminClient. Users should not refer to this class directly. The API of this class is evolving, see AdminClient for details.

Method Summary

Modifier and Type	Method	Description
AlterConfigsResult	alterConfigs(java.util.Map<ConfigResource,Config> configs, AlterConfigsOptions options)	Update the configuration for the specified resources with the default options.
AlterReplicaLogDirsResult	alterReplicaLogDirs(java.util.Map<TopicPartitionReplica,java.lang.String> replicaAssignment, AlterReplicaLogDirsOptions options)	Change the log directory for the specified replicas.
void	close(long duration, java.util.concurrent.TimeUnit unit)	Close the AdminClient and release all associated resources.
CreateAclsResult	createAcls(java.util.Collection<AclBinding> acls, CreateAclsOptions options)	Creates access control lists (ACLs) which are bound to specific resources.
CreateDelegationTokenResult	createDelegationToken(CreateDelegationTokenOptions options)	Create a Delegation Token.
CreatePartitionsResult	createPartitions(java.util.Map<java.lang.String,NewPartitions> newPartitions, CreatePartitionsOptions options)	Increase the number of partitions of the topics given as the keys of newPartitions according to the corresponding values.
CreateTopicsResult	createTopics(java.util.Collection<NewTopic> newTopics, CreateTopicsOptions options)	Create a batch of new topics.
DeleteAclsResult	deleteAcls(java.util.Collection<AclBindingFilter> filters, DeleteAclsOptions options)	Deletes access control lists (ACLs) according to the supplied filters.
DeleteConsumerGroupsResult	deleteConsumerGroups(java.util.Collection<java.lang.String> groupIds, DeleteConsumerGroupsOptions options)	Delete consumer groups from the cluster.
DeleteRecordsResult	deleteRecords(java.util.Map<TopicPartition,RecordsToDelete> recordsToDelete, DeleteRecordsOptions options)	Delete records whose offset is smaller than the given offset of the corresponding partition.
DeleteTopicsResult	deleteTopics(java.util.Collection<java.lang.String> topicNames, DeleteTopicsOptions options)	Delete a batch of topics.
DescribeAclsResult	describeAcls(AclBindingFilter filter, DescribeAclsOptions options)	Lists access control lists (ACLs) according to the supplied filter.
DescribeClusterResult	describeCluster(DescribeClusterOptions options)	Get information about the nodes in the cluster.
DescribeConfigsResult	describeConfigs(java.util.Collection<ConfigResource> configResources, DescribeConfigsOptions options)	Get the configuration for the specified resources.
DescribeConsumerGroupsResult	describeConsumerGroups(java.util.Collection<java.lang.String> groupIds, DescribeConsumerGroupsOptions options)	Describe some group IDs in the cluster.
DescribeDelegationTokenResult	describeDelegationToken(DescribeDelegationTokenOptions options)	Describe the Delegation Tokens.
DescribeLogDirsResult	describeLogDirs(java.util.Collection<java.lang.Integer> brokers, DescribeLogDirsOptions options)	Query the information of all log directories on the given set of brokers This operation is supported by brokers with version 1.0.0 or higher.
DescribeReplicaLogDirsResult	describeReplicaLogDirs(java.util.Collection<TopicPartitionReplica> replicas, DescribeReplicaLogDirsOptions options)	Query the replica log directory information for the specified replicas.
DescribeTopicsResult	describeTopics(java.util.Collection<java.lang.String> topicNames, DescribeTopicsOptions options)	Describe some topics in the cluster.
ExpireDelegationTokenResult	expireDelegationToken(byte[] hmac, ExpireDelegationTokenOptions options)	Expire a Delegation Token.
ListConsumerGroupOffsetsResult	listConsumerGroupOffsets(java.lang.String groupId, ListConsumerGroupOffsetsOptions options)	List the consumer group offsets available in the cluster.
ListConsumerGroupsResult	listConsumerGroups(ListConsumerGroupsOptions options)	List the consumer groups available in the cluster.
ListTopicsResult	listTopics(ListTopicsOptions options)	List the topics available in the cluster.
RenewDelegationTokenResult	renewDelegationToken(byte[] hmac, RenewDelegationTokenOptions options)	Renew a Delegation Token.

Methods inherited from class org.apache.kafka.clients.admin.AdminClient

alterConfigs, alterReplicaLogDirs, close, create, create, createAcls, createDelegationToken, createPartitions, createTopics, deleteAcls, deleteConsumerGroups, deleteRecords, deleteTopics, describeAcls, describeCluster, describeConfigs, describeConsumerGroups, describeDelegationToken, describeLogDirs, describeReplicaLogDirs, describeTopics, expireDelegationToken, listConsumerGroupOffsets, listConsumerGroups, listTopics, renewDelegationToken

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close(long duration,
                  java.util.concurrent.TimeUnit unit)

Description copied from class: AdminClient

Close the AdminClient and release all associated resources. The close operation has a grace period during which current operations will be allowed to complete, specified by the given duration and time unit. New operations will not be accepted during the grace period. Once the grace period is over, all operations that have not yet been completed will be aborted with a TimeoutException.

Specified by:

close in class AdminClient

Parameters:

duration - The duration to use for the wait time.

unit - The time unit to use for the wait time.

createTopics

public CreateTopicsResult createTopics(java.util.Collection<NewTopic> newTopics,
                                       CreateTopicsOptions options)

Description copied from class: AdminClient

Create a batch of new topics. This operation is not transactional so it may succeed for some topics while fail for others. It may take several seconds after CreateTopicsResult returns success for all the brokers to become aware that the topics have been created. During this time, AdminClient.listTopics() and AdminClient.describeTopics(Collection) may not return information about the new topics. This operation is supported by brokers with version 0.10.1.0 or higher. The validateOnly option is supported from version 0.10.2.0.

Specified by:

createTopics in class AdminClient

Parameters:

newTopics - The new topics to create.

options - The options to use when creating the new topics.

Returns:

The CreateTopicsResult.

deleteTopics

public DeleteTopicsResult deleteTopics(java.util.Collection<java.lang.String> topicNames,
                                       DeleteTopicsOptions options)

Description copied from class: AdminClient

Delete a batch of topics. This operation is not transactional so it may succeed for some topics while fail for others. It may take several seconds after the DeleteTopicsResult returns success for all the brokers to become aware that the topics are gone. During this time, AdminClient#listTopics and AdminClient#describeTopics may continue to return information about the deleted topics. If delete.topic.enable is false on the brokers, deleteTopics will mark the topics for deletion, but not actually delete them. The futures will return successfully in this case. This operation is supported by brokers with version 0.10.1.0 or higher.

Specified by:

deleteTopics in class AdminClient

Parameters:

topicNames - The topic names to delete.

options - The options to use when deleting the topics.

Returns:

The DeleteTopicsResult.

listTopics

public ListTopicsResult listTopics(ListTopicsOptions options)

Description copied from class: AdminClient

List the topics available in the cluster.

Specified by:

listTopics in class AdminClient

Parameters:

options - The options to use when listing the topics.

Returns:

The ListTopicsResult.

describeTopics

public DescribeTopicsResult describeTopics(java.util.Collection<java.lang.String> topicNames,
                                           DescribeTopicsOptions options)

Description copied from class: AdminClient

Describe some topics in the cluster.

Specified by:

describeTopics in class AdminClient

Parameters:

topicNames - The names of the topics to describe.

options - The options to use when describing the topic.

Returns:

The DescribeTopicsResult.

describeCluster

public DescribeClusterResult describeCluster(DescribeClusterOptions options)

Description copied from class: AdminClient

Get information about the nodes in the cluster.

Specified by:

describeCluster in class AdminClient

Parameters:

options - The options to use when getting information about the cluster.

Returns:

The DescribeClusterResult.

describeAcls

public DescribeAclsResult describeAcls(AclBindingFilter filter,
                                       DescribeAclsOptions options)

Description copied from class: AdminClient

Lists access control lists (ACLs) according to the supplied filter. Note: it may take some time for changes made by createAcls or deleteAcls to be reflected in the output of describeAcls. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

describeAcls in class AdminClient

Parameters:

filter - The filter to use.

options - The options to use when listing the ACLs.

Returns:

The DeleteAclsResult.

createAcls

public CreateAclsResult createAcls(java.util.Collection<AclBinding> acls,
                                   CreateAclsOptions options)

Description copied from class: AdminClient

Creates access control lists (ACLs) which are bound to specific resources. This operation is not transactional so it may succeed for some ACLs while fail for others. If you attempt to add an ACL that duplicates an existing ACL, no error will be raised, but no changes will be made. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

createAcls in class AdminClient

Parameters:

acls - The ACLs to create

options - The options to use when creating the ACLs.

Returns:

The CreateAclsResult.

deleteAcls

public DeleteAclsResult deleteAcls(java.util.Collection<AclBindingFilter> filters,
                                   DeleteAclsOptions options)

Description copied from class: AdminClient

Deletes access control lists (ACLs) according to the supplied filters. This operation is not transactional so it may succeed for some ACLs while fail for others. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

deleteAcls in class AdminClient

Parameters:

filters - The filters to use.

options - The options to use when deleting the ACLs.

Returns:

The DeleteAclsResult.

describeConfigs

public DescribeConfigsResult describeConfigs(java.util.Collection<ConfigResource> configResources,
                                             DescribeConfigsOptions options)

Description copied from class: AdminClient

Get the configuration for the specified resources. The returned configuration includes default values and the isDefault() method can be used to distinguish them from user supplied values. The value of config entries where isSensitive() is true is always null so that sensitive information is not disclosed. Config entries where isReadOnly() is true cannot be updated. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

describeConfigs in class AdminClient

Parameters:

configResources - The resources (topic and broker resource types are currently supported)

options - The options to use when describing configs

Returns:

The DescribeConfigsResult

alterConfigs

public AlterConfigsResult alterConfigs(java.util.Map<ConfigResource,Config> configs,
                                       AlterConfigsOptions options)

Description copied from class: AdminClient

Update the configuration for the specified resources with the default options. Updates are not transactional so they may succeed for some resources while fail for others. The configs for a particular resource are updated atomically. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

alterConfigs in class AdminClient

Parameters:

configs - The resources with their configs (topic is the only resource type with configs that can be updated currently)

options - The options to use when describing configs

Returns:

The AlterConfigsResult

alterReplicaLogDirs

public AlterReplicaLogDirsResult alterReplicaLogDirs(java.util.Map<TopicPartitionReplica,java.lang.String> replicaAssignment,
                                                     AlterReplicaLogDirsOptions options)

Description copied from class: AdminClient

Change the log directory for the specified replicas. This API is currently only useful if it is used before the replica has been created on the broker. It will support moving replicas that have already been created after KIP-113 is fully implemented. This operation is not transactional so it may succeed for some replicas while fail for others. This operation is supported by brokers with version 1.0.0 or higher.

Specified by:

alterReplicaLogDirs in class AdminClient

Parameters:

replicaAssignment - The replicas with their log directory absolute path

options - The options to use when changing replica dir

Returns:

The AlterReplicaLogDirsResult

describeLogDirs

public DescribeLogDirsResult describeLogDirs(java.util.Collection<java.lang.Integer> brokers,
                                             DescribeLogDirsOptions options)

Description copied from class: AdminClient

Query the information of all log directories on the given set of brokers This operation is supported by brokers with version 1.0.0 or higher.

Specified by:

describeLogDirs in class AdminClient

Parameters:

brokers - A list of brokers

options - The options to use when querying log dir info

Returns:

The DescribeLogDirsResult

describeReplicaLogDirs

public DescribeReplicaLogDirsResult describeReplicaLogDirs(java.util.Collection<TopicPartitionReplica> replicas,
                                                           DescribeReplicaLogDirsOptions options)

Description copied from class: AdminClient

Query the replica log directory information for the specified replicas. This operation is supported by brokers with version 1.0.0 or higher.

Specified by:

describeReplicaLogDirs in class AdminClient

Parameters:

replicas - The replicas to query

options - The options to use when querying replica log dir info

Returns:

The DescribeReplicaLogDirsResult

createPartitions

public CreatePartitionsResult createPartitions(java.util.Map<java.lang.String,NewPartitions> newPartitions,
                                               CreatePartitionsOptions options)

Description copied from class: AdminClient

Increase the number of partitions of the topics given as the keys of newPartitions according to the corresponding values. If partitions are increased for a topic that has a key, the partition logic or ordering of the messages will be affected.

This operation is not transactional so it may succeed for some topics while fail for others.

It may take several seconds after this method returns success for all the brokers to become aware that the partitions have been created. During this time, AdminClient.describeTopics(Collection) may not return information about the new partitions.

This operation is supported by brokers with version 1.0.0 or higher.

The following exceptions can be anticipated when calling get() on the futures obtained from the values() method of the returned CreatePartitionsResult

• AuthorizationException if the authenticated user is not authorized to alter the topic
• TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().
• ReassignmentInProgressException if a partition reassignment is currently in progress
• BrokerNotAvailableException if the requested NewPartitions.assignments() contain a broker that is currently unavailable.
• InvalidReplicationFactorException if no NewPartitions.assignments() are given and it is impossible for the broker to assign replicas with the topics replication factor.
• Subclasses of KafkaException if the request is invalid in some way.

Specified by:

createPartitions in class AdminClient

Parameters:

newPartitions - The topics which should have new partitions created, and corresponding parameters for the created partitions.

options - The options to use when creating the new paritions.

Returns:

The CreatePartitionsResult.

deleteRecords

public DeleteRecordsResult deleteRecords(java.util.Map<TopicPartition,RecordsToDelete> recordsToDelete,
                                         DeleteRecordsOptions options)

Description copied from class: AdminClient

Delete records whose offset is smaller than the given offset of the corresponding partition. This operation is supported by brokers with version 0.11.0.0 or higher.

Specified by:

deleteRecords in class AdminClient

Parameters:

recordsToDelete - The topic partitions and related offsets from which records deletion starts.

options - The options to use when deleting records.

Returns:

The DeleteRecordsResult.

createDelegationToken

public CreateDelegationTokenResult createDelegationToken(CreateDelegationTokenOptions options)

Description copied from class: AdminClient

Create a Delegation Token.

This operation is supported by brokers with version 1.1.0 or higher.

The following exceptions can be anticipated when calling get() on the futures obtained from the delegationToken() method of the returned CreateDelegationTokenResult

• UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
• InvalidPrincipalTypeException if the renewers principal type is not supported.
• DelegationTokenDisabledException if the delegation token feature is disabled.
• TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().

Specified by:

createDelegationToken in class AdminClient

Parameters:

options - The options to use when creating delegation token.

Returns:

The DeleteRecordsResult.

renewDelegationToken

public RenewDelegationTokenResult renewDelegationToken(byte[] hmac,
                                                       RenewDelegationTokenOptions options)

Description copied from class: AdminClient

Renew a Delegation Token.

This operation is supported by brokers with version 1.1.0 or higher.

The following exceptions can be anticipated when calling get() on the futures obtained from the expiryTimestamp() method of the returned RenewDelegationTokenResult

• UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
• DelegationTokenDisabledException if the delegation token feature is disabled.
• DelegationTokenNotFoundException if the delegation token is not found on server.
• DelegationTokenOwnerMismatchException if the authenticated user is not owner/renewer of the token.
• DelegationTokenExpiredException if the delegation token is expired.
• TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().

Specified by:

renewDelegationToken in class AdminClient

Parameters:

hmac - HMAC of the Delegation token

options - The options to use when renewing delegation token.

Returns:

The RenewDelegationTokenResult.

expireDelegationToken

public ExpireDelegationTokenResult expireDelegationToken(byte[] hmac,
                                                         ExpireDelegationTokenOptions options)

Description copied from class: AdminClient

Expire a Delegation Token.

This operation is supported by brokers with version 1.1.0 or higher.

The following exceptions can be anticipated when calling get() on the futures obtained from the expiryTimestamp() method of the returned ExpireDelegationTokenResult

• UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
• DelegationTokenDisabledException if the delegation token feature is disabled.
• DelegationTokenNotFoundException if the delegation token is not found on server.
• DelegationTokenOwnerMismatchException if the authenticated user is not owner/renewer of the requested token.
• DelegationTokenExpiredException if the delegation token is expired.
• TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().

Specified by:

expireDelegationToken in class AdminClient

Parameters:

hmac - HMAC of the Delegation token

options - The options to use when expiring delegation token.

Returns:

The ExpireDelegationTokenResult.

describeDelegationToken

public DescribeDelegationTokenResult describeDelegationToken(DescribeDelegationTokenOptions options)

Description copied from class: AdminClient

Describe the Delegation Tokens.

This operation is supported by brokers with version 1.1.0 or higher.

The following exceptions can be anticipated when calling get() on the futures obtained from the delegationTokens() method of the returned DescribeDelegationTokenResult

• UnsupportedByAuthenticationException If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.
• DelegationTokenDisabledException if the delegation token feature is disabled.
• TimeoutException if the request was not completed in within the given AbstractOptions.timeoutMs().

Specified by:

describeDelegationToken in class AdminClient

Parameters:

options - The options to use when describing delegation tokens.

Returns:

The DescribeDelegationTokenResult.

describeConsumerGroups

public DescribeConsumerGroupsResult describeConsumerGroups(java.util.Collection<java.lang.String> groupIds,
                                                           DescribeConsumerGroupsOptions options)

Description copied from class: AdminClient

Describe some group IDs in the cluster.

Specified by:

describeConsumerGroups in class AdminClient

Parameters:

groupIds - The IDs of the groups to describe.

options - The options to use when describing the groups.

Returns:

The DescribeConsumerGroupResult.

listConsumerGroups

public ListConsumerGroupsResult listConsumerGroups(ListConsumerGroupsOptions options)

Description copied from class: AdminClient

List the consumer groups available in the cluster.

Specified by:

listConsumerGroups in class AdminClient

Parameters:

options - The options to use when listing the consumer groups.

Returns:

The ListGroupsResult.

listConsumerGroupOffsets

public ListConsumerGroupOffsetsResult listConsumerGroupOffsets(java.lang.String groupId,
                                                               ListConsumerGroupOffsetsOptions options)

Description copied from class: AdminClient

List the consumer group offsets available in the cluster.

Specified by:

listConsumerGroupOffsets in class AdminClient

options - The options to use when listing the consumer group offsets.

Returns:

The ListGroupOffsetsResult

deleteConsumerGroups

public DeleteConsumerGroupsResult deleteConsumerGroups(java.util.Collection<java.lang.String> groupIds,
                                                       DeleteConsumerGroupsOptions options)

Description copied from class: AdminClient

Delete consumer groups from the cluster.

Specified by:

deleteConsumerGroups in class AdminClient

options - The options to use when deleting a consumer group.

Returns:

The DeletConsumerGroupResult.