Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKResourceMgrDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKResourceMgrDefICM

public class DKResourceMgrDefICM
extends java.lang.Object

Use this class to represent a resource manager in your program. This class provides the facilities to manage the details of resource manager and this object can be used with DKRMConfigurationMgmtICM to add, update, delete and list resource managers in the ICM datastore.


Constructor Summary
DKResourceMgrDefICM()
          Default constructor
DKResourceMgrDefICM(java.lang.String name)
          Constructs a new DKResourceMgrDefICM object with a given name as the resource manager name.
 
Method Summary
 void addAccessType(DKAccessTypeDef accessTypeObj)
          Adds an access protocol for this resource manager.
 dkCollection getAccessType()
          Gets a collection of resource manager access protocol that is supported by this resource manager.
 dkAdminDomainDef getAdminDomain()
          Gets the administrative domain to which this resource manager belongs to.
 java.lang.String getINETAddress()
          Gets the inet address host name or the IP address of the machine on which this resource manager runs.
 java.lang.String getLastChanged()
          Gets the time stamp when this resource manager was last updated.
 java.lang.String getName()
          Gets the name of this resource manager.
 short getPlatform()
          Gets the operating system platform for this resource manager.
 short getRMCode()
          Gets the internal code or id for this resource manager.This code is assigned by the ICM datastore for this resource manager.
 java.lang.String getRMUserid()
          Gets the userid that can be used to logon to this resource manager for SMS administration..
 int getTokenDuration()
          Gets the token duration of this resource manager server
 java.lang.String getUserid()
          Gets the userid of the administrator who created or updated this resource manager last
 boolean isLANCacheEnabled()
          Checks to see if LAN cache is enabled for this resource manager.
 boolean isServerAvailable(boolean fromAdmin)
          Checks to see whether this resource manager is currently online
 void removeAccessType(java.lang.String name)
          Removes all access protocol by given name
 void removeAccessType(java.lang.String name, short portNumber)
          Removes an access protocol by name and port number
 void setAdminDomain(dkAdminDomainDef domain)
          Sets the administrative domain to which this resource manager belongs to.
 void setINETAddress(java.lang.String inetAddr)
          Sets the host name or IP address of machine on which this resource manager runs.
 void setLANCacheEnabled(boolean isLANCache)
          Enables the LAN cache for this resource manager
 void setName(java.lang.String name)
          Sets the name of the resource manager.
 void setPlatform(short platform)
          Sets the operating system of the resource manager.
 void setRMPasswd(java.lang.String pwd)
          Sets the userid password for the SMS administative userid who can SMS administer this resource manager
 void setRMUserid(java.lang.String uid)
          Sets the SMS administative userid for this resource manager.
 void setServerAvailable(boolean serverAvail, boolean fromAdmin)
          Sets to whether this resource manager is currently online
 void setTokenDuration(int duration)
          Sets the token duration of this resource manager server.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKResourceMgrDefICM

public DKResourceMgrDefICM()
Default constructor

DKResourceMgrDefICM

public DKResourceMgrDefICM(java.lang.String name)
Constructs a new DKResourceMgrDefICM object with a given name as the resource manager name.
Parameters:
name - String - name of the resource manager
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of the resource manager. The resource manager should be unique for a given ICM datastore.
Parameters:
name - Sting - name of the resource manager. The name can be up to 128 characters.

getName

public java.lang.String getName()
Gets the name of this resource manager.
Returns:
name of the resource manager. The name can be up to 128 characters.

setPlatform

public void setPlatform(short platform)
Sets the operating system of the resource manager. The value specified here should be one of the following.
Parameters:
platform - - operating system of the machine on which the resource manager runs.Use the constants

getPlatform

public short getPlatform()
Gets the operating system platform for this resource manager. The return value should be one of the following.
Returns:
the operating system of this resource manager

getUserid

public java.lang.String getUserid()
Gets the userid of the administrator who created or updated this resource manager last
Returns:
_userid - the userid of the administrator who added this resource manager. This string can be up to 32 characters long.

getLastChanged

