be.SIRAPRISE.messages

Class HotRestartMessageTypeV1_0

java.lang.Object

be.SIRAPRISE.messages.ServerMessageType

be.SIRAPRISE.messages.ServerInputMessageType

be.SIRAPRISE.messages.ExecuteCompiledMonitorCommandMessageType

be.SIRAPRISE.messages.HotRestartMessageType

be.SIRAPRISE.messages.HotRestartMessageTypeV1_0

public final class HotRestartMessageTypeV1_0
extends HotRestartMessageType

The HotRestartMessageType is used for instructing the server monitor to return an overview of the file pool to the user.

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.

Since:

SIRA_PRISE 1.5

Author:

Erwin

Field Summary

Fields inherited from class be.SIRAPRISE.messages.HotRestartMessageType

MESSAGETYPEID

Method Summary

Modifier and Type	Method and Description
static HotRestartMessageType	getInstance() Gets The instance of the message type
HotRestartMessage	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 HotRestartMessageType getInstance()

Gets The instance of the message type

Returns:

The instance of the message type

message

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