com.ibm.sysmgt.sdk.remote
Class ManagedSystem

java.lang.Object
  extended bycom.ibm.sysmgt.sdk.remote.ManagedSystem
All Implemented Interfaces:
CompositeSystem, java.io.Serializable, TaskTarget

public class ManagedSystem
extends java.lang.Object
implements CompositeSystem, TaskTarget, java.io.Serializable

ManagedSystem - represents a System on the center pane of the Director Console.

See Also:
Serialized Form

Field Summary
static java.lang.String ATTRIB_AGENT_DATE
          Agent date - timestamp
static java.lang.String ATTRIB_AGENT_TIMEZONE_OFF
           
static java.lang.String ATTRIB_AGENT_TYPE
          Agent type - string (token)
static java.lang.String ATTRIB_AGENT_VERSION
          Agent version - string
static java.lang.String ATTRIB_ARCH_TYPE
          Architecture Type - string
static java.lang.String ATTRIB_COMPUTER_NAME
          Computer name - String
static java.lang.String ATTRIB_DOMAIN_NAME
          Domain name of managed object - string
static java.lang.String ATTRIB_IP_ADDRS
          Standard managed object attribute - IP addresses (TWGStringArray, in dotted decimal format)
static java.lang.String ATTRIB_IP_HOSTS
          Standard managed object attribute - IP hosts (TWGStringArray)
