TextProtocol (starrocks-bdb-je 18.3.17 API)

java.lang.Object
- com.sleepycat.je.rep.impl.TextProtocol

Direct Known Subclasses:

NodeStateProtocol, Protocol, Protocol, RepGroupProtocol
```
public abstract class TextProtocol
extends Object
```
TextProtocol provides the support for implementing simple low performance protocols involving replication nodes. The protocol is primarily text based, and checks group membership and version matches with every message favoring flexibility over performance. The base class is primarily responsible for the message formatting and message envelope validation. The subclasses define the specific messages that constitute the protocol and the request/response semantics. Every message has the format: <version>|<name>|<id>|<op>|<op-specific payload> <version> is the version of the protocol in use. <name> identifies a group participating in an election. It avoids accidental cross-talk across groups holding concurrent elections. <id> identifies the originator of the message within the group. <op> the operation identified by the specific message. <op-specific payload> the payload associated with the particular operation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`TextProtocol.Fail`
`static class`	`TextProtocol.InvalidMessageException` Used to indicate a message format or invalid content exception.
`class`	`TextProtocol.Message` Base message class for all messages exchanged in the protocol.
`static class`	`TextProtocol.MessageError`
`class`	`TextProtocol.MessageExchange` A single request/response interaction, targetted at a given service running at a particular remote socket address.
`static class`	`TextProtocol.MessageOp` The Operations that are part of the protocol.
`class`	`TextProtocol.OK`
`class`	`TextProtocol.ProtocolError`
`class`	`TextProtocol.RequestMessage` Base class for all Request messages
`class`	`TextProtocol.ResponseMessage` Base classes for response messages.
`protected static class`	`TextProtocol.StringFormatable`
`static class`	`TextProtocol.TOKENS` Represents the tokens on a message line.
`protected static interface`	`TextProtocol.WireFormatable`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DataChannelFactory`	`channelFactory`
`TextProtocol.MessageOp`	`FAIL_RESP`
`protected Formatter`	`formatter`
`protected Logger`	`logger`
`protected String`	`messageNocheckSuffix`
`TextProtocol.MessageOp`	`OK_RESP`
`TextProtocol.MessageOp`	`PROTOCOL_ERROR`
`protected RepImpl`	`repImpl` The rep impl using this protocol.
`static String`	`SEPARATOR`
`static String`	`SEPARATOR_REGEXP`

Constructor Summary

Constructors
Constructor and Description
`TextProtocol(String version, String groupName, NameIdPair nameIdPair, RepImpl repImpl, DataChannelFactory channelFactory)` Creates an instance of the Protocol.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMajorVersionNumber(String version)` Returns the Integer number which represents a Protocol version.
`NameIdPair`	`getNameIdPair()`
`int`	`getOpenTimeout()`
`Set<String>`	`getOps(Class<? extends TextProtocol.Message> messageType)` Returns the messages, of the specified type, used by the protocol
`int`	`getReadTimeout()`
`TextProtocol.RequestMessage`	`getRequestMessage(DataChannel channel)` Reads the channel and returns a read request.
`protected void`	`initializeMessageOps(TextProtocol.MessageOp[] protocolOps)` The messages as defined by the subclass.
`int`	`messageCount()`
`TextProtocol.Message`	`parse(String line)` Parses a line into a Request/Response message.
`TextProtocol.RequestMessage`	`parseRequest(String requestLine)` Converts a request line into a requestMessage.
`TextProtocol.ResponseMessage`	`process(Object requestProcessor, TextProtocol.RequestMessage requestMessage)`
`void`	`processIME(DataChannel channel, TextProtocol.InvalidMessageException ime)` Process an IME encountered during request processing by writing a ProtocolError message as a response and logging it.
`protected TextProtocol.MessageOp`	`replaceOp(String op, TextProtocol.MessageOp message)` For testing only.
`static void`	`setSerDeHook(TestHook<String> serDeHook)` Sets the hook that is invoked post serialization on request messages and pre deserialization on response messages.
`protected void`	`setTimeouts(RepImpl repImpl, DurationConfigParam openTimeoutConfig, DurationConfigParam readTimeoutConfig)` Set the network timeouts associated with uses of this protocol instance.
`void`	`updateNodeIds(Set<Integer> newMemberIds)` Updates the current set of nodes that are permitted to communicate via this protocol, or null for unrestricted.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - messageNocheckSuffix
```
protected final String messageNocheckSuffix
```
  - SEPARATOR
```
public static final String SEPARATOR
```
    See Also:
    
    Constant Field Values
  - SEPARATOR_REGEXP
