be.SIRAPRISE.messages
Class ExecuteMonitorCommandMessageTypeV1_0

java.lang.Object
  be.SIRAPRISE.messages.ServerMessageType
      be.SIRAPRISE.messages.ServerInputMessageType
          be.SIRAPRISE.messages.ExecuteMonitorCommandMessageType
              be.SIRAPRISE.messages.ExecuteMonitorCommandMessageTypeV1_0

public final class ExecuteMonitorCommandMessageTypeV1_0
extends ExecuteMonitorCommandMessageType

ExecuteMonitorCommandMessageTypeV1_0 is V1_0 of the ExecuteMonitorCommandMessageType.

This message has the following fields :

Zone	Format	Length	Description
USERID	STRING		The name of the user issuing the monitor command. 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.
MONITORCOMMAND	LSTRING		The monitor command as syntactically defined in the grammar section.

Since:

SIRA_PRISE 1.1

Author:

Erwin Smout

Field Summary

Fields inherited from class be.SIRAPRISE.messages.ExecuteMonitorCommandMessageType

MESSAGETYPEID

Method Summary

ExecuteMonitorCommandMessage

message(java.lang.String monitorCommand, byte[] signature, java.lang.String userAuthenticationAlgorithm, boolean authenticatedByClient, java.lang.String userID) Produces an ExecuteMonitorCommandMessage of the appropriate type reflecting the given attribute values

Methods inherited from class java.lang.Object

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

Method Detail

message

public ExecuteMonitorCommandMessage message(java.lang.String monitorCommand,
                                            byte[] signature,
                                            java.lang.String userAuthenticationAlgorithm,
                                            boolean authenticatedByClient,
                                            java.lang.String userID)

Description copied from class: ExecuteMonitorCommandMessageType

Produces an ExecuteMonitorCommandMessage of the appropriate type reflecting the given attribute values

Specified by:

message in class ExecuteMonitorCommandMessageType

Parameters:

monitorCommand - The monitor command to be executed

signature - The signature authenticating the user ID

userAuthenticationAlgorithm - Name of the Signature algorithm to be used when signing the user ID/verifying the userID signature

authenticatedByClient - true if the user has been authenticated by the client

userID - The ID of the user issuing the monitor command

Returns:

The ExecuteMonitorCommandMessage of the appropriate type reflecting the given attribute values