com.tivoli.twg.engine
Class TWGUserPropertiesCommand

java.lang.Object
  extended bycom.tivoli.twg.libs.Command
      extended bycom.tivoli.twg.engine.TWGUserPropertiesCommand

public class TWGUserPropertiesCommand
extends Command

User properties command class.


Field Summary
static long RETURN_CODE_INVALID_PARAMETER
           
static long RETURN_CODE_INVALID_SUBCOMMAND
           
static long RETURN_CODE_INVALID_TYPE
           
static long RETURN_CODE_SUCCESS
           
static long RETURN_CODE_UNEXPECTED_ERROR
           
static long RETURN_CODE_UNKNOWN_ACTIVE_CONSOLE
           
static long RETURN_CODE_UNKNOWN_USER
           
static int SUBCOMMAND_DELETE
           
static int SUBCOMMAND_GET
           
static int SUBCOMMAND_SET
           
static int TYPE_BYTES
           
static int TYPE_INT
           
static int TYPE_STRING
           
 
Fields inherited from class com.tivoli.twg.libs.Command
CMD_SENDER_FLAG, CMDRET_CREATE_CMDPKT_FAILED, CMDRET_ENCRYPT_FAIL, CMDRET_ENQUEUE_LOCAL_FAILED, CMDRET_INVALID_DEST_ADDRESS, CMDRET_NO_LOCAL_SVCNODE_IMPL, CMDRET_SECURE_FAIL, CMDRET_SEND_BUFFER_FAILED, CMDRET_SEND_FAILED, CMDRET_SEND_TIMEOUT, CMDRET_SERVICEFAILED, CMDRET_SESS_DISABLED_LCL, CMDRET_SESS_DISABLED_RMT, CMDRET_SESS_UNAVAIL_LCL, CMDRET_SESS_UNAVAIL_RMT, CMDRET_SESS_WAIT_DONE, CMDRET_SESS_WAIT_EXPIRED, CMDRET_SESS_WAITING, COMMAND_TYPE_INPUT, COMMAND_TYPE_OUTPUT, DEFAULT_CMD_TIMEOUT, ENQUEUE_FAILED_COPYDATA, ENQUEUE_FAILED_NO_DESTPATH, ENQUEUE_FAILED_NO_PROCESS_HANDLE, ENQUEUE_FAILED_NO_SVC_NODE_HANDLE, ENQUEUE_FAILED_SECURITY, ENQUEUE_GENERAL_FAILURE, JNI_BUFFER_NULL, JNI_ENTRY_POINT_NOT_LOADED, JNI_HANDLE_NULL, JNI_INITIALIZE_FAILED, RMI_LOOKUP_ERROR, SESSION_NONE, SESSION_PREFERRED, SESSION_REQUIRED
 
Constructor Summary
TWGUserPropertiesCommand()
          constructor.
 
Method Summary
 void requestDelete(java.lang.String key)
          Input method to delete a user property.
 void requestGetBytes(java.lang.String key)
          Input method to get the value of a user property (byte []).
 void requestGetInt(java.lang.String key)
          Input method to get the value of a user property (int).
 void requestGetString(java.lang.String key)
          Input method to get the value of a user property (string).
 void requestSetBytes(java.lang.String key, byte[] value)
          Input method to set the value of a user property (byte []).
 void requestSetInt(java.lang.String key, int value)
          Input method to set the value of a user property (int).
 void requestSetString(java.lang.String key, java.lang.String value)
          Input method to set the value of a user property (string).
 void responseDelete(int index)
          Output method to delete a user property.
 byte[] responseGetBytes(int index)
          Output method to get the value of a user property (byte []).
 int responseGetInt(int index)
          Output method to get the value of a user property (int).
 java.lang.String responseGetString(int index)
          Output method to get the value of a user property (string).
 void responseSetBytes(int index)
          Output method to set the value of a user property (byte []).
 void responseSetInt(int index)
          Output method to set the value of a user property (int).
 void responseSetString(int index)
          Output method to set the value of a user property (string).
 
Methods inherited from class com.tivoli.twg.libs.Command
AddInputParm, AddInputParm, AddObjectAsInputParm, AddObjectAsOutputParm, AddOutputParm, AddOutputParm, addToDebugStrings, AllocateBuffer, AttachInputParm, AttachOutputParm, CmdId, CommandCode, commandCodeDebugString, CommandComplete, CompressObject, debugPrint, DecompressObject, DestinationAddress, DetachInputParm, DetachOutputParm, FreeBuffer, FreeInputsAfterSend, getCmdType, GetObjectFromInputParm, GetObjectFromOutputParm, getSenderServiceNode, hexDump, InputParm, InputParm, InputParmLength, IsFlatInputBuffer, IsFlatOutputBuffer, IsPostponedReply, MakeFlatInputBuffer, MakeFlatOutputBuffer, NumInputParms, NumOutputParms, OutputParm, OutputParm, OutputParmLength, Postpo neReply, ResetIndex, ResetInput, ResetOutput, ReturnAddress, ReturnCode, ReturnCodeToString, RootDestinationAddress, RootReturnAddress, SessionHold, SessionMode, SessionRelease, SessionWaitTime, setCmdType, setCmdTypeInput, setCmdTypeOutput, SetCommandCode, setCommandCodeDebugString, setCommandCompleteListener, SetDestinationAddress, SetNewID, SetReturnAddress, SetReturnCode, setSenderServiceNode, SetSessionHold, SetSessionMode, SetSessionRelease, SetSessionWaitTime, SetTimeOut, TimeOut, toString, UseFlatInputBuffer, UseFlatOutputBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SUBCOMMAND_GET