```
public static final String SEPARATOR_REGEXP
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_ERROR
```
public final TextProtocol.MessageOp PROTOCOL_ERROR
```
  - OK_RESP
```
public final TextProtocol.MessageOp OK_RESP
```
  - FAIL_RESP
```
public final TextProtocol.MessageOp FAIL_RESP
```
  - logger
```
protected final Logger logger
```
  - formatter
```
protected final Formatter formatter
```
  - repImpl
```
protected final RepImpl repImpl
```
    The rep impl using this protocol. It's normally non-null but could be null in unit tests.
  - channelFactory
```
protected final DataChannelFactory channelFactory
```
- Constructor Detail
  - TextProtocol
```
public TextProtocol(String version,
                    String groupName,
                    NameIdPair nameIdPair,
                    RepImpl repImpl,
                    DataChannelFactory channelFactory)
```
    Creates an instance of the Protocol.
    
    Parameters:
    
    version - the protocol version number
    
    groupName - the name of the group executing this protocol
    
    nameIdPair - a unique identifier for this node
    
    repImpl - for logging, may be null
    
    channelFactory - the factory for channel creation
- Method Detail
  - setSerDeHook
```
public static void setSerDeHook(TestHook<String> serDeHook)
```
    Sets the hook that is invoked post serialization on request messages and pre deserialization on response messages. The hook implementation must be re-entrant.
  - setTimeouts
```
protected void setTimeouts(RepImpl repImpl,
                           DurationConfigParam openTimeoutConfig,
                           DurationConfigParam readTimeoutConfig)
```
    Set the network timeouts associated with uses of this protocol instance.
  - initializeMessageOps
```
protected void initializeMessageOps(TextProtocol.MessageOp[] protocolOps)
```
    The messages as defined by the subclass. Note that PROTOCOL_ERROR is a pre-defined message that is defined by this class. The initialization is not considered until this method after been invoked typically in the constructor itself. This two-step is unfortunately necessary since the creation of MessageOps instances requires that this class be completely initialized, otherwise the MessageOp list could have been passed in as a constructor argument.
    
    Parameters:
    
    protocolOps - the message ops defined by the subclass.
  - replaceOp
```
protected TextProtocol.MessageOp replaceOp(String op,
                                           TextProtocol.MessageOp message)
```
    For testing only.
  - getOps
```
public Set<String> getOps(Class<? extends TextProtocol.Message> messageType)
```
    Returns the messages, of the specified type, used by the protocol
  - getOpenTimeout
```
public int getOpenTimeout()
```
  - getReadTimeout
```
public int getReadTimeout()
```
  - getNameIdPair
```
public NameIdPair getNameIdPair()
```
  - messageCount
```
public int messageCount()
```
  - updateNodeIds
```
public void updateNodeIds(Set<Integer> newMemberIds)
```
    Updates the current set of nodes that are permitted to communicate via this protocol, or null for unrestricted.
    
    Parameters:
    
    newMemberIds -
  - getMajorVersionNumber
```
public int getMajorVersionNumber(String version)
```
    Returns the Integer number which represents a Protocol version.
  - parse
```
public TextProtocol.Message parse(String line)
                           throws TextProtocol.InvalidMessageException
```
    Parses a line into a Request/Response message.
    
    Parameters:
    
    line - containing the message
    
    Returns:
    
    a message instance
    
    Throws:
    
    TextProtocol.InvalidMessageException
  - parseRequest
```
public TextProtocol.RequestMessage parseRequest(String requestLine)
                                         throws TextProtocol.InvalidMessageException
```
    Converts a request line into a requestMessage.
    
    Parameters:
    
    requestLine -
    
    Returns:
    
    the request message
    
    Throws:
    
    TextProtocol.InvalidMessageException
  - getRequestMessage
```
public TextProtocol.RequestMessage getRequestMessage(DataChannel channel)
                                              throws IOException
```
    Reads the channel and returns a read request. If the message format was bad, it sends a ProtocolError response back over the channel and no further action is needed by the caller.
    
    Parameters:
    
    channel - the channel delivering the request
    
    Returns:
    
    null if EOF was reached or the message format was bad
    
    Throws:
    
    IOException
  - processIME
```
public void processIME(DataChannel channel,
                       TextProtocol.InvalidMessageException ime)
```
    Process an IME encountered during request processing by writing a ProtocolError message as a response and logging it.
    
    Parameters:
    
    channel - the channel used to write the ProtocolError message
    
    ime - the exception
  - process
```
public TextProtocol.ResponseMessage process(Object requestProcessor,
                                            TextProtocol.RequestMessage requestMessage)
```

Class TextProtocol

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

messageNocheckSuffix

SEPARATOR

SEPARATOR_REGEXP

PROTOCOL_ERROR

OK_RESP

FAIL_RESP

logger

formatter

repImpl

channelFactory

Constructor Detail

TextProtocol

Method Detail

setSerDeHook

setTimeouts

initializeMessageOps

replaceOp

getOps

getOpenTimeout

getReadTimeout

getNameIdPair

messageCount

updateNodeIds

getMajorVersionNumber

parse

parseRequest

getRequestMessage

processIME

process