Uses of Class org.apache.cassandra.auth.RoleResource (apache-cassandra API)
Date: 2018-02-14

## Uses of Class
org.apache.cassandra.auth.RoleResource

- Packages that use RoleResource
  Package | Description
  --- | ---
  org.apache.cassandra.auth |
  org.apache.cassandra.auth.jmx |
  org.apache.cassandra.cql3.statements |

- - ### Uses of RoleResource in org.apache.cassandra.auth

    Methods in org.apache.cassandra.auth that return RoleResource
    Modifier and Type | Method and Description
    --- | ---
    `static RoleResource` | RoleResource.`fromName(java.lang.String name)` Parses a role resource name into a RoleResource instance.
    `RoleResource` | AuthenticatedUser.`getPrimaryRole()`
    `static RoleResource` | RoleResource.`role(java.lang.String name)` Creates a RoleResource representing an individual Role.
    `static RoleResource` | RoleResource.`root()`

    Methods in org.apache.cassandra.auth that return types with arguments of type RoleResource
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<RoleResource>` | CassandraRoleManager.`getAllRoles()`
    `java.util.Set<RoleResource>` | IRoleManager.`getAllRoles()` Called during the execution of an unqualified LIST ROLES query.
    `java.util.Set<RoleResource>` | AuthenticatedUser.`getRoles()` Get the roles that have been granted to the user via the IRoleManager
    `static java.util.Set<RoleResource>` | Roles.`getRoles(RoleResource primaryRole)` Get all roles granted to the supplied Role, including both directly granted and inherited roles.
    `java.util.Set<RoleResource>` | RolesCache.`getRoles(RoleResource role)`
    `java.util.Set<RoleResource>` | CassandraRoleManager.`getRoles(RoleResource grantee, boolean includeInherited)`
    `java.util.Set<RoleResource>` | IRoleManager.`getRoles(RoleResource grantee, boolean includeInherited)` Called during execution of a LIST ROLES query.

    Methods in org.apache.cassandra.auth with parameters of type RoleResource
    Modifier and Type | Method and Description
    --- | ---
    `void` | CassandraRoleManager.`alterRole(AuthenticatedUser performer, RoleResource role, RoleOptions options)`
    `void` | IRoleManager.`alterRole(AuthenticatedUser performer, RoleResource role, RoleOptions options)` Called during execution of ALTER ROLE statement.
    `boolean` | CassandraRoleManager.`canLogin(RoleResource role)`
    `boolean` | IRoleManager.`canLogin(RoleResource role)` Return true if there exists a Role with the given name which has login privileges.
    `int` | RoleResource.`compareTo(RoleResource o)`
    `void` | CassandraRoleManager.`createRole(AuthenticatedUser performer, RoleResource role, RoleOptions options)`
    `void` | IRoleManager.`createRole(AuthenticatedUser performer, RoleResource role, RoleOptions options)` Called during execution of a CREATE ROLE statement.
    `void` | CassandraRoleManager.`dropRole(AuthenticatedUser performer, RoleResource role)`
    `void` | IRoleManager.`dropRole(AuthenticatedUser performer, RoleResource role)` Called during execution of DROP ROLE statement, as well we removing any main record of the role from the system this implies that we want to revoke this role from all other roles that it has been granted to.
    `java.util.Map<java.lang.String,java.lang.String>` | CassandraRoleManager.`getCustomOptions(RoleResource role)`
    `java.util.Map<java.lang.String,java.lang.String>` | IRoleManager.`getCustomOptions(RoleResource role)` Where an implementation supports OPTIONS in CREATE and ALTER operations this method should return the `Map<String, String>` representing the custom options associated with the role, as supplied to CREATE or ALTER.
    `static java.util.Set<RoleResource>` | Roles.`getRoles(RoleResource primaryRole)` Get all roles granted to the supplied Role, including both directly granted and inherited roles.
    `java.util.Set<RoleResource>` | RolesCache.`getRoles(RoleResource role)`
    `java.util.Set<RoleResource>` | CassandraRoleManager.`getRoles(RoleResource grantee, boolean includeInherited)`
    `java.util.Set<RoleResource>` | IRoleManager.`getRoles(RoleResource grantee, boolean includeInherited)` Called during execution of a LIST ROLES query.
    `void` | AllowAllAuthorizer.`grant(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource to)`
    `void` | CassandraAuthorizer.`grant(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)`
    `void` | IAuthorizer.`grant(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)` Grants a set of permissions on a resource to a role.
    `void` | CassandraRoleManager.`grantRole(AuthenticatedUser performer, RoleResource role, RoleResource grantee)`
    `void` | IRoleManager.`grantRole(AuthenticatedUser performer, RoleResource role, RoleResource grantee)` Called during execution of GRANT ROLE query.
    `static boolean` | Roles.`hasSuperuserStatus(RoleResource role)` Returns true if the supplied role or any other role granted to it (directly or indirectly) has superuser status.
    `boolean` | CassandraRoleManager.`isExistingRole(RoleResource role)`
    `boolean` | IRoleManager.`isExistingRole(RoleResource role)` Return true is a Role with the given name exists in the system.
    `boolean` | CassandraRoleManager.`isSuper(RoleResource role)`
    `boolean` | IRoleManager.`isSuper(RoleResource role)` Return true if there exists a Role with the given name that also has superuser status.
    `java.util.Set<PermissionDetails>` | AllowAllAuthorizer.`list(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource of)`
    `java.util.Set<PermissionDetails>` | CassandraAuthorizer.`list(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)`
    `java.util.Set<PermissionDetails>` | IAuthorizer.`list(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource grantee)` Returns a list of permissions on a resource granted to a role.
    `void` | AllowAllAuthorizer.`revoke(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource from)`
    `void` | CassandraAuthorizer.`revoke(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource revokee)`
    `void` | IAuthorizer.`revoke(AuthenticatedUser performer, java.util.Set<Permission> permissions, IResource resource, RoleResource revokee)` Revokes a set of permissions on a resource from a user.
    `void` | AllowAllAuthorizer.`revokeAllFrom(RoleResource droppedRole)`
    `void` | CassandraAuthorizer.`revokeAllFrom(RoleResource revokee)`
    `void` | IAuthorizer.`revokeAllFrom(RoleResource revokee)` Called before deleting a role with DROP ROLE statement (or the alias provided for compatibility, DROP USER) so that a new role with the same name wouldn't inherit permissions of the deleted one in the future.
    `void` | CassandraRoleManager.`revokeRole(AuthenticatedUser performer, RoleResource role, RoleResource revokee)`
    `void` | IRoleManager.`revokeRole(AuthenticatedUser performer, RoleResource role, RoleResource revokee)` Called during the execution of a REVOKE ROLE query.

  - ### Uses of RoleResource in org.apache.cassandra.auth.jmx

    Fields in org.apache.cassandra.auth.jmx with type parameters of type RoleResource
    Modifier and Type | Field and Description
    --- | ---
    `protected java.util.function.Function<RoleResource,java.util.Set<PermissionDetails>>` | AuthorizationProxy.`getPermissions`
    `protected java.util.function.Function<RoleResource,java.lang.Boolean>` | AuthorizationProxy.`isSuperuser`

  - ### Uses of RoleResource in org.apache.cassandra.cql3.statements

    Fields in org.apache.cassandra.cql3.statements declared as RoleResource
    Modifier and Type | Field and Description
    --- | ---
    `protected RoleResource` | PermissionsManagementStatement.`grantee`
    `protected RoleResource` | RoleManagementStatement.`grantee`
    `protected RoleResource` | RoleManagementStatement.`role`

    Methods in org.apache.cassandra.cql3.statements with parameters of type RoleResource
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthenticationStatement.`checkPermission(ClientState state, Permission required, RoleResource resource)`

    Method parameters in org.apache.cassandra.cql3.statements with type arguments of type RoleResource
    Modifier and Type | Method and Description
    --- | ---
    `protected ResultMessage` | ListRolesStatement.`formatResults(java.util.List<RoleResource> sortedRoles)`
    `protected ResultMessage` | ListUsersStatement.`formatResults(java.util.List<RoleResource> sortedRoles)`

Copyright © 2018 The Apache Software Foundation