package hadoop.common

Get desktop application:
View/edit binary Protocol Buffers messages

* Protocol which is used to refresh a user-specified feature.

• rpc refresh (GenericRefreshRequestProto, GenericRefreshResponseCollectionProto)

  GenericRefreshProtocol.proto:60

  message GenericRefreshRequestProto

  GenericRefreshProtocol.proto:35

  * Refresh request.

  • optional string identifier = 1

  • repeated string args = 2

  message GenericRefreshResponseCollectionProto

  GenericRefreshProtocol.proto:52

  * Collection of responses from zero or more handlers.

  • repeated GenericRefreshResponseProto responses = 1

* Protocol which maps users to groups.

• rpc getGroupsForUser (GetGroupsForUserRequestProto, GetGroupsForUserResponseProto)

  GetUserMappingsProtocol.proto:54

  * Get the groups which are mapped to the given user.

  message GetGroupsForUserRequestProto

  GetUserMappingsProtocol.proto:35

  * Get groups for user request.

  • required string user = 1

  message GetGroupsForUserResponseProto

  GetUserMappingsProtocol.proto:42

  * Response for get groups.

  • repeated string groups = 1

* Protocol interface provides High availability related primitives to monitor and failover a service. For details see o.a.h.ha.HAServiceProtocol.

• rpc monitorHealth (MonitorHealthRequestProto, MonitorHealthResponseProto)

  HAServiceProtocol.proto:129

  * Monitor the health of a service.

  message MonitorHealthRequestProto

  HAServiceProtocol.proto:52

  * void request

  (message has no fields)

  message MonitorHealthResponseProto

  HAServiceProtocol.proto:58

  * void response

  (message has no fields)

• rpc transitionToActive (TransitionToActiveRequestProto, TransitionToActiveResponseProto)

  HAServiceProtocol.proto:135

  * Request service to tranisition to active state.

  message TransitionToActiveRequestProto

  HAServiceProtocol.proto:64

  * void request

  • required HAStateChangeRequestInfoProto reqInfo = 1

  message TransitionToActiveResponseProto

  HAServiceProtocol.proto:71

  * void response

  (message has no fields)

• rpc transitionToStandby (TransitionToStandbyRequestProto, TransitionToStandbyResponseProto)

  HAServiceProtocol.proto:141

  * Request service to transition to standby state.

  message TransitionToStandbyRequestProto

  HAServiceProtocol.proto:77

  * void request

  • required HAStateChangeRequestInfoProto reqInfo = 1

  message TransitionToStandbyResponseProto

  HAServiceProtocol.proto:84

  * void response

  (message has no fields)

• rpc transitionToObserver (TransitionToObserverRequestProto, TransitionToObserverResponseProto)

  HAServiceProtocol.proto:147

  * Request service to transition to observer state.

  message TransitionToObserverRequestProto

  HAServiceProtocol.proto:90

  * void request

  • required HAStateChangeRequestInfoProto reqInfo = 1

  message TransitionToObserverResponseProto

  HAServiceProtocol.proto:97

  * void response

  (message has no fields)

• rpc getServiceStatus (GetServiceStatusRequestProto, GetServiceStatusResponseProto)

  HAServiceProtocol.proto:153

  * Get the current status of the service.

  message GetServiceStatusRequestProto

  HAServiceProtocol.proto:103

  * void request

  (message has no fields)

  message GetServiceStatusResponseProto

  HAServiceProtocol.proto:109

  * Returns the state of the service

  • required HAServiceStateProto state = 1

  • optional bool readyToBecomeActive = 2

    If state is STANDBY, indicate whether it is ready to become active.

  • optional string notReadyReason = 3

    If not ready to become active, a textual explanation of why not

* Protocol to get information about protocols.

• rpc getProtocolVersions (GetProtocolVersionsRequestProto, GetProtocolVersionsResponseProto)

  ProtocolInfo.proto:82

  * Return protocol version corresponding to protocol interface for each supported rpc kind.

  message GetProtocolVersionsRequestProto

  ProtocolInfo.proto:35

  * Request to get protocol versions for all supported rpc kinds.

  • required string protocol = 1

    Protocol name

  message GetProtocolVersionsResponseProto

  ProtocolInfo.proto:50

  * Get protocol version response.

  • repeated ProtocolVersionProto protocolVersions = 1