public static final int SUBCOMMAND_GET
See Also:
Constant Field Values

SUBCOMMAND_SET

public static final int SUBCOMMAND_SET
See Also:
Constant Field Values

SUBCOMMAND_DELETE

public static final int SUBCOMMAND_DELETE
See Also:
Constant Field Values

TYPE_BYTES

public static final int TYPE_BYTES
See Also:
Constant Field Values

TYPE_INT

public static final int TYPE_INT
See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
See Also:
Constant Field Values

RETURN_CODE_SUCCESS

public static final long RETURN_CODE_SUCCESS
See Also:
Constant Field Values

RETURN_CODE_INVALID_PARAMETER

public static final long RETURN_CODE_INVALID_PARAMETER
See Also:
Constant Field Values

RETURN_CODE_INVALID_SUBCOMMAND

public static final long RETURN_CODE_INVALID_SUBCOMMAND
See Also:
Constant Field Values

RETURN_CODE_INVALID_TYPE

public static final long RETURN_CODE_INVALID_TYPE
See Also:
Constant Field Values

RETURN_CODE_UNKNOWN_ACTIVE_CONSOLE

public static final long RETURN_CODE_UNKNOWN_ACTIVE_CONSOLE
See Also:
Constant Field Values

RETURN_CODE_UNKNOWN_USER

public static final long RETURN_CODE_UNKNOWN_USER
See Also:
Constant Field Values

RETURN_CODE_UNEXPECTED_ERROR

public static final long RETURN_CODE_UNEXPECTED_ERROR
See Also:
Constant Field Values
Constructor Detail

TWGUserPropertiesCommand

public TWGUserPropertiesCommand()
constructor.

Method Detail

requestGetBytes

public void requestGetBytes(java.lang.String key)
Input method to get the value of a user property (byte []).

Parameters:
key - name of user property to get.

responseGetBytes

public byte[] responseGetBytes(int index)
                        throws TWGUserPropertiesCommandException
Output method to get the value of a user property (byte []).

Parameters:
index - output parameter index.
Returns:
byte[] value of user property.
Throws:
TWGUserPropertiesCommandException

requestSetBytes

public void requestSetBytes(java.lang.String key,
                            byte[] value)
Input method to set the value of a user property (byte []).

Parameters:
key - name of user property to set.
value - byte array.

responseSetBytes

public void responseSetBytes(int index)
                      throws TWGUserPropertiesCommandException
Output method to set the value of a user property (byte []).

Parameters:
index - output parameter index.
Throws:
TWGUserPropertiesCommandException.
TWGUserPropertiesCommandException

requestGetInt

public void requestGetInt(java.lang.String key)
Input method to get the value of a user property (int).

Parameters:
key - name of user property to get.

responseGetInt

public int responseGetInt(int index)
                   throws TWGUserPropertiesCommandException
Output method to get the value of a user property (int).

Parameters:
index - output parameter index.
Returns:
int value of user property.
Throws:
TWGUserPropertiesCommandException

requestSetInt

public void requestSetInt(java.lang.String key,
                          int value)
Input method to set the value of a user property (int).

Parameters:
key - name of user property to set.
value - integer.

responseSetInt

public void responseSetInt(int index)
                    throws TWGUserPropertiesCommandException
Output method to set the value of a user property (int).

Parameters:
index - output parameter index.
Throws:
TWGUserPropertiesCommandException.
TWGUserPropertiesCommandException

requestGetString

public void requestGetString(java.lang.String key)
Input method to get the value of a user property (string).

Parameters:
key - name of user property to get.

responseGetString

public java.lang.String responseGetString(int index)
                                   throws TWGUserPropertiesCommandException
Output method to get the value of a user property (string).

Parameters:
index - output parameter index.
Returns:
String value of user property.
Throws:
TWGUserPropertiesCommandException

requestSetString

public void requestSetString(java.lang.String key,
                             java.lang.String value)
Input method to set the value of a user property (string).

Parameters:
key - name of user property to set.
value - String.

responseSetString

public void responseSetString(int index)
                       throws TWGUserPropertiesCommandException
Output method to set the value of a user property (string).

Parameters:
index - output parameter index.
Throws:
TWGUserPropertiesCommandException.
TWGUserPropertiesCommandException

requestDelete

public void requestDelete(java.lang.String key)
Input method to delete a user property.

Parameters:
key - name of user property to delete.

responseDelete

public void responseDelete(int index)
                    throws TWGUserPropertiesCommandException
Output method to delete a user property.

Parameters:
index - output parameter index.
Throws:
TWGUserPropertiesCommandException.
TWGUserPropertiesCommandException