Class StartupMessage (0.26.0)

publicclass StartupMessageextendsBootstrapMessage

The first (non-encryption, non-admin) message expected in from a client in a connection loop. Here we handle metadata and authentication if any.

Inheritance

java.lang.Object > WireMessage > BootstrapMessage > StartupMessage

Static Fields

IDENTIFIER

publicstaticfinalintIDENTIFIER
Field Value
Type Description
int

Constructors

StartupMessage(ConnectionHandler connection, int length)

publicStartupMessage(ConnectionHandlerconnection,intlength)
Parameters
Name Description
connection ConnectionHandler
length int

Methods

getHeaderLength()

protectedintgetHeaderLength()

How many bytes is taken by the payload header. Header is defined here as protocol definition + length. Most common value here is four bytes, so we keep that as default. Effectively, this is how much of the message you "don't" want to read from the message's total length with readAll.

Returns
Type Description
int
Overrides

getIdentifier()

protectedStringgetIdentifier()

Used for logging.

Returns
Type Description
String
Overrides

getMessageName()

protectedStringgetMessageName()

Used for logging.

Returns
Type Description
String
Overrides

getParameters()

publicMap<String,String>getParameters()
Returns
Type Description
Map<String,String>

getPayloadString()

protectedStringgetPayloadString()

Used for logging.

Returns
Type Description
String
Overrides

nextHandler()

publicvoidnextHandler()

Here we expect the nextHandler to be PasswordMessage if we authenticate.

Overrides
Exceptions
Type Description
Exception

sendPayload()

protectedvoidsendPayload()

Override this method to include post-processing and metadata in the sending process. Template method for send.

Overrides
Exceptions
Type Description
Exception

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.