• rpc getProtocolSignature (GetProtocolSignatureRequestProto, GetProtocolSignatureResponseProto)

  ProtocolInfo.proto:88

  * Return protocol version corresponding to protocol interface.

  message GetProtocolSignatureRequestProto

  ProtocolInfo.proto:57

  * Get protocol signature request.

  • required string protocol = 1

    Protocol name

  • required string rpcKind = 2

    RPC kind

  message GetProtocolSignatureResponseProto

  ProtocolInfo.proto:65

  * Get protocol signature response.

  • repeated ProtocolSignatureProto protocolSignature = 1

* Protocol which is used to refresh the authorization policy in use currently.

• rpc refreshServiceAcl (RefreshServiceAclRequestProto, RefreshServiceAclResponseProto)

  RefreshAuthorizationPolicyProtocol.proto:51

  * Refresh the service-level authorization policy in-effect.

  message RefreshServiceAclRequestProto

  RefreshAuthorizationPolicyProtocol.proto:35

  * Refresh service acl request.

  (message has no fields)

  message RefreshServiceAclResponseProto

  RefreshAuthorizationPolicyProtocol.proto:41

  * void response

  (message has no fields)

* Protocol which is used to refresh the callqueue.

• rpc refreshCallQueue (RefreshCallQueueRequestProto, RefreshCallQueueResponseProto)

  RefreshCallQueueProtocol.proto:51

  * Refresh the callqueue.

  message RefreshCallQueueRequestProto

  RefreshCallQueueProtocol.proto:35

  * Refresh callqueue request.

  (message has no fields)

  message RefreshCallQueueResponseProto

  RefreshCallQueueProtocol.proto:41

  * void response.

  (message has no fields)

* Protocol to refresh the user mappings.

• rpc refreshUserToGroupsMappings (RefreshUserToGroupsMappingsRequestProto, RefreshUserToGroupsMappingsResponseProto)

  RefreshUserMappingsProtocol.proto:63

  * Refresh user to group mappings.

  message RefreshUserToGroupsMappingsRequestProto

  RefreshUserMappingsProtocol.proto:35

  * Refresh user to group mappings request.

  (message has no fields)

  message RefreshUserToGroupsMappingsResponseProto

  RefreshUserMappingsProtocol.proto:41

  * void response

  (message has no fields)

• rpc refreshSuperUserGroupsConfiguration (RefreshSuperUserGroupsConfigurationRequestProto, RefreshSuperUserGroupsConfigurationResponseProto)

  RefreshUserMappingsProtocol.proto:69

  * Refresh superuser proxy group list.

  message RefreshSuperUserGroupsConfigurationRequestProto

  RefreshUserMappingsProtocol.proto:47

  * Refresh superuser configuration request.

  (message has no fields)

  message RefreshSuperUserGroupsConfigurationResponseProto

  RefreshUserMappingsProtocol.proto:53

  * void response

  (message has no fields)

• rpc listSpanReceivers (ListSpanReceiversRequestProto, ListSpanReceiversResponseProto)

  TraceAdmin.proto:66

  message ListSpanReceiversRequestProto

  TraceAdmin.proto:32

  (message has no fields)

  message ListSpanReceiversResponseProto

  TraceAdmin.proto:40

  • repeated SpanReceiverListInfo descriptions = 1

• rpc addSpanReceiver (AddSpanReceiverRequestProto, AddSpanReceiverResponseProto)

  TraceAdmin.proto:69

  message AddSpanReceiverRequestProto

  TraceAdmin.proto:49

  • required string className = 1

  • repeated ConfigPair config = 2

  message AddSpanReceiverResponseProto

  TraceAdmin.proto:54

  • required int64 id = 1

• rpc removeSpanReceiver (RemoveSpanReceiverRequestProto, RemoveSpanReceiverResponseProto)

  TraceAdmin.proto:72

  message RemoveSpanReceiverRequestProto

  TraceAdmin.proto:58

  • required int64 id = 1

  message RemoveSpanReceiverResponseProto

  TraceAdmin.proto:62

  (message has no fields)

* Protocol provides manual control of the ZK Failover Controllers

• rpc cedeActive (CedeActiveRequestProto, CedeActiveResponseProto)

  ZKFCProtocol.proto:54

  * Request that the service cede its active state, and quit the election for some amount of time

  message CedeActiveRequestProto

  ZKFCProtocol.proto:32

  • required uint32 millisToCede = 1

  message CedeActiveResponseProto

  ZKFCProtocol.proto:36

  (message has no fields)

• rpc gracefulFailover (GracefulFailoverRequestProto, GracefulFailoverResponseProto)

  ZKFCProtocol.proto:58

  message GracefulFailoverRequestProto

  ZKFCProtocol.proto:39

  (message has no fields)

  message GracefulFailoverResponseProto

  ZKFCProtocol.proto:42

  (message has no fields)

