Class StartupMessage (0.27.0)

public class StartupMessage extends BootstrapMessage

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

Inherited Members

BootstrapMessage.create(ConnectionHandler)

BootstrapMessage.parseParameterKeys(String)

BootstrapMessage.parseParameters(String)

BootstrapMessage.sendStartupMessage(DataOutputStream,int,int,SessionState,Iterable<NoticeResponse>)

WireMessage.getHeaderLength()

WireMessage.getIdentifier()

WireMessage.getMessageName()

WireMessage.getParameters(DataInputStream)

WireMessage.getPayloadString()

WireMessage.nextHandler()

WireMessage.read(int)

WireMessage.readAll()

WireMessage.readString()

WireMessage.send()

WireMessage.sendPayload()

WireMessage.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

IDENTIFIER

public static final int IDENTIFIER

Field Value
Type	Description
`int`

Constructors

StartupMessage(ConnectionHandler connection, int length)

public StartupMessage(ConnectionHandler connection, int length)

Parameters
Name	Description
`connection`	`ConnectionHandler`
`length`	`int`

Methods

getHeaderLength()

protected int getHeaderLength()

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

WireMessage.getHeaderLength()

getIdentifier()

public String getIdentifier()

Used for logging.

Returns
Type	Description
`String`

Overrides

WireMessage.getIdentifier()

getMessageName()

protected String getMessageName()

Used for logging.

Returns
Type	Description
`String`

Overrides

WireMessage.getMessageName()

getParameters()

public Map<String,String> getParameters()

Returns
Type	Description
`Map<String,String>`

getPayloadString()

protected String getPayloadString()

Used for logging.

Returns
Type	Description
`String`

Overrides

WireMessage.getPayloadString()

nextHandler()

public void nextHandler()

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

Overrides

WireMessage.nextHandler()

Exceptions
Type	Description
`Exception`

sendPayload()

protected void sendPayload()

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

Overrides

WireMessage.sendPayload()

Exceptions
Type	Description
`Exception`