org.lightningj.lnd.proto

Interface LightningApi.RPCMiddlewareRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LightningApi.RPCMiddlewareRequest, LightningApi.RPCMiddlewareRequest.Builder

Enclosing class:

LightningApi

public static interface LightningApi.RPCMiddlewareRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
LightningApi.RPCMiddlewareRequest.InterceptTypeCase	getInterceptTypeCase()
long	getMsgId() The unique message ID of this middleware intercept message.
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.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRequestId

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;

Returns:

The requestId.

getRawMacaroon

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;

Returns:

The rawMacaroon.

getCustomCaveatCondition

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;

Returns:

The customCaveatCondition.

getCustomCaveatConditionBytes

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;

Returns:

The bytes for customCaveatCondition.

hasStreamAuth

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;

Returns:

Whether the streamAuth field is set.

getStreamAuth

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;

Returns:

The streamAuth.

getStreamAuthOrBuilder

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;

hasRequest

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;

Returns:

Whether the request field is set.

getRequest

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;

Returns:

The request.

getRequestOrBuilder

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;

hasResponse

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;

Returns:

Whether the response field is set.

getResponse

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;

Returns:

The response.

getResponseOrBuilder

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;

hasRegComplete

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;

Returns:

Whether the regComplete field is set.

getRegComplete

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;

Returns:

The regComplete.

getMsgId

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;

Returns:

The msgId.

getInterceptTypeCase

LightningApi.RPCMiddlewareRequest.InterceptTypeCase getInterceptTypeCase()