io.etcd.jetcd

Interface Auth

All Superinterfaces:

AutoCloseable, CloseableClient

public interface Auth
extends CloseableClient

Interface of auth talking to etcd.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<AuthDisableResponse>	authDisable() disables auth of an etcd cluster.
CompletableFuture<AuthEnableResponse>	authEnable() enables auth of an etcd cluster.
CompletableFuture<AuthRoleAddResponse>	roleAdd(ByteSequence role) adds a new role to an etcd cluster.
CompletableFuture<AuthRoleDeleteResponse>	roleDelete(ByteSequence role) RoleDelete deletes a role.
CompletableFuture<AuthRoleGetResponse>	roleGet(ByteSequence role) gets a detailed information of a role.
CompletableFuture<AuthRoleGrantPermissionResponse>	roleGrantPermission(ByteSequence role, ByteSequence key, ByteSequence rangeEnd, Permission.Type permType) grants a permission to a role.
CompletableFuture<AuthRoleListResponse>	roleList() gets a list of all roles.
CompletableFuture<AuthRoleRevokePermissionResponse>	roleRevokePermission(ByteSequence role, ByteSequence key, ByteSequence rangeEnd) revokes a permission from a role.
CompletableFuture<AuthUserAddResponse>	userAdd(ByteSequence user, ByteSequence password) adds a new user to an etcd cluster.
CompletableFuture<AuthUserChangePasswordResponse>	userChangePassword(ByteSequence user, ByteSequence password) changes a password of a user.
CompletableFuture<AuthUserDeleteResponse>	userDelete(ByteSequence user) deletes a user from an etcd cluster.
CompletableFuture<AuthUserGetResponse>	userGet(ByteSequence user) gets a detailed information of a user.
CompletableFuture<AuthUserGrantRoleResponse>	userGrantRole(ByteSequence user, ByteSequence role) grants a role to a user.
CompletableFuture<AuthUserListResponse>	userList() gets a list of all users.
CompletableFuture<AuthUserRevokeRoleResponse>	userRevokeRole(ByteSequence user, ByteSequence role) revokes a role of a user.

Methods inherited from interface io.etcd.jetcd.support.CloseableClient

close

Method Detail

authEnable

CompletableFuture<AuthEnableResponse> authEnable()

enables auth of an etcd cluster.

Returns:

the response.

authDisable

CompletableFuture<AuthDisableResponse> authDisable()

disables auth of an etcd cluster.

Returns:

the response.

userAdd

CompletableFuture<AuthUserAddResponse> userAdd(ByteSequence user,
                                               ByteSequence password)

adds a new user to an etcd cluster.

Parameters:

user - the user

password - the password

Returns:

the response.

userDelete

CompletableFuture<AuthUserDeleteResponse> userDelete(ByteSequence user)

deletes a user from an etcd cluster.

Parameters:

user - the user

Returns:

the response.

userChangePassword

CompletableFuture<AuthUserChangePasswordResponse> userChangePassword(ByteSequence user,
                                                                     ByteSequence password)

changes a password of a user.

Parameters:

user - the user

password - the password

Returns:

the response.

userGet

CompletableFuture<AuthUserGetResponse> userGet(ByteSequence user)

gets a detailed information of a user.

Parameters:

user - the user

Returns:

the response.

userList

CompletableFuture<AuthUserListResponse> userList()

gets a list of all users.

Returns:

the response.

userGrantRole

CompletableFuture<AuthUserGrantRoleResponse> userGrantRole(ByteSequence user,
                                                           ByteSequence role)

grants a role to a user.

Parameters:

user - the user

role - the role to grant

Returns:

the response.

userRevokeRole

CompletableFuture<AuthUserRevokeRoleResponse> userRevokeRole(ByteSequence user,
                                                             ByteSequence role)

revokes a role of a user.

Parameters:

user - the user

role - the role to revoke

Returns:

the response.

roleAdd

CompletableFuture<AuthRoleAddResponse> roleAdd(ByteSequence role)

adds a new role to an etcd cluster.

Parameters:

role - the role to add

Returns:

the response.

roleGrantPermission

CompletableFuture<AuthRoleGrantPermissionResponse> roleGrantPermission(ByteSequence role,
                                                                       ByteSequence key,
                                                                       ByteSequence rangeEnd,
                                                                       Permission.Type permType)

grants a permission to a role.

Parameters:

role - the role

key - the key

rangeEnd - the range end

permType - the type

Returns:

the response.

roleGet

CompletableFuture<AuthRoleGetResponse> roleGet(ByteSequence role)

gets a detailed information of a role.

Parameters:

role - the role to get

Returns:

the response.

roleList

CompletableFuture<AuthRoleListResponse> roleList()

gets a list of all roles.

Returns:

the response.

roleRevokePermission

CompletableFuture<AuthRoleRevokePermissionResponse> roleRevokePermission(ByteSequence role,
                                                                         ByteSequence key,
                                                                         ByteSequence rangeEnd)

revokes a permission from a role.

Parameters:

role - the role

key - the key

rangeEnd - the range end

Returns:

the response.

roleDelete

CompletableFuture<AuthRoleDeleteResponse> roleDelete(ByteSequence role)

RoleDelete deletes a role.

Parameters:

role - the role to delete.

Returns:

the response.