static java.lang.String ATTRIB_IPX_ADDRS
          Standard managed object attribute - IPX addresses (TWGStringArray, with 'xxxxxxxx.yyyyyyyyyyyy" as format (hex digits))
static java.lang.String ATTRIB_IS_ACCESS_DENIED
          Standard managed object attribute - access denied flag
static java.lang.String ATTRIB_MAC_ADDR_LIST
          MAC address list- String array
static java.lang.String ATTRIB_MAC_ADDRESS
          MAC address - byte array (byte[6])
static java.lang.String ATTRIB_MACHINE_TYPE_MODEL
          Machine type and model - string
static java.lang.String ATTRIB_MOF_ID
          Standard managed object attribute - ID of managed object factory
static java.lang.String ATTRIB_NAME
          Standard managed object attribute - managed object name
static java.lang.String ATTRIB_OS_MAJ_VER
          Operating system major version - integer
static java.lang.String ATTRIB_OS_MIN_VER
          Operating system minor version - integer
static java.lang.String ATTRIB_OS_TYPE
          Operating system type : token string matching MPM types (OS2, WINDOWS_9X, WINDOWS_NT, WINDOWS, NETWARE, DOS, etc)
static java.lang.String ATTRIB_SERIAL_NUMBER
          Serial number - string
static java.lang.String ATTRIB_STATE
          Standard managed object attribute - current state
static java.lang.String ATTRIB_TASKS
          Standard managed object attribute - list of task IDs in object
static java.lang.String ATTRIB_UUID
          UUID value - byte array (byte[16])
static java.lang.String ATTRIB_WORKGROUP_NAME
          Workgroup name of managed object - string
static int MOSTATE_ERROR_OFFLINE
           
static int MOSTATE_ERROR_ONLINE
           
static int MOSTATE_INDETERMINATE
           
static int MOSTATE_INVALID_OBJECT
           
static int MOSTATE_NORMAL_OFFLINE
           
static int MOSTATE_NORMAL_ONLINE
           
static int MOSTATE_UNKNOWN
           
static int MOSTATE_UNLICENSED
           
 
Constructor Summary
ManagedSystem(long oid, java.lang.String lbl, java.lang.String typ, int stat)
          Constructor
 
Method Summary
static java.util.List getAllSystems(LoginSession s)
          Gets a list of all managed systems
 Attribute getAttribute(LoginSession s, java.lang.String aid)
          Gets the managed system attribute that matches the attribute id.
 java.util.List getChildSystems(LoginSession s)
          In future releases, this will return the ManagedSystems that are associated under this ManagedSystem.
 CompositeStatus getCompositeStatus()
          Gets the CompositeStatus of this managed system
 CompositeStatus getCompositeStatus(LoginSession s)
          Gets the CompositeStatus of this managed system
 java.lang.String getLabel()
          Gets the label (name) of the managed system
 java.lang.String getObjectType()
          Gets the type of managed system this object is
 long getOid()
          Gets the object ID of the managed system
 int getStatus()
          Gets the status of the managed system
 java.util.Map getSystemAttributes(LoginSession s)
          Gets all of the attributes for the managed system
static ManagedSystem getSystemByOid(LoginSession s, long oid)
          Gets a managed system based on its object id
static java.util.List getSystemsByAttribute(LoginSession s, java.lang.String aid, DataValue value)
          Gets all systems matching the attribute id and value
static java.util.List getSystemsByAttribute(LoginSession s, java.lang.String aid, java.lang.String value)
          Gets all systems matching the attribute id and value
static java.util.List getSystemsByGroup(LoginSession s, int oid)
          Get all systems in a group.
static java.util.List getSystemsByLabel(LoginSession s, java.lang.String label)
          Gets a list of managed systems based on the label (name).
static java.util.List getSystemsByUniqueID(LoginSession s, long uid)
          Gets managed systems by unique ID
static java.util.List getSystemsByUniqueID(LoginSession s, TWGLong uid)
          Gets managed systems by unique ID
static java.util.List getSystemsByUUID(LoginSession s, byte[] uuid)
          Gets managed systems by UUID
static java.util.List getSystemsByUUID(LoginSession s, TWGByteArray uuid)
          Gets managed systems by UUID
 boolean isLocked(LoginSession s)
          Returns true if this Director Server does not have access to the System.
 void setObjectType(java.lang.String string)
          Sets the type of managed system this object is
 java.lang.String toString()
          Returns the Managed System data as a String
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MOSTATE_INVALID_OBJECT

public static final int MOSTATE_INVALID_OBJECT
See Also:
Constant Field Values

MOSTATE_UNKNOWN

public static final int MOSTATE_UNKNOWN
See Also:
Constant Field Values

MOSTATE_INDETERMINATE

public static final int MOSTATE_INDETERMINATE
See Also:
Constant Field Values

MOSTATE_ERROR_OFFLINE

public static final int MOSTATE_ERROR_OFFLINE
See Also:
Constant Field Values

MOSTATE_NORMAL_OFFLINE

public static final int MOSTATE_NORMAL_OFFLINE
See Also:
Constant Field Values

MOSTATE_ERROR_ONLINE

public static final int MOSTATE_ERROR_ONLINE
See Also:
Constant Field Values

MOSTATE_NORMAL_ONLINE

public static final int MOSTATE_NORMAL_ONLINE
See Also:
Constant Field Values

MOSTATE_UNLICENSED

public static final int MOSTATE_UNLICENSED
See Also:
Constant Field Values

ATTRIB_NAME

public static final java.lang.String ATTRIB_NAME
Standard managed object attribute - managed object name

See Also:
Constant Field Values

ATTRIB_TASKS

public static final java.lang.String ATTRIB_TASKS
Standard managed object attribute - list of task IDs in object

See Also:
Constant Field Values

ATTRIB_MOF_ID

public static final java.lang.String ATTRIB_MOF_ID
Standard managed object attribute - ID of managed object factory

See Also:
Constant Field Values

ATTRIB_STATE

public static final java.lang.String ATTRIB_STATE
Standard managed object attribute - current state

See Also:
Constant Field Values

ATTRIB_IS_ACCESS_DENIED

public static final java.lang.String ATTRIB_IS_ACCESS_DENIED
Standard managed object attribute - access denied flag

See Also:
Constant Field Values

ATTRIB_AGENT_TIMEZONE_OFF

public static final java.lang.String ATTRIB_AGENT_TIMEZONE_OFF
See Also:
Constant Field Values

ATTRIB_IP_ADDRS

public static final java.lang.String ATTRIB_IP_ADDRS
Standard managed object attribute - IP addresses (TWGStringArray, in dotted decimal format)

See Also:
Constant Field Values

ATTRIB_IP_HOSTS

public static final java.lang.String ATTRIB_IP_HOSTS
Standard managed object attribute - IP hosts (TWGStringArray)

See Also:
Constant Field Values

ATTRIB_IPX_ADDRS

public static final java.lang.String ATTRIB_IPX_ADDRS
Standard managed object attribute - IPX addresses (TWGStringArray, with 'xxxxxxxx.yyyyyyyyyyyy" as format (hex digits))

See Also:
Constant Field Values

ATTRIB_DOMAIN_NAME

public static final java.lang.String ATTRIB_DOMAIN_NAME
Domain name of managed object - string

See Also:
Constant Field Values

ATTRIB_WORKGROUP_NAME

public static final java.lang.String ATTRIB_WORKGROUP_NAME
Workgroup name of managed object - string

See Also:
Constant Field Values

ATTRIB_OS_TYPE

public static final java.lang.String ATTRIB_OS_TYPE
Operating system type : token string matching MPM types (OS2, WINDOWS_9X, WINDOWS_NT, WINDOWS, NETWARE, DOS, etc)

See Also:
Constant Field Values

ATTRIB_OS_MAJ_VER

public static final java.lang.String ATTRIB_OS_MAJ_VER
Operating system major version - integer

See Also:
Constant Field Values

ATTRIB_OS_MIN_VER

public static final java.lang.String ATTRIB_OS_MIN_VER
Operating system minor version - integer

See Also:
Constant Field Values

ATTRIB_AGENT_TYPE

public static final java.lang.String ATTRIB_AGENT_TYPE
Agent type - string (token)

See Also:
Constant Field Values

ATTRIB_AGENT_VERSION

public static final java.lang.String ATTRIB_AGENT_VERSION
Agent version - string

See Also:
Constant Field Values

ATTRIB_AGENT_DATE

public static final java.lang.String ATTRIB_AGENT_DATE
Agent date - timestamp

See Also:
Constant Field Values

ATTRIB_UUID

public static final java.lang.String ATTRIB_UUID
UUID value - byte array (byte[16])

See Also:
Constant Field Values

ATTRIB_MAC_ADDRESS

public static final java.lang.String ATTRIB_MAC_ADDRESS
MAC address - byte array (byte[6])

See Also:
Constant Field Values

ATTRIB_COMPUTER_NAME

public static final java.lang.String ATTRIB_COMPUTER_NAME
Computer name - String

See Also:
Constant Field Values

ATTRIB_ARCH_TYPE

public static final java.lang.String ATTRIB_ARCH_TYPE
Architecture Type - string

See Also:
Constant Field Values

ATTRIB_MAC_ADDR_LIST

public static final java.lang.String ATTRIB_MAC_ADDR_LIST
MAC address list- String array

See Also:
Constant Field Values

ATTRIB_MACHINE_TYPE_MODEL

public static final java.lang.String ATTRIB_MACHINE_TYPE_MODEL
Machine type and model - string

See Also:
Constant Field Values

ATTRIB_SERIAL_NUMBER

public static final java.lang.String ATTRIB_SERIAL_NUMBER
Serial number - string

See Also:
Constant Field Values
Constructor Detail

ManagedSystem

public ManagedSystem(long oid,
                     java.lang.String lbl,
                     java.lang.String typ,
                     int stat)
Constructor

Parameters:
oid - the object id of the managed system
lbl - the name of the managed system
typ - the type of managed system
stat - the status of the managed system
Method Detail

getOid

public long getOid()
Gets the object ID of the managed system

Specified by:
getOid in interface TaskTarget
Returns:
objectID - the object id of the managed system

getChildSystems

public java.util.List getChildSystems(LoginSession s)
In future releases, this will return the ManagedSystems that are associated under this ManagedSystem.

Specified by:
getChildSystems in interface CompositeSystem
Parameters:
s - - the login session to the Director Server
Returns:
null.
See Also:
CompositeSystem.getChildSystems(com.ibm.sysmgt.sdk.remote.LoginSession)

getAllSystems

public static java.util.List getAllSystems(LoginSession s)
                                    throws ServerCommunicationException,
                                           RequestFailedException
Gets a list of all managed systems

Parameters:
s - the LoginSession token
Returns:
list a list of all managed systems
Throws:
ServerCommunicationException
RequestFailedException

getSystemByOid

public static ManagedSystem getSystemByOid(LoginSession s,
                                           long oid)
                                    throws ServerCommunicationException,
                                           RequestFailedException
Gets a managed system based on its object id

Parameters:
s - the LoginSession token
oid - the object id for the managed system to retrieve
Returns:
ManagedSystem the managed system matching the object ID
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByLabel

public static java.util.List getSystemsByLabel(LoginSession s,
                                               java.lang.String label)
                                        throws ServerCommunicationException,
                                               RequestFailedException
Gets a list of managed systems based on the label (name). Currently just returns all systems regardless of label.

Parameters:
s - the LoginSession token
label - the name of the managed system
Returns:
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByAttribute

public static java.util.List getSystemsByAttribute(LoginSession s,
                                                   java.lang.String aid,
                                                   java.lang.String value)
                                            throws ServerCommunicationException,
                                                   RequestFailedException
Gets all systems matching the attribute id and value

Parameters:
s - the LoginSession token
aid - the id of the managed object attribute to match
value - the value of the managed object attribute to match
Returns:
List a list of all managed objects matching the attribute id and value
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByAttribute

public static java.util.List getSystemsByAttribute(LoginSession s,
                                                   java.lang.String aid,
                                                   DataValue value)
                                            throws ServerCommunicationException,
                                                   RequestFailedException
Gets all systems matching the attribute id and value

Parameters:
s - the LoginSession token
aid - the id of the managed object attribute to match
value - the value of the managed object attribute to match
Returns:
List a list of all managed objects matching the attribute id and value
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByGroup

public static java.util.List getSystemsByGroup(LoginSession s,
                                               int oid)
Get all systems in a group. Currently just returns an empty list.

Parameters:
s - the LoginSession token
oid - the object id for the group
Returns:
List a list of all the managed systems in the group

getAttribute

public Attribute getAttribute(LoginSession s,
                              java.lang.String aid)
                       throws RequestFailedException,
                              ServerCommunicationException
Gets the managed system attribute that matches the attribute id.

Parameters:
s - the LoginSession token
aid - the attribute id
Returns:
Attribute the Attribute object containing the attribute data, null if the attribute requested isn't valid for that managed system.
Throws:
RequestFailedException
ServerCommunicationException

getLabel

public java.lang.String getLabel()
Gets the label (name) of the managed system

Specified by:
getLabel in interface CompositeSystem
Returns:
String the managed system label

isLocked

public boolean isLocked(LoginSession s)
                 throws ServerCommunicationException,
                        RequestFailedException
Returns true if this Director Server does not have access to the System.

Returns:
The "locked" status of the system
Throws:
ServerCommunicationException
RequestFailedException

getStatus

public int getStatus()
Gets the status of the managed system

Returns:
status the status of the managed system

getSystemAttributes

public java.util.Map getSystemAttributes(LoginSession s)
                                  throws ServerCommunicationException,
                                         RequestFailedException
Gets all of the attributes for the managed system

Parameters:
s - the LoginSession token
Returns:
Map a HashMap containing the system attributes
Throws:
ServerCommunicationException
RequestFailedException

getObjectType

public java.lang.String getObjectType()
Gets the type of managed system this object is

Returns:
String the managed system type

setObjectType

public void setObjectType(java.lang.String string)
Sets the type of managed system this object is

Parameters:
string - the managed system type

getCompositeStatus

public CompositeStatus getCompositeStatus()
Gets the CompositeStatus of this managed system

Specified by:
getCompositeStatus in interface CompositeSystem
Returns:
CompositeStatus the CompositeStatus of this managed system

getCompositeStatus

public CompositeStatus getCompositeStatus(LoginSession s)
                                   throws ServerCommunicationException,
                                          RequestFailedException
Gets the CompositeStatus of this managed system

Parameters:
s - the LoginSession token
Returns:
CompositeStatus the CompositeStatus of this managed system
Throws:
ServerCommunicationException
RequestFailedException

toString

public java.lang.String toString()
Returns the Managed System data as a String

Returns:
String the Managed System data as a String

getSystemsByUniqueID

public static java.util.List getSystemsByUniqueID(LoginSession s,
                                                  long uid)
                                           throws ServerCommunicationException,
                                                  RequestFailedException
Gets managed systems by unique ID

Parameters:
s - the LoginSession token
uid - the unique ID of the managed system
Returns:
List a list of all managed systems matching the unique id
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByUniqueID

public static java.util.List getSystemsByUniqueID(LoginSession s,
                                                  TWGLong uid)
                                           throws ServerCommunicationException,
                                                  RequestFailedException
Gets managed systems by unique ID

Parameters:
s - the LoginSession token
uid - the unique ID of the managed system
Returns:
List a list of all managed systems matching the unique id
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByUUID

public static java.util.List getSystemsByUUID(LoginSession s,
                                              byte[] uuid)
                                       throws ServerCommunicationException,
                                              RequestFailedException
Gets managed systems by UUID

Parameters:
s - the LoginSession token
uuid - the UUID of the managed system
Returns:
List a list of all managed systems matching the UUID
Throws:
ServerCommunicationException
RequestFailedException

getSystemsByUUID

public static java.util.List getSystemsByUUID(LoginSession s,
                                              TWGByteArray uuid)
                                       throws ServerCommunicationException,
                                              RequestFailedException
Gets managed systems by UUID

Parameters:
s - the LoginSession token
uuid - the UUID of the managed system
Returns:
List a list of all managed systems matching the UUID
Throws:
ServerCommunicationException
RequestFailedException