be.SIRAPRISE.messages
Class StartTransactionMessageType

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

Direct Known Subclasses:

StartTransactionMessageTypeV1_0, StartTransactionMessageTypeV1_1, StartTransactionMessageTypeV1_2

public abstract class StartTransactionMessageType
extends ServerInputMessageType

The StartTransactionMessageType is the message type to be sent by clients who wish to start a transaction on the server to do some data manipulation activity.

Author:

Erwin Smout

Field Summary

static int

MESSAGETYPEID Comment for MESSAGETYPEID

Method Summary

StartTransactionMessage	message(java.lang.String userID, boolean userAuthenticatedByClient, java.lang.String signatureAlgorithm, byte[] signature) Deprecated.
StartTransactionMessage	message(java.lang.String userID, boolean userAuthenticatedByClient, java.lang.String signatureAlgorithm, byte[] signature, boolean readOnlyTransaction, boolean autoCommit) Deprecated.
abstract 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 java.lang.Object

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

Field Detail

MESSAGETYPEID

public static final int MESSAGETYPEID

Comment for MESSAGETYPEID

See Also:

Constant Field Values

Method Detail

message

public abstract 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

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

message

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

Deprecated.

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

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)

Returns:

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

message

public final StartTransactionMessage message(java.lang.String userID,
                                             boolean userAuthenticatedByClient,
                                             java.lang.String signatureAlgorithm,
                                             byte[] signature)

Deprecated.

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

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

Returns:

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