Used as request type in: hdfs.ClientNamenodeProtocol.cancelDelegationToken

• required TokenProto token = 1

void response

Used as response type in: hdfs.ClientNamenodeProtocol.cancelDelegationToken

(message has no fields)

Used in: AddSpanReceiverRequestProto

• required string key = 1

• required string value = 2

Used in: CredentialsProto

• required string alias = 1

• optional TokenProto token = 2

• optional bytes secret = 3

• repeated CredentialsKVProto tokens = 1

• repeated CredentialsKVProto secrets = 2

* A single response from a refresh handler.

Used in: GenericRefreshResponseCollectionProto

• optional int32 exitStatus = 1

  unix exit status to return

• optional string userMessage = 2

  to be displayed to the user

• optional string senderName = 3

  which handler sent this message

Used as request type in: hdfs.ClientNamenodeProtocol.getDelegationToken

• required string renewer = 1

Used as response type in: hdfs.ClientNamenodeProtocol.getDelegationToken

• optional TokenProto token = 1

Used in: HAStateChangeRequestInfoProto

• REQUEST_BY_USER = 0

• REQUEST_BY_USER_FORCED = 1

• REQUEST_BY_ZKFC = 2

Used in: GetServiceStatusResponseProto, hdfs.HAServiceStateResponseProto

• INITIALIZING = 0

• ACTIVE = 1

• STANDBY = 2

• OBSERVER = 3

Used in: TransitionToActiveRequestProto, TransitionToObserverRequestProto, TransitionToStandbyRequestProto

• required HARequestSource reqSource = 1

* The connection context is sent as part of the connection establishment. It establishes the context for ALL Rpc calls within the connection.

• optional UserInformationProto userInfo = 2

  UserInfo beyond what is determined as part of security handshake at connection time (kerberos, tokens etc).

• optional string protocol = 3

  Protocol name for next rpc layer. The client created a proxy with this protocol name

Used in: GetProtocolSignatureResponseProto

• required uint64 version = 1

• repeated uint32 methods = 2

* Protocol version with corresponding rpc kind.

Used in: GetProtocolVersionsResponseProto

• required string rpcKind = 1

  RPC kind

• repeated uint64 versions = 2

  Protocol version corresponding to the rpc kind.

* Used to pass through the call context entry after an RPC is made.

Used in: RpcRequestHeaderProto

• required string context = 1

• optional bytes signature = 2

* Used to pass through the information necessary to continue a trace after an RPC is made. All we need is the traceid (so we know the overarching trace this message is a part of), and the id of the current span when this message was sent, so we know what span caused the new span we will create when this message is received.

Used in: RpcRequestHeaderProto

• optional int64 traceId = 1

  parentIdHigh

• optional int64 parentId = 2

  parentIdLow

Used as request type in: hdfs.ClientNamenodeProtocol.renewDelegationToken

• required TokenProto token = 1

Used as response type in: hdfs.ClientNamenodeProtocol.renewDelegationToken

• required uint64 newExpiryTime = 1

* This message is the header for the Protobuf Rpc Engine when sending a RPC request from RPC client to the RPC server. The actual request (serialized as protobuf) follows this request. No special header is needed for the Rpc Response for Protobuf Rpc Engine. The normal RPC response header (see RpcHeader.proto) are sufficient.

• required string methodName = 1

  * Name of the RPC method

• required string declaringClassProtocolName = 2

  * RPCs for a particular interface (ie protocol) are done using a IPC connection that is setup using rpcProxy. The rpcProxy's has a declared protocol name that is sent form client to server at connection time. Each Rpc call also sends a protocol name (called declaringClassprotocolName). This name is usually the same as the connection protocol name except in some cases. For example metaProtocols such ProtocolInfoProto which get metainfo about the protocol reuse the connection but need to indicate that the actual protocol is different (i.e. the protocol is ProtocolInfoProto) since they reuse the connection; in this case the declaringClassProtocolName field is set to the ProtocolInfoProto

• required uint64 clientProtocolVersion = 3

  * protocol version of class declaring the called method

* RpcKind determine the rpcEngine and the serialization of the rpc request

Used in: RpcRequestHeaderProto

• RPC_BUILTIN = 0

  Used for built in calls by tests

• RPC_WRITABLE = 1

  Use WritableRpcEngine

• RPC_PROTOCOL_BUFFER = 2

  Use ProtobufRpcEngine

the header for the RpcRequest

• optional RpcKindProto rpcKind = 1

• optional RpcRequestHeaderProto.OperationProto rpcOp = 2

• required sint32 callId = 3

  a sequence number that is sent back in response

• required bytes clientId = 4

  Globally unique client ID

• optional sint32 retryCount = 5

  clientId + callId uniquely identifies a request retry count, 1 means this is the first retry

• optional RPCTraceInfoProto traceInfo = 6

  tracing info

• optional RPCCallerContextProto callerContext = 7

  call context

• optional int64 stateId = 8

  The last seen Global State ID

Used in: RpcRequestHeaderProto

• RPC_FINAL_PACKET = 0

  The final RPC Packet

• RPC_CONTINUATION_PACKET = 1

  not implemented yet

• RPC_CLOSE_CONNECTION = 2

  close the rpc connection

* Rpc Response Header +------------------------------------------------------------------+ | Rpc total response length in bytes (4 bytes int) | | (sum of next two parts) | +------------------------------------------------------------------+ | RpcResponseHeaderProto - serialized delimited ie has len | +------------------------------------------------------------------+ | if request is successful: | | - RpcResponse - The actual rpc response bytes follow | | the response header | | This response is serialized based on RpcKindProto | | if request fails : | | The rpc response header contains the necessary info | +------------------------------------------------------------------+ Note that rpc response header is also used when connection setup fails. Ie the response looks like a rpc response with a fake callId.

* RpcStastus - success or failure The reponseHeader's errDetail, exceptionClassName and errMsg contains further details on the error

• required uint32 callId = 1

  callId used in Request

• required RpcResponseHeaderProto.RpcStatusProto status = 2

• optional uint32 serverIpcVersionNum = 3

  Sent if success or fail

• optional string exceptionClassName = 4

  if request fails

• optional string errorMsg = 5

  if request fails, often contains strack trace

• optional RpcResponseHeaderProto.RpcErrorCodeProto errorDetail = 6

  in case of error

• optional bytes clientId = 7

  Globally unique client ID

• optional sint32 retryCount = 8

• optional int64 stateId = 9

  The last written Global State ID

Used in: RpcResponseHeaderProto

• ERROR_APPLICATION = 1

  Non-fatal Rpc error - connection left open for future rpc calls

  RPC Failed - rpc app threw exception

• ERROR_NO_SUCH_METHOD = 2

  Rpc error - no such method

• ERROR_NO_SUCH_PROTOCOL = 3

  Rpc error - no such protocol

• ERROR_RPC_SERVER = 4

  Rpc error on server side

• ERROR_SERIALIZING_RESPONSE = 5

  error serializign response

• ERROR_RPC_VERSION_MISMATCH = 6

  Rpc protocol version mismatch

• FATAL_UNKNOWN = 10

  Fatal Server side Rpc error - connection closed

  unknown Fatal error

• FATAL_UNSUPPORTED_SERIALIZATION = 11

  IPC layer serilization type invalid

• FATAL_INVALID_RPC_HEADER = 12

  fields of RpcHeader are invalid

• FATAL_DESERIALIZING_REQUEST = 13

  could not deserilize rpc request

• FATAL_VERSION_MISMATCH = 14

  Ipc Layer version mismatch

• FATAL_UNAUTHORIZED = 15

  Auth failed

Used in: RpcResponseHeaderProto

• SUCCESS = 0

  RPC succeeded

• ERROR = 1

  RPC or error - connection left open for future calls

• FATAL = 2

  Fatal error - connection closed

• optional uint32 version = 1

• required RpcSaslProto.SaslState state = 2

• optional bytes token = 3

• repeated RpcSaslProto.SaslAuth auths = 4

Used in: RpcSaslProto

• required string method = 1

• required string mechanism = 2

• optional string protocol = 3

• optional string serverId = 4

• optional bytes challenge = 5

Used in: RpcSaslProto

• SUCCESS = 0

• NEGOTIATE = 1

• INITIATE = 2

• CHALLENGE = 3

• RESPONSE = 4

• WRAP = 5

Used in: ListSpanReceiversResponseProto

• required int64 id = 1

• required string className = 2

* Security token identifier

Used in: CancelDelegationTokenRequestProto, CredentialsKVProto, GetDelegationTokenResponseProto, RenewDelegationTokenRequestProto, hdfs.BaseHeaderProto, hdfs.GetBlockLocalPathInfoRequestProto, hdfs.LocatedBlockProto, hdfs.OpBlockGroupChecksumProto

• required bytes identifier = 1

• required bytes password = 2

• required string kind = 3

• required string service = 4

* Spec for UserInformationProto is specified in ProtoUtil#makeIpcConnectionContext

Used in: IpcConnectionContextProto

• optional string effectiveUser = 1

• optional string realUser = 2