be.SIRAPRISE.messages
Class StartTransactionMessageTypeV1_2

java.lang.Object
  be.SIRAPRISE.messages.ServerMessageType
      be.SIRAPRISE.messages.ServerInputMessageType
          be.SIRAPRISE.messages.StartTransactionMessageType
              be.SIRAPRISE.messages.StartTransactionMessageTypeV1_2

public final class StartTransactionMessageTypeV1_2
extends StartTransactionMessageType

StartTransactionMessageTypeV1_2 is V1_2 of the StartTransactionMessageType.

This message has the following fields :

Zone	Format	Length	Description
USERID	STRING		The name of the user starting the transaction. Can be the zero-length string, but if not, it must be a name that appears in some tuple of the USER relvar.
AUTHBYCLIENT	INTEGER	1	1 if the client has authenticated the user, 0 otherwise.
AUTHALGORITHM	STRING		The name of the signing algorithm used to compute SIGNATURE. Can be the zero-length string.
SIGNATURELENGTH	INTEGER	2	The number of bytes in SIGNATURE. Can be zero, in which case the SIGNATURE field is omitted from the message.
SIGNATURE	BYTES		The signature as computed by the signature algorithm identified by AUTHALGORITHM, using the user's private key corresponding to the public key that is registered for the user in the USERCERTIFICATE relvar, and applied to the USERID field.
READONLYTRANSACTION	INTEGER	1	1 if the transaction will not be doing any updates, and can therefore operate in read-only mode, 0 if the transaction is to perform updates on the database.
AUTOCOMMIT	INTEGER	1	1 if the server is required to commit every individual command sent to the transaction, 0 if the server is to commit this transaction only at the client's explicit request.
CAPTUREDDL	INTEGER	1	1 if the server is requested to activate its DDL capturing facility for this transaction, 0 if not.

Since:

SIRA_PRISE 1.3

Author:

Erwin Smout

Field Summary

Fields inherited from class be.SIRAPRISE.messages.StartTransactionMessageType

MESSAGETYPEID

Method Summary

StartTransactionMessage

message(java.lang.String userID, boolean userAuthenticatedByClient, java.lang.String signatureAlgorithm, byte[] signature, boolean readOnlyTransaction, boolean autoCommit, DDLCapture captureDDL) Factory method for getting a StartTransactionMessage of this MessageType's version, holding the given data

Methods inherited from class be.SIRAPRISE.messages.StartTransactionMessageType

message, message

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

message

public StartTransactionMessage message(java.lang.String userID,
                                       boolean userAuthenticatedByClient,
                                       java.lang.String signatureAlgorithm,
                                       byte[] signature,
                                       boolean readOnlyTransaction,
                                       boolean autoCommit,
                                       DDLCapture captureDDL)

Description copied from class: StartTransactionMessageType

Factory method for getting a StartTransactionMessage of this MessageType's version, holding the given data

Specified by:

message in class StartTransactionMessageType

Parameters:

userID - The identification of the user owning the new transaction

userAuthenticatedByClient - indicates whether the user owning the new transaction has been authenticated by the client

signatureAlgorithm - name of the user authentication algorithm to be used by the server if the decides that it will do user authentication itself

signature - The signature to be verified by the server if the decides that it will do user authentication itself

readOnlyTransaction - flag indicating whether or not the new transaction is a read-only one, i.e. whether it will or will not attempt updates to the database. Must be false if this message is sent to a server prior to 1.2

autoCommit - flag indicating whether each individual statement is automatically committed (meaning, for a read-only transaction, that locks will immediately be released when the statement completes)

captureDDL - flag indicating whether any DDL executed in this transaction should be captured by the server in a script. If set, a script file will be created by the server holding all the DDL executed in this transaction. For anonymous transactions, the file will be written in the server's user.home directory, and will be given the name of the internal transaction ID, followed by "DDL.SPS". For non-anonymous transactions, a directory will be created in the server's user.home directory, named after the user owning the transaction, and the script file will be written in that directory.

Returns:

StartTransactionMessage a StartTransactionMessage of this MessageType's version, holding the given data