com.couchbase.client.java.manager.user

Class Role

java.lang.Object

com.couchbase.client.java.manager.user.Role

@Stability.Volatile
public class Role
extends Object

Constructor Summary

Constructors

Constructor and Description
Role(String roleName) Creates a new system-wide role (not specific to a bucket)
Role(String roleName, String bucket) Creates a new role.
Role(String roleName, String bucket, String scope, String collection) Creates a new role.

Method Summary

Modifier and Type	Method and Description
Optional<String>	bucket()
Optional<String>	collection()
boolean	equals(Object o)
String	format()
int	hashCode()
String	name()
Optional<String>	scope()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Role

public Role(String roleName)

Creates a new system-wide role (not specific to a bucket)

Parameters:

roleName - symbolic name of the role

Role

public Role(String roleName,
            String bucket)

Creates a new role. If the bucket parameter is null, a system-wide role is created. Otherwise, the role applies to all scopes and collections within the bucket.

Parameters:

roleName - symbolic name of the role

bucket - (nullable) target of the role, or null for a system-wide role. The special value "*" refers to all buckets.

Role

public Role(String roleName,
            String bucket,
            String scope,
            String collection)

Creates a new role. If all of the nullable parameters are null, a system-wide role is created. Otherwise, the role applies to the specified bucket / scope / collection.

Parameters:

roleName - symbolic name of the role

bucket - (nullable) The bucket this role applies to, or "*" if it applies to all buckets, or null if not applicable.

scope - (nullable) The scope within the bucket, or null or "*" if the role applies to all scopes within the bucket.

collection - (nullable) The collection within the scope, or null or "*" if the role applies to all collections within the scope.

Method Detail

name

public String name()

bucket

public Optional<String> bucket()

scope

public Optional<String> scope()

collection

public Optional<String> collection()

toString

public String toString()

Overrides:

toString in class Object

format

public String format()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object