Class ConnectionHandler (0.23.1)

publicclass ConnectionHandlerextendsThread

Handles a connection from a client to Spanner. This ConnectionHandler uses WireMessage to receive and send all messages from and to the client, using the intermediate representation IntermediateStatement that servers as a middle layer between Postgres and Spanner.

Each ConnectionHandler is also a Thread. Although a TCP connection does not necessarily need to have its own thread, this makes the implementation more straightforward.

Inheritance

java.lang.Object > Thread > ConnectionHandler

Inherited Members

publicbooleancancelActiveStatement(intconnectionId,intsecret)

To be used by a cancellation command to cancel a currently running statement, as contained in a specific connection identified by connectionId. Since cancellation is a flimsy contract at best, it is not imperative that the cancellation run, but it should be attempted nonetheless.

publicvoidcleanUp(IntermediateStatementstatement)

Closes portals and statements if the result of an execute was the end of a transaction.

publicvoidclearActiveCopyStatement()

publicvoidclearInvalidMessageCount()

Clears the number of invalid messages that was received. This is called whenever a valid message is encountered.

publicvoidcloseAllPortals()

Closes all named and unnamed portals on this connection.

publicvoidcloseAllStatements()

publicvoidclosePortal(StringportalName)

publicvoidcloseStatement(StringstatementName)

publicvoidconnectToSpanner(Stringdatabase,Credentialscredentials)

publicCopyStatementgetActiveCopyStatement()

publicFuture<DescribeResult>getAutoDescribedStatement(Stringsql)

Returns the parameter types of a cached auto-described statement, or null if none is available in the cache.

publicintgetConnectionId()

publicConnectionMetadatagetConnectionMetadata()

publicDatabaseIdgetDatabaseId()

publicExtendedQueryProtocolHandlergetExtendedQueryProtocolHandler()

publicintgetInvalidMessageCount()

Returns the number of invalid messages that this connection has received in a row. This can for example happen if a client has initiated a COPY operation and the copy operation fails on the server. The server will then respond with an error response, but if the client fails to read that message and continues to send copy data messages, the server could get flooded. This value is used to detect such a situation and breaks the connection if too many invalid messages in a row are received.

publicIntermediatePortalStatementgetPortal(StringportalName)

publicintgetSecret()

publicProxyServergetServer()

publicConnectiongetSpannerConnection()

publicIntermediatePreparedStatementgetStatement(StringstatementName)

publicsynchronizedConnectionHandler.ConnectionStatusgetStatus()

publicClientAutoDetector.WellKnownClientgetWellKnownClient()

publicvoidhandleMessages()

Reads and handles wire-protocol messages. This method is normally only called from this ConnectionHandler, but certain sub-protocols such as the COPY protocol also need to process messages in line.

publicvoidhandleTerminate()

Called when a Terminate message is received. This closes this ConnectionHandler.

publicbooleanhasPortal(StringportalName)

publicbooleanhasStatement(StringstatementName)

publicvoidincreaseInvalidMessageCount()

Increases the number of invalid messages that was received in a row by 1.

publicvoidmaybeDetermineWellKnownClient(Statementstatement)

This is called by the simple com.google.cloud.spanner.pgadapter.wireprotocol.QueryMessage to give the connection the opportunity to determine the client that is connected based on the SQL string that is being executed.

publicvoidmaybeDetermineWellKnownClient(ParseMessageparseMessage)

This is called by the extended query protocol com.google.cloud.spanner.pgadapter.wireprotocol.ParseMessage to give the connection the opportunity to determine the client that is connected based on the data in the (first) parse messages.

publicvoidregisterAutoDescribedStatement(Stringsql,Future<DescribeResult>describeResult)

Stores the parameter types of an auto-described statement in the cache.

publicvoidregisterPortal(StringportalName,IntermediatePortalStatementportal)

publicvoidregisterStatement(StringstatementName,IntermediatePreparedStatementstatement)

publicvoidrun()

Simple runner starts a loop which keeps taking inbound messages, processing them, sending them to Spanner, getting a result, processing that result, and replying to the client (in that order). Also instantiates input and output streams from the client and handles auth.

Thread.run()

publicvoidsetActiveCopyStatement(CopyStatementcopyStatement)

publicvoidsetMessageState(WireMessagemessage)

publicsynchronizedvoidsetStatus(ConnectionHandler.ConnectionStatusstatus)

publicvoidsetWellKnownClient(ClientAutoDetector.WellKnownClientwellKnownClient)