org.lightningj.lnd.proto

Class LightningApi.MiddlewareRegistration

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.lightningj.lnd.proto.LightningApi.MiddlewareRegistration

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, LightningApi.MiddlewareRegistrationOrBuilder

Enclosing class:

LightningApi

public static final class LightningApi.MiddlewareRegistration
extends com.google.protobuf.GeneratedMessageV3
implements LightningApi.MiddlewareRegistrationOrBuilder

Protobuf type lnrpc.MiddlewareRegistration

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningApi.MiddlewareRegistration.Builder Protobuf type lnrpc.MiddlewareRegistration

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

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

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MIDDLEWARE_NAME_FIELD_NUMBER

public static final int MIDDLEWARE_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOM_MACAROON_CAVEAT_NAME_FIELD_NUMBER

public static final int CUSTOM_MACAROON_CAVEAT_NAME_FIELD_NUMBER

See Also:

Constant Field Values

READ_ONLY_MODE_FIELD_NUMBER

public static final int READ_ONLY_MODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMiddlewareName

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;

Specified by:

getMiddlewareName in interface LightningApi.MiddlewareRegistrationOrBuilder

Returns:

The middlewareName.

getMiddlewareNameBytes

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;

Specified by:

getMiddlewareNameBytes in interface LightningApi.MiddlewareRegistrationOrBuilder

Returns:

The bytes for middlewareName.

getCustomMacaroonCaveatName

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;

Specified by:

getCustomMacaroonCaveatName in interface LightningApi.MiddlewareRegistrationOrBuilder

Returns:

The customMacaroonCaveatName.

getCustomMacaroonCaveatNameBytes

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;

Specified by:

getCustomMacaroonCaveatNameBytes in interface LightningApi.MiddlewareRegistrationOrBuilder

Returns:

The bytes for customMacaroonCaveatName.

getReadOnlyMode

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;

Specified by:

getReadOnlyMode in interface LightningApi.MiddlewareRegistrationOrBuilder

Returns:

The readOnlyMode.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(java.nio.ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(java.nio.ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.ByteString data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.ByteString data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(byte[] data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(java.io.InputStream input)
                                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(java.io.InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.MiddlewareRegistration parseDelimitedFrom(java.io.InputStream input)
                                                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LightningApi.MiddlewareRegistration parseDelimitedFrom(java.io.InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.CodedInputStream input)
                                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LightningApi.MiddlewareRegistration parseFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LightningApi.MiddlewareRegistration.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LightningApi.MiddlewareRegistration.Builder newBuilder()

newBuilder

public static LightningApi.MiddlewareRegistration.Builder newBuilder(LightningApi.MiddlewareRegistration prototype)

toBuilder

public LightningApi.MiddlewareRegistration.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LightningApi.MiddlewareRegistration.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LightningApi.MiddlewareRegistration getDefaultInstance()

parser

public static com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> parser()

getParserForType

public com.google.protobuf.Parser<LightningApi.MiddlewareRegistration> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LightningApi.MiddlewareRegistration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder