package hadoop.common

Get desktop application:
View/edit binary Protocol Buffers messages

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 as request type in: hdfs.ClientNamenodeProtocol.getDelegationToken

• required string renewer = 1

Used as response type in: hdfs.ClientNamenodeProtocol.getDelegationToken

• optional TokenProto token = 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 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

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

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

* Security token identifier

Used in: CancelDelegationTokenRequestProto, GetDelegationTokenResponseProto, RenewDelegationTokenRequestProto, hdfs.BaseHeaderProto, hdfs.LocatedBlockProto

• 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