org.lightningj.lnd.proto

Class LightningApi.MiddlewareRegistration.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>

org.lightningj.lnd.proto.LightningApi.MiddlewareRegistration.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, LightningApi.MiddlewareRegistrationOrBuilder

Enclosing class:

LightningApi.MiddlewareRegistration

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

Protobuf type lnrpc.MiddlewareRegistration

Method Summary

Modifier and Type	Method and Description
LightningApi.MiddlewareRegistration	build()
LightningApi.MiddlewareRegistration	buildPartial()
LightningApi.MiddlewareRegistration.Builder	clear()
LightningApi.MiddlewareRegistration.Builder	clearCustomMacaroonCaveatName() The name of the custom macaroon caveat that this middleware is responsible for.
LightningApi.MiddlewareRegistration.Builder	clearMiddlewareName() The name of the middleware to register.
LightningApi.MiddlewareRegistration.Builder	clearReadOnlyMode() Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only.
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.
LightningApi.MiddlewareRegistration	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
LightningApi.MiddlewareRegistration.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
LightningApi.MiddlewareRegistration.Builder	mergeFrom(LightningApi.MiddlewareRegistration other)
LightningApi.MiddlewareRegistration.Builder	mergeFrom(com.google.protobuf.Message other)
LightningApi.MiddlewareRegistration.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
LightningApi.MiddlewareRegistration.Builder	setCustomMacaroonCaveatName(java.lang.String value) The name of the custom macaroon caveat that this middleware is responsible for.
LightningApi.MiddlewareRegistration.Builder	setCustomMacaroonCaveatNameBytes(com.google.protobuf.ByteString value) The name of the custom macaroon caveat that this middleware is responsible for.
LightningApi.MiddlewareRegistration.Builder	setMiddlewareName(java.lang.String value) The name of the middleware to register.
LightningApi.MiddlewareRegistration.Builder	setMiddlewareNameBytes(com.google.protobuf.ByteString value) The name of the middleware to register.
LightningApi.MiddlewareRegistration.Builder	setReadOnlyMode(boolean value) Instead of defining a custom macaroon caveat name a middleware can register itself for read-only access only.
LightningApi.MiddlewareRegistration.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<LightningApi.MiddlewareRegistration.Builder>

clear

public LightningApi.MiddlewareRegistration.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>

getDefaultInstanceForType

public LightningApi.MiddlewareRegistration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public LightningApi.MiddlewareRegistration build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public LightningApi.MiddlewareRegistration buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public LightningApi.MiddlewareRegistration.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.MiddlewareRegistration.Builder>

mergeFrom

public LightningApi.MiddlewareRegistration.Builder mergeFrom(LightningApi.MiddlewareRegistration other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LightningApi.MiddlewareRegistration.Builder>

Throws:

java.io.IOException

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.

setMiddlewareName

public LightningApi.MiddlewareRegistration.Builder setMiddlewareName(java.lang.String value)

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

string middleware_name = 1;

Parameters:

value - The middlewareName to set.

Returns:

This builder for chaining.

clearMiddlewareName

public LightningApi.MiddlewareRegistration.Builder clearMiddlewareName()

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:

This builder for chaining.

setMiddlewareNameBytes

public LightningApi.MiddlewareRegistration.Builder setMiddlewareNameBytes(com.google.protobuf.ByteString value)

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

string middleware_name = 1;

Parameters:

value - The bytes for middlewareName to set.

Returns:

This builder for chaining.

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.

setCustomMacaroonCaveatName

public LightningApi.MiddlewareRegistration.Builder setCustomMacaroonCaveatName(java.lang.String value)

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;

Parameters:

value - The customMacaroonCaveatName to set.

Returns:

This builder for chaining.

clearCustomMacaroonCaveatName

public LightningApi.MiddlewareRegistration.Builder clearCustomMacaroonCaveatName()

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:

This builder for chaining.

setCustomMacaroonCaveatNameBytes

public LightningApi.MiddlewareRegistration.Builder setCustomMacaroonCaveatNameBytes(com.google.protobuf.ByteString value)

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;

Parameters:

value - The bytes for customMacaroonCaveatName to set.

Returns:

This builder for chaining.

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.

setReadOnlyMode

public LightningApi.MiddlewareRegistration.Builder setReadOnlyMode(boolean value)

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;

Parameters:

value - The readOnlyMode to set.

Returns:

This builder for chaining.

clearReadOnlyMode

public LightningApi.MiddlewareRegistration.Builder clearReadOnlyMode()

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:

This builder for chaining.

setUnknownFields

public final LightningApi.MiddlewareRegistration.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>

mergeUnknownFields

public final LightningApi.MiddlewareRegistration.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LightningApi.MiddlewareRegistration.Builder>