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

## Uses of Class
org.apache.cassandra.service.ClientState

- Packages that use ClientState
  Package | Description
  --- | ---
  org.apache.cassandra.cql3 |
  org.apache.cassandra.cql3.statements |
  org.apache.cassandra.db |
  org.apache.cassandra.service |
  org.apache.cassandra.service.pager |
  org.apache.cassandra.thrift |

- - ### Uses of ClientState in org.apache.cassandra.cql3

    Methods in org.apache.cassandra.cql3 with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `void` | CQLStatement.`checkAccess(ClientState state)` Perform any access verification necessary for the statement.
    `static ParsedStatement.Prepared` | QueryProcessor.`getStatement(java.lang.String queryStr, ClientState clientState)`
    `static ResultMessage.Prepared` | QueryProcessor.`prepare(java.lang.String queryString, ClientState clientState, boolean forThrift)`
    `void` | CQLStatement.`validate(ClientState state)` Perform additional validation required by the statment.

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

    Methods in org.apache.cassandra.cql3.statements with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `void` | AlterKeyspaceStatement.`checkAccess(ClientState state)`
    `void` | AlterRoleStatement.`checkAccess(ClientState state)`
    `void` | AlterTableStatement.`checkAccess(ClientState state)`
    `void` | AlterTypeStatement.`checkAccess(ClientState state)`
    `void` | AlterViewStatement.`checkAccess(ClientState state)`
    `void` | BatchStatement.`checkAccess(ClientState state)`
    `void` | CreateAggregateStatement.`checkAccess(ClientState state)`
    `void` | CreateFunctionStatement.`checkAccess(ClientState state)`
    `void` | CreateIndexStatement.`checkAccess(ClientState state)`
    `void` | CreateKeyspaceStatement.`checkAccess(ClientState state)`
    `void` | CreateRoleStatement.`checkAccess(ClientState state)`
    `void` | CreateTableStatement.`checkAccess(ClientState state)`
    `void` | CreateTriggerStatement.`checkAccess(ClientState state)`
    `void` | CreateTypeStatement.`checkAccess(ClientState state)`
    `void` | CreateViewStatement.`checkAccess(ClientState state)`
    `void` | DropAggregateStatement.`checkAccess(ClientState state)`
    `void` | DropFunctionStatement.`checkAccess(ClientState state)`
    `void` | DropIndexStatement.`checkAccess(ClientState state)`
    `void` | DropKeyspaceStatement.`checkAccess(ClientState state)`
    `void` | DropRoleStatement.`checkAccess(ClientState state)`
    `void` | DropTableStatement.`checkAccess(ClientState state)`
    `void` | DropTriggerStatement.`checkAccess(ClientState state)`
    `void` | DropTypeStatement.`checkAccess(ClientState state)`
    `void` | DropViewStatement.`checkAccess(ClientState state)`
    `void` | ListPermissionsStatement.`checkAccess(ClientState state)`
    `void` | ListRolesStatement.`checkAccess(ClientState state)`
    `void` | ModificationStatement.`checkAccess(ClientState state)`
    `void` | PermissionsManagementStatement.`checkAccess(ClientState state)`
    `void` | RoleManagementStatement.`checkAccess(ClientState state)`
    `void` | SelectStatement.`checkAccess(ClientState state)`
    `void` | TruncateStatement.`checkAccess(ClientState state)`
    `void` | UseStatement.`checkAccess(ClientState state)`
    `void` | AuthenticationStatement.`checkPermission(ClientState state, Permission required, RoleResource resource)`
    `ResultMessage` | AlterRoleStatement.`execute(ClientState state)`
    `abstract ResultMessage` | AuthenticationStatement.`execute(ClientState state)`
    `abstract ResultMessage` | AuthorizationStatement.`execute(ClientState state)`
    `ResultMessage` | CreateRoleStatement.`execute(ClientState state)`
    `ResultMessage` | DropRoleStatement.`execute(ClientState state)`
    `ResultMessage` | GrantPermissionsStatement.`execute(ClientState state)`
    `ResultMessage` | GrantRoleStatement.`execute(ClientState state)`
    `ResultMessage` | ListPermissionsStatement.`execute(ClientState state)`
    `ResultMessage` | ListRolesStatement.`execute(ClientState state)`
    `ResultMessage` | RevokePermissionsStatement.`execute(ClientState state)`
    `ResultMessage` | RevokeRoleStatement.`execute(ClientState state)`
    `static IResource` | AuthorizationStatement.`maybeCorrectResource(IResource resource, ClientState state)`
    `ParsedStatement.Prepared` | SelectStatement.RawStatement.`prepare(boolean forView, ClientState clientState)`
    `ParsedStatement.Prepared` | AuthenticationStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | AuthorizationStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | BatchStatement.Parsed.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | CreateAggregateStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | CreateFunctionStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | CreateTableStatement.RawStatement.`prepare(ClientState clientState)` Transform this raw statement into a CreateTableStatement.
    `ParsedStatement.Prepared` | DropFunctionStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | ModificationStatement.Parsed.`prepare(ClientState clientState)`
    `abstract ParsedStatement.Prepared` | ParsedStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | SchemaAlteringStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | SelectStatement.RawStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | TruncateStatement.`prepare(ClientState clientState)`
    `ParsedStatement.Prepared` | UseStatement.`prepare(ClientState clientState)`
    `ModificationStatement` | ModificationStatement.Parsed.`prepare(VariableSpecifications boundNames, ClientState clientState)`
    `void` | AlterTypeStatement.`prepareKeyspace(ClientState state)`
    `void` | BatchStatement.Parsed.`prepareKeyspace(ClientState state)`
    `void` | CFStatement.`prepareKeyspace(ClientState state)`
    `void` | CreateAggregateStatement.`prepareKeyspace(ClientState state)`
    `void` | CreateFunctionStatement.`prepareKeyspace(ClientState state)`
    `void` | CreateTypeStatement.`prepareKeyspace(ClientState state)`
    `void` | DropAggregateStatement.`prepareKeyspace(ClientState state)`
    `void` | DropFunctionStatement.`prepareKeyspace(ClientState state)`
    `void` | DropTypeStatement.`prepareKeyspace(ClientState state)`
    `void` | SchemaAlteringStatement.`prepareKeyspace(ClientState state)`
    `void` | AlterKeyspaceStatement.`validate(ClientState state)`
    `void` | AlterRoleStatement.`validate(ClientState state)`
    `void` | AlterTableStatement.`validate(ClientState state)`
    `void` | AlterTypeStatement.`validate(ClientState state)`
    `void` | AlterViewStatement.`validate(ClientState state)`
    `void` | BatchStatement.`validate(ClientState state)`
    `void` | CreateAggregateStatement.`validate(ClientState state)`
    `void` | CreateFunctionStatement.`validate(ClientState state)`
    `void` | CreateIndexStatement.`validate(ClientState state)`
    `void` | CreateKeyspaceStatement.`validate(ClientState state)` The `CqlParser` only goes as far as extracting the keyword arguments from these statements, so this method is responsible for processing and validating.
    `void` | CreateRoleStatement.`validate(ClientState state)`
    `void` | CreateTableStatement.`validate(ClientState state)`
    `void` | CreateTriggerStatement.`validate(ClientState state)`
    `void` | CreateTypeStatement.`validate(ClientState state)`
    `void` | CreateViewStatement.`validate(ClientState state)`
    `void` | DropAggregateStatement.`validate(ClientState state)`
    `void` | DropFunctionStatement.`validate(ClientState state)`
    `void` | DropIndexStatement.`validate(ClientState state)`
    `void` | DropKeyspaceStatement.`validate(ClientState state)`
    `void` | DropRoleStatement.`validate(ClientState state)`
    `void` | DropTableStatement.`validate(ClientState state)`
    `void` | DropTriggerStatement.`validate(ClientState state)`
    `void` | DropTypeStatement.`validate(ClientState state)`
    `void` | DropViewStatement.`validate(ClientState state)`
    `void` | ListPermissionsStatement.`validate(ClientState state)`
    `void` | ListRolesStatement.`validate(ClientState state)`
    `void` | ModificationStatement.`validate(ClientState state)`
    `void` | PermissionsManagementStatement.`validate(ClientState state)`
    `void` | RoleManagementStatement.`validate(ClientState state)`
    `void` | SelectStatement.`validate(ClientState state)`
    `void` | TruncateStatement.`validate(ClientState state)`
    `void` | UseStatement.`validate(ClientState state)`

  - ### Uses of ClientState in org.apache.cassandra.db

    Methods in org.apache.cassandra.db with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `PartitionIterator` | PartitionRangeReadCommand.`execute(ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`
    `PartitionIterator` | ReadQuery.`execute(ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)` Executes the query at the provided consistency level.
    `PartitionIterator` | SinglePartitionReadCommand.`execute(ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`
    `PartitionIterator` | SinglePartitionReadCommand.Group.`execute(ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`

  - ### Uses of ClientState in org.apache.cassandra.service

    Methods in org.apache.cassandra.service that return ClientState
    Modifier and Type | Method and Description
    --- | ---
    `static ClientState` | ClientState.`forExternalCalls(java.net.SocketAddress remoteAddress)`
    `static ClientState` | ClientState.`forInternalCalls()`
    `ClientState` | QueryState.`getClientState()`

    Methods in org.apache.cassandra.service with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `static RowIterator` | StorageProxy.`cas(java.lang.String keyspaceName, java.lang.String cfName, DecoratedKey key, CASRequest request, ConsistencyLevel consistencyForPaxos, ConsistencyLevel consistencyForCommit, ClientState state, long queryStartNanoTime)` Apply @param updates if and only if the current values in the row for @param key match the provided @param conditions.
    `static PartitionIterator` | StorageProxy.`read(SinglePartitionReadCommand.Group group, ConsistencyLevel consistencyLevel, ClientState state, long queryStartNanoTime)` Performs the actual reading of a row out of the StorageService, fetching a specific set of column names from a given column family.
    `static RowIterator` | StorageProxy.`readOne(SinglePartitionReadCommand command, ConsistencyLevel consistencyLevel, ClientState state, long queryStartNanoTime)`

    Constructors in org.apache.cassandra.service with parameters of type ClientState
    Constructor and Description
    `QueryState(ClientState clientState)`

  - ### Uses of ClientState in org.apache.cassandra.service.pager

    Methods in org.apache.cassandra.service.pager with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `static int` | QueryPagers.`countPaged(CFMetaData metadata, DecoratedKey key, ColumnFilter columnFilter, ClusteringIndexFilter filter, DataLimits limits, ConsistencyLevel consistencyLevel, ClientState state, int pageSize, int nowInSec, boolean isForThrift, long queryStartNanoTime)` Convenience method that count (live) cells/rows for a given slice of a row, but page underneath.
    `PartitionIterator` | AggregationQueryPager.`fetchPage(int pageSize, ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`
    `PartitionIterator` | MultiPartitionPager.`fetchPage(int pageSize, ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`
    `PartitionIterator` | QueryPager.`fetchPage(int pageSize, ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)` Fetches the next page.

    Constructors in org.apache.cassandra.service.pager with parameters of type ClientState
    Constructor and Description
    `AggregationPartitionIterator(int pageSize, ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`
    `GroupByPartitionIterator(int pageSize, ConsistencyLevel consistency, ClientState clientState, long queryStartNanoTime)`

  - ### Uses of ClientState in org.apache.cassandra.thrift

    Subclasses of ClientState in org.apache.cassandra.thrift
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ThriftClientState` ClientState used by thrift that also provide a QueryState.

    Methods in org.apache.cassandra.thrift with parameters of type ClientState
    Modifier and Type | Method and Description
    --- | ---
    `protected PartitionIterator` | CassandraServer.`read(java.util.List<SinglePartitionReadCommand> commands, ConsistencyLevel consistency_level, ClientState cState, long queryStartNanoTime)`

Copyright © 2018 The Apache Software Foundation