org.lightningj.lnd.proto

Interface LightningApi.MiddlewareRegistrationOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

LightningApi.MiddlewareRegistration, LightningApi.MiddlewareRegistration.Builder

Enclosing class:

LightningApi

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomMacaroonCaveatName() The name of the custom macaroon caveat that this middleware is responsible for.
com.google.protobuf.ByteString	getCustomMacaroonCaveatNameBytes() The name of the custom macaroon caveat that this middleware is responsible for.
java.lang.String	getMiddlewareName() The name of the middleware to register.
com.google.protobuf.ByteString	getMiddlewareNameBytes() The name of the middleware to register.
boolean	getReadOnlyMode() Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only.

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

getMiddlewareName

java.lang.String getMiddlewareName()

The name of the middleware to register. The name should be as informative
as possible and is logged on registration.
 

string middleware_name = 1;

Returns:

The middlewareName.

getMiddlewareNameBytes

com.google.protobuf.ByteString getMiddlewareNameBytes()

The name of the middleware to register. The name should be as informative
as possible and is logged on registration.
 

string middleware_name = 1;

Returns:

The bytes for middlewareName.

getCustomMacaroonCaveatName

java.lang.String getCustomMacaroonCaveatName()

The name of the custom macaroon caveat that this middleware is responsible
for. Only requests/responses that contain a macaroon with the registered
custom caveat are forwarded for interception to the middleware. The
exception being the read-only mode: All requests/responses are forwarded to
a middleware that requests read-only access but such a middleware won't be
allowed to _alter_ responses. As a security measure, _no_ middleware can
change responses to requests made with _unencumbered_ macaroons!
NOTE: Cannot be used at the same time as read_only_mode.
 

string custom_macaroon_caveat_name = 2;

Returns:

The customMacaroonCaveatName.

getCustomMacaroonCaveatNameBytes

com.google.protobuf.ByteString getCustomMacaroonCaveatNameBytes()

The name of the custom macaroon caveat that this middleware is responsible
for. Only requests/responses that contain a macaroon with the registered
custom caveat are forwarded for interception to the middleware. The
exception being the read-only mode: All requests/responses are forwarded to
a middleware that requests read-only access but such a middleware won't be
allowed to _alter_ responses. As a security measure, _no_ middleware can
change responses to requests made with _unencumbered_ macaroons!
NOTE: Cannot be used at the same time as read_only_mode.
 

string custom_macaroon_caveat_name = 2;

Returns:

The bytes for customMacaroonCaveatName.

getReadOnlyMode

boolean getReadOnlyMode()

Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only. In that mode all requests/responses are
forwarded to the middleware but the middleware isn't allowed to alter any of
the responses.
NOTE: Cannot be used at the same time as custom_macaroon_caveat_name.
 

bool read_only_mode = 3;

Returns:

The readOnlyMode.