Some or all of the information on this page might not apply to Trusted Cloud by S3NS.

Class DescribeMessage (0.17.0)

public class DescribeMessage extends AbstractQueryProtocolMessage

Calls describe on a portal or prepared statement.

Inheritance

java.lang.Object > WireMessage > ControlMessage > AbstractQueryProtocolMessage > DescribeMessage

Inherited Members

AbstractQueryProtocolMessage.flush()

AbstractQueryProtocolMessage.getSql()

AbstractQueryProtocolMessage.handleError(Exception)

AbstractQueryProtocolMessage.isReturnedErrorResponse()

AbstractQueryProtocolMessage.sendPayload()

ControlMessage.create(ConnectionHandler)

ControlMessage.getFormatCodes(DataInputStream)

ControlMessage.isExtendedProtocol()

WireMessage.getHeaderLength()

WireMessage.getIdentifier()

WireMessage.getMessageName()

WireMessage.getParameters(DataInputStream)

WireMessage.getPayloadString()

WireMessage.nextHandler()

WireMessage.read(int)

WireMessage.readAll()

WireMessage.readString()

WireMessage.send()

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

protected static final char IDENTIFIER

Field Value

Type	Description
`char`

Constructors

DescribeMessage(ConnectionHandler connection)

public DescribeMessage(ConnectionHandler connection)

Parameter

Name	Description
`connection`	`ConnectionHandler`

DescribeMessage(ConnectionHandler connection, ControlMessage.ManuallyCreatedToken manuallyCreatedToken)

public DescribeMessage(ConnectionHandler connection, ControlMessage.ManuallyCreatedToken manuallyCreatedToken)

Constructor for manually created Describe messages from the simple query protocol.

Parameters

Name	Description
`connection`	`ConnectionHandler`
`manuallyCreatedToken`	`ControlMessage.ManuallyCreatedToken`

DescribeMessage(ConnectionHandler connection, ControlMessage.PreparedType type, String name, ControlMessage.ManuallyCreatedToken manuallyCreatedToken)

public DescribeMessage(ConnectionHandler connection, ControlMessage.PreparedType type, String name, ControlMessage.ManuallyCreatedToken manuallyCreatedToken)

Constructor for manually created Describe messages from PREPARE statements.

Parameters

Name	Description
`connection`	`ConnectionHandler`
`type`	`ControlMessage.PreparedType`
`name`	`String`
`manuallyCreatedToken`	`ControlMessage.ManuallyCreatedToken`

Methods

flush()

public void flush()

Overrides

AbstractQueryProtocolMessage.flush()

Exceptions

Type	Description
`Exception`

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()

protected 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()

getName()

public String getName()

Returns

Type	Description
`String`

getPayloadString()

protected String getPayloadString()

Used for logging.

Returns

Type	Description
`String`

Overrides

WireMessage.getPayloadString()

getSql()

public String getSql()

Returns

Type	Description
`String`

Overrides

AbstractQueryProtocolMessage.getSql()

getType()

public ControlMessage.PreparedType getType()

Returns

Type	Description
`ControlMessage.PreparedType`

handleDescribeStatement()

public void handleDescribeStatement()

Called when a describe message of type 'S' is received.

Exceptions

Type	Description
`Exception`	if sending the message back to the client causes an error.