be.SIRAPRISE.messages

Class PrintJournalsMessageTypeV1_0

java.lang.Object

be.SIRAPRISE.messages.ServerMessageType

be.SIRAPRISE.messages.ServerInputMessageType

be.SIRAPRISE.messages.ExecuteCompiledMonitorCommandMessageType

be.SIRAPRISE.messages.PrintJournalsMessageType

be.SIRAPRISE.messages.PrintJournalsMessageTypeV1_0

public final class PrintJournalsMessageTypeV1_0
extends PrintJournalsMessageType

The PrintJournalsMessageTypeV1_0 is used for instructing the server monitor to print out portions of the journal files

This message type has the following fields :

Field detail

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 CHALLENGE field obtained from the preceding ServerHello response message.
RELVARNAME	STRING		The name of the relvar for which the journals are to be printed. If the zero-length string, no selection based on relvar name is made during the printing.
FROM	STRING		The start point of the time window, the journal entries of which are to be printed. Formatted in ISO timestamp format (yyyy-MM-dd-HH.mm.ss.sssssss).
TO	STRING		The end point of the time window, the journal entries of which are to be printed. Formatted in ISO timestamp format (yyyy-MM-dd-HH.mm.ss.sssssss). Can be the zero-length string, in which case the time window for which to print journal entries is unbounded at the end.

Since:

SIRA_PRISE 1.5

Author:

Erwin

Field Summary

Fields inherited from class be.SIRAPRISE.messages.PrintJournalsMessageType

MESSAGETYPEID

Method Summary

Modifier and Type	Method and Description
static PrintJournalsMessageTypeV1_0	getInstance() Gets the instance of the message type
be.SIRAPRISE.messages.PrintJournalsMessageV1_0	message(MessageParams commandParams, byte[] signature, java.lang.String userAuthenticationAlgorithm, boolean authenticatedByClient, java.lang.String userID) Produces a CompiledMonitorCommandMessage 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

getInstance

public static PrintJournalsMessageTypeV1_0 getInstance()

Gets the instance of the message type

Returns:

the instance of the message type

message

public be.SIRAPRISE.messages.PrintJournalsMessageV1_0 message(MessageParams commandParams,
                                                              byte[] signature,
                                                              java.lang.String userAuthenticationAlgorithm,
                                                              boolean authenticatedByClient,
                                                              java.lang.String userID)

Description copied from class: ExecuteCompiledMonitorCommandMessageType

Produces a CompiledMonitorCommandMessage of the appropriate type reflecting the given attribute values

Specified by:

message in class ExecuteCompiledMonitorCommandMessageType

Parameters:

commandParams - The command object's relevant params to be communicated in a message to the server

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