public java.lang.String getLastChanged()
Gets the time stamp when this resource manager was last updated.
Returns:
the last changed time stamp when this resource manager was last updated. The format of the time stamp is as follows. YYYY-MM-DD-HH.MM.SS.milliseconds

setINETAddress

public void setINETAddress(java.lang.String inetAddr)
Sets the host name or IP address of machine on which this resource manager runs. The host name can be up to 128 characters.
Parameters:
inetAddr - - The host name or the IP address of the resource manager.

getINETAddress

public java.lang.String getINETAddress()
Gets the inet address host name or the IP address of the machine on which this resource manager runs.
Returns:
inet address

getRMCode

public short getRMCode()
Gets the internal code or id for this resource manager.This code is assigned by the ICM datastore for this resource manager.
Returns:
resource manager code

setTokenDuration

public void setTokenDuration(int duration)
Sets the token duration of this resource manager server. The duration value is base 10 formated 32 bit integer value. Time in seconds (optional)
Parameters:
duration - - token duration

getTokenDuration

public int getTokenDuration()
Gets the token duration of this resource manager server
Returns:
token duration

getAccessType

public dkCollection getAccessType()
Gets a collection of resource manager access protocol that is supported by this resource manager.
Returns:
a dkCollection of DKAccessTypeDef objects.

setLANCacheEnabled

public void setLANCacheEnabled(boolean isLANCache)
Enables the LAN cache for this resource manager
Parameters:
isLANCache - - true if LAN Cache is enabled, false otherwise. Note: LAN CACHE IS NOT SUPPORTED FOR THIS RELEASE.

isLANCacheEnabled

public boolean isLANCacheEnabled()
Checks to see if LAN cache is enabled for this resource manager.
Returns:
true if LAN cache is enabled for this resource manager, false otherwise

isServerAvailable

public boolean isServerAvailable(boolean fromAdmin)
Checks to see whether this resource manager is currently online
Parameters:
fromAdmin - if the administrator is setting or runtime client
Returns:
true if resource manager is available, false if resource manager has been marked as offline

setServerAvailable

public void setServerAvailable(boolean serverAvail,
                               boolean fromAdmin)
Sets to whether this resource manager is currently online
Parameters:
serverAvail - - true if want to set the resource manager offline, false otherwise
fromAdmin - - if the administrator is setting or runtime client

addAccessType

public void addAccessType(DKAccessTypeDef accessTypeObj)
Adds an access protocol for this resource manager.
Parameters:
accessTypeObj - DKAccessTypeDef - access protocol object to be added to this resource manager

removeAccessType

public void removeAccessType(java.lang.String name)
Removes all access protocol by given name
Parameters:
name - String - access protocol name to be removed

removeAccessType

public void removeAccessType(java.lang.String name,
                             short portNumber)
Removes an access protocol by name and port number
Parameters:
name - String - access protocol name to be removed
portNumber - short - port number for the protocol to be removed

setAdminDomain

public void setAdminDomain(dkAdminDomainDef domain)
Sets the administrative domain to which this resource manager belongs to.
Parameters:
domain - - the administrative domain to which this resource manager belongs to.

getAdminDomain

public dkAdminDomainDef getAdminDomain()
Gets the administrative domain to which this resource manager belongs to.
Returns:
administrative domain to which this resource manager belongs to.

getRMUserid

public java.lang.String getRMUserid()
Gets the userid that can be used to logon to this resource manager for SMS administration..
Returns:
The userid that can be used to logon on to this resource manager for SMS administation

setRMUserid

public void setRMUserid(java.lang.String uid)
Sets the SMS administative userid for this resource manager.
Parameters:
uid - - resource manager SMS administrative userid.This userid can be up to 32 characters. NOTE: If you are updating the SMS administative userid please make sure that you are also updating this userid in the Resource Manager. Use the System Administration Client to do this.

setRMPasswd

public void setRMPasswd(java.lang.String pwd)
Sets the userid password for the SMS administative userid who can SMS administer this resource manager
Parameters:
pwd - - SMS administer's password for this resource manager.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.