public static final class LightningApi.MiddlewareRegistration extends com.google.protobuf.GeneratedMessageV3 implements LightningApi.MiddlewareRegistrationOrBuilder
lnrpc.MiddlewareRegistration
Modifier and Type | Class and Description |
---|---|
static class |
LightningApi.MiddlewareRegistration.Builder
Protobuf type
lnrpc.MiddlewareRegistration |
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_MACAROON_CAVEAT_NAME_FIELD_NUMBER |
static int |
MIDDLEWARE_NAME_FIELD_NUMBER |
static int |
READ_ONLY_MODE_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
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.
|
static LightningApi.MiddlewareRegistration |
getDefaultInstance() |
LightningApi.MiddlewareRegistration |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getMiddlewareName()
The name of the middleware to register.
|
com.google.protobuf.ByteString |
getMiddlewareNameBytes()
The name of the middleware to register.
|
com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> |
getParserForType() |
boolean |
getReadOnlyMode()
Instead of defining a custom macaroon caveat name a middleware can register
itself for read-only access only.
|
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LightningApi.MiddlewareRegistration.Builder |
newBuilder() |
static LightningApi.MiddlewareRegistration.Builder |
newBuilder(LightningApi.MiddlewareRegistration prototype) |
LightningApi.MiddlewareRegistration.Builder |
newBuilderForType() |
protected LightningApi.MiddlewareRegistration.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LightningApi.MiddlewareRegistration |
parseDelimitedFrom(java.io.InputStream input) |
static LightningApi.MiddlewareRegistration |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.MiddlewareRegistration |
parseFrom(byte[] data) |
static LightningApi.MiddlewareRegistration |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.MiddlewareRegistration |
parseFrom(java.nio.ByteBuffer data) |
static LightningApi.MiddlewareRegistration |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.MiddlewareRegistration |
parseFrom(com.google.protobuf.ByteString data) |
static LightningApi.MiddlewareRegistration |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.MiddlewareRegistration |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LightningApi.MiddlewareRegistration |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LightningApi.MiddlewareRegistration |
parseFrom(java.io.InputStream input) |
static LightningApi.MiddlewareRegistration |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> |
parser() |
LightningApi.MiddlewareRegistration.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 MIDDLEWARE_NAME_FIELD_NUMBER
public static final int CUSTOM_MACAROON_CAVEAT_NAME_FIELD_NUMBER
public static final int READ_ONLY_MODE_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 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;
getMiddlewareName
in interface LightningApi.MiddlewareRegistrationOrBuilder
public 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;
getMiddlewareNameBytes
in interface LightningApi.MiddlewareRegistrationOrBuilder
public 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;
getCustomMacaroonCaveatName
in interface LightningApi.MiddlewareRegistrationOrBuilder
public 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;
getCustomMacaroonCaveatNameBytes
in interface LightningApi.MiddlewareRegistrationOrBuilder
public 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;
getReadOnlyMode
in interface LightningApi.MiddlewareRegistrationOrBuilder
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.MiddlewareRegistration parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static LightningApi.MiddlewareRegistration parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.MiddlewareRegistration parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.MiddlewareRegistration parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.MiddlewareRegistration parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public LightningApi.MiddlewareRegistration.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static LightningApi.MiddlewareRegistration.Builder newBuilder()
public static LightningApi.MiddlewareRegistration.Builder newBuilder(LightningApi.MiddlewareRegistration prototype)
public LightningApi.MiddlewareRegistration.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected LightningApi.MiddlewareRegistration.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static LightningApi.MiddlewareRegistration getDefaultInstance()
public static com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> parser()
public com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public LightningApi.MiddlewareRegistration getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder