public static final class LightningApi.RPCMiddlewareRequest extends com.google.protobuf.GeneratedMessageV3 implements LightningApi.RPCMiddlewareRequestOrBuilder
lnrpc.RPCMiddlewareRequest
Modifier and Type | Class and Description |
---|---|
static class |
LightningApi.RPCMiddlewareRequest.Builder
Protobuf type
lnrpc.RPCMiddlewareRequest |
static class |
LightningApi.RPCMiddlewareRequest.InterceptTypeCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
CUSTOM_CAVEAT_CONDITION_FIELD_NUMBER |
static int |
MSG_ID_FIELD_NUMBER |
static int |
RAW_MACAROON_FIELD_NUMBER |
static int |
REG_COMPLETE_FIELD_NUMBER |
static int |
REQUEST_FIELD_NUMBER |
static int |
REQUEST_ID_FIELD_NUMBER |
static int |
RESPONSE_FIELD_NUMBER |
static int |
STREAM_AUTH_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCustomCaveatCondition()
The parsed condition of the macaroon's custom caveat for convenient access.
|
com.google.protobuf.ByteString |
getCustomCaveatConditionBytes()
The parsed condition of the macaroon's custom caveat for convenient access.
|
static LightningApi.RPCMiddlewareRequest |
getDefaultInstance() |
LightningApi.RPCMiddlewareRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
LightningApi.RPCMiddlewareRequest.InterceptTypeCase |
getInterceptTypeCase() |
long |
getMsgId()
The unique message ID of this middleware intercept message.
|
com.google.protobuf.Parser<LightningApi.RPCMiddlewareRequest> |
getParserForType() |
com.google.protobuf.ByteString |
getRawMacaroon()
The raw bytes of the complete macaroon as sent by the gRPC client in the
original request.
|
boolean |
getRegComplete()
This is used to indicate to the client that the server has successfully
registered the interceptor.
|
LightningApi.RPCMessage |
getRequest()
Intercept incoming gRPC client request message: all incoming messages,
both on streaming and unary RPCs, are forwarded to the middleware for
inspection.
|
long |
getRequestId()
The unique ID of the intercepted original gRPC request.
|
LightningApi.RPCMessageOrBuilder |
getRequestOrBuilder()
Intercept incoming gRPC client request message: all incoming messages,
both on streaming and unary RPCs, are forwarded to the middleware for
inspection.
|
LightningApi.RPCMessage |
getResponse()
Intercept outgoing gRPC response message: all outgoing messages, both on
streaming and unary RPCs, are forwarded to the middleware for inspection
and amendment.
|
LightningApi.RPCMessageOrBuilder |
getResponseOrBuilder()
Intercept outgoing gRPC response message: all outgoing messages, both on
streaming and unary RPCs, are forwarded to the middleware for inspection
and amendment.
|
int |
getSerializedSize() |
LightningApi.StreamAuth |
getStreamAuth()
Intercept stream authentication: each new streaming RPC call that is
initiated against lnd and contains the middleware's custom macaroon
caveat can be approved or denied based upon the macaroon in the stream
header.
|
LightningApi.StreamAuthOrBuilder |
getStreamAuthOrBuilder()
Intercept stream authentication: each new streaming RPC call that is
initiated against lnd and contains the middleware's custom macaroon
caveat can be approved or denied based upon the macaroon in the stream
header.
|
int |
hashCode() |
boolean |
hasRegComplete()
This is used to indicate to the client that the server has successfully
registered the interceptor.
|
boolean |
hasRequest()
Intercept incoming gRPC client request message: all incoming messages,
both on streaming and unary RPCs, are forwarded to the middleware for
inspection.
|
boolean |
hasResponse()
Intercept outgoing gRPC response message: all outgoing messages, both on
streaming and unary RPCs, are forwarded to the middleware for inspection
and amendment.
|
boolean |
hasStreamAuth()
Intercept stream authentication: each new streaming RPC call that is
initiated against lnd and contains the middleware's custom macaroon
caveat can be approved or denied based upon the macaroon in the stream
header.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LightningApi.RPCMiddlewareRequest.Builder |
newBuilder() |
static LightningApi.RPCMiddlewareRequest.Builder |
newBuilder(LightningApi.RPCMiddlewareRequest prototype) |
LightningApi.RPCMiddlewareRequest.Builder |
newBuilderForType() |
protected LightningApi.RPCMiddlewareRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LightningApi.RPCMiddlewareRequest |
parseDelimitedFrom(java.io.InputStream input) |
static LightningApi.RPCMiddlewareRequest |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(byte[] data) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(java.nio.ByteBuffer data) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(com.google.protobuf.ByteString data) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(java.io.InputStream input) |
static LightningApi.RPCMiddlewareRequest |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LightningApi.RPCMiddlewareRequest> |
parser() |
LightningApi.RPCMiddlewareRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int REQUEST_ID_FIELD_NUMBER
public static final int RAW_MACAROON_FIELD_NUMBER
public static final int CUSTOM_CAVEAT_CONDITION_FIELD_NUMBER
public static final int STREAM_AUTH_FIELD_NUMBER
public static final int REQUEST_FIELD_NUMBER
public static final int RESPONSE_FIELD_NUMBER
public static final int REG_COMPLETE_FIELD_NUMBER
public static final int MSG_ID_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.RPCMiddlewareRequest.InterceptTypeCase getInterceptTypeCase()
getInterceptTypeCase
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public long getRequestId()
The unique ID of the intercepted original gRPC request. Useful for mapping request to response when implementing full duplex message interception. For streaming requests, this will be the same ID for all incoming and outgoing middleware intercept messages of the _same_ stream.
uint64 request_id = 1;
getRequestId
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public com.google.protobuf.ByteString getRawMacaroon()
The raw bytes of the complete macaroon as sent by the gRPC client in the original request. This might be empty for a request that doesn't require macaroons such as the wallet unlocker RPCs.
bytes raw_macaroon = 2;
getRawMacaroon
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public java.lang.String getCustomCaveatCondition()
The parsed condition of the macaroon's custom caveat for convenient access. This field only contains the value of the custom caveat that the handling middleware has registered itself for. The condition _must_ be validated for messages of intercept_type stream_auth and request!
string custom_caveat_condition = 3;
getCustomCaveatCondition
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public com.google.protobuf.ByteString getCustomCaveatConditionBytes()
The parsed condition of the macaroon's custom caveat for convenient access. This field only contains the value of the custom caveat that the handling middleware has registered itself for. The condition _must_ be validated for messages of intercept_type stream_auth and request!
string custom_caveat_condition = 3;
getCustomCaveatConditionBytes
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public boolean hasStreamAuth()
Intercept stream authentication: each new streaming RPC call that is initiated against lnd and contains the middleware's custom macaroon caveat can be approved or denied based upon the macaroon in the stream header. This message will only be sent for streaming RPCs, unary RPCs must handle the macaroon authentication in the request interception to avoid an additional message round trip between lnd and the middleware.
.lnrpc.StreamAuth stream_auth = 4;
hasStreamAuth
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.StreamAuth getStreamAuth()
Intercept stream authentication: each new streaming RPC call that is initiated against lnd and contains the middleware's custom macaroon caveat can be approved or denied based upon the macaroon in the stream header. This message will only be sent for streaming RPCs, unary RPCs must handle the macaroon authentication in the request interception to avoid an additional message round trip between lnd and the middleware.
.lnrpc.StreamAuth stream_auth = 4;
getStreamAuth
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.StreamAuthOrBuilder getStreamAuthOrBuilder()
Intercept stream authentication: each new streaming RPC call that is initiated against lnd and contains the middleware's custom macaroon caveat can be approved or denied based upon the macaroon in the stream header. This message will only be sent for streaming RPCs, unary RPCs must handle the macaroon authentication in the request interception to avoid an additional message round trip between lnd and the middleware.
.lnrpc.StreamAuth stream_auth = 4;
getStreamAuthOrBuilder
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public boolean hasRequest()
Intercept incoming gRPC client request message: all incoming messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection. For unary RPC messages the middleware is also expected to validate the custom macaroon caveat of the request.
.lnrpc.RPCMessage request = 5;
hasRequest
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.RPCMessage getRequest()
Intercept incoming gRPC client request message: all incoming messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection. For unary RPC messages the middleware is also expected to validate the custom macaroon caveat of the request.
.lnrpc.RPCMessage request = 5;
getRequest
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.RPCMessageOrBuilder getRequestOrBuilder()
Intercept incoming gRPC client request message: all incoming messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection. For unary RPC messages the middleware is also expected to validate the custom macaroon caveat of the request.
.lnrpc.RPCMessage request = 5;
getRequestOrBuilder
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public boolean hasResponse()
Intercept outgoing gRPC response message: all outgoing messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection and amendment. The response in this message is the original response as it was generated by the main RPC server. It can either be accepted (=forwarded to the client), replaced/overwritten with a new message of the same type, or replaced by an error message.
.lnrpc.RPCMessage response = 6;
hasResponse
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.RPCMessage getResponse()
Intercept outgoing gRPC response message: all outgoing messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection and amendment. The response in this message is the original response as it was generated by the main RPC server. It can either be accepted (=forwarded to the client), replaced/overwritten with a new message of the same type, or replaced by an error message.
.lnrpc.RPCMessage response = 6;
getResponse
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public LightningApi.RPCMessageOrBuilder getResponseOrBuilder()
Intercept outgoing gRPC response message: all outgoing messages, both on streaming and unary RPCs, are forwarded to the middleware for inspection and amendment. The response in this message is the original response as it was generated by the main RPC server. It can either be accepted (=forwarded to the client), replaced/overwritten with a new message of the same type, or replaced by an error message.
.lnrpc.RPCMessage response = 6;
getResponseOrBuilder
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public boolean hasRegComplete()
This is used to indicate to the client that the server has successfully registered the interceptor. This is only used in the very first message that the server sends to the client after the client sends the server the middleware registration message.
bool reg_complete = 8;
hasRegComplete
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public boolean getRegComplete()
This is used to indicate to the client that the server has successfully registered the interceptor. This is only used in the very first message that the server sends to the client after the client sends the server the middleware registration message.
bool reg_complete = 8;
getRegComplete
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public long getMsgId()
The unique message ID of this middleware intercept message. There can be multiple middleware intercept messages per single gRPC request (one for the incoming request and one for the outgoing response) or gRPC stream (one for each incoming message and one for each outgoing response). This message ID must be referenced when responding (accepting/rejecting/modifying) to an intercept message.
uint64 msg_id = 7;
getMsgId
in interface LightningApi.RPCMiddlewareRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static LightningApi.RPCMiddlewareRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.RPCMiddlewareRequest parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.RPCMiddlewareRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.RPCMiddlewareRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.RPCMiddlewareRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.RPCMiddlewareRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.RPCMiddlewareRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public LightningApi.RPCMiddlewareRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LightningApi.RPCMiddlewareRequest.Builder newBuilder()
public static LightningApi.RPCMiddlewareRequest.Builder newBuilder(LightningApi.RPCMiddlewareRequest prototype)
public LightningApi.RPCMiddlewareRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LightningApi.RPCMiddlewareRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LightningApi.RPCMiddlewareRequest getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.RPCMiddlewareRequest> parser()
public com.google.protobuf.Parser<LightningApi.RPCMiddlewareRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.RPCMiddlewareRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder