Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKServerInventoryMgmtFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkSysAdminImpFed
        |
        +--com.ibm.mm.sdk.common.DKServerInventoryMgmtFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKServerInventoryMgmtFed
extends com.ibm.mm.sdk.common.dkSysAdminImpFed
implements DKConstant, DKConstantFed, DKMessageIdFed, java.io.Serializable

This class provides methods to acess the server inventory, and log data from the federated database.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Method Summary
 void addInventory(DKAttrInventoryDefFed sd)
          Add an inventory entry
 void addInventory(dkCollection attrCol, java.lang.String nativeEntityName, int serverId, java.lang.String urlPrefixStr)
          Add an inventory entry
 void addTextInventory(DKTextInventoryDefFed sd)
          Add a Text inventory entry
 boolean checkServerInventory()
          Check the server inventory.
 boolean checkServerInventory(java.lang.String server)
          Check the server inventory for one sever.
 dkDatastore getDatastore()
          Gets datastore reference
 DKAttrInventoryDefFed getInventory(java.lang.String server, java.lang.String entity, java.lang.String attribute)
          Get an inventory item by server name, entity name, and attribute name
 int getServerId(java.lang.String server, java.lang.String type)
           
 DKTextInventoryDefFed getTextInventory(java.lang.String server, java.lang.String index)
          Get an Text inventory item by server name, index name returns a DKTextInventoryDefFed object.
 dkCollection listInventory()
          List inventories defined in the system
 dkCollection listInventory(java.lang.String server)
          list the Inventory by server name
 dkCollection listInventory(java.lang.String server, java.lang.String entity)
          list the Inventory by server and entity name
 dkCollection listServerEntities(java.lang.String server)
          List the entity associated with the server.
 java.lang.String[] listServerEntityAttrNames(java.lang.String server, java.lang.String entity)
          List the attributes associated with the entity.
 dkCollection listServerEntityAttrs(java.lang.String server, java.lang.String entity)
          List the attributes associated with the entity.
 java.lang.String[] listServerEntityNames(java.lang.String server)
          List the entity associated with the server.
 java.lang.String[] listServerNames()
          List the servers defined in the Federated database.
 dkCollection listServers()
          List the servers defined in the Federated database.
 dkCollection listTextInventory()
          List inventories defined in the system
 dkCollection listTextInventory(java.lang.String server)
          list the Text Inventory by Text server name
 void lockInventoryForUpdate()
           
 void removeAllInventory()
          Remove the whole inventory
 void removeAllTextInventory()
          Remove the whole Text inventory
 void removeInventory(java.lang.String name)
          Remove inventory by server name
 void removeInventory(java.lang.String server, java.lang.String entity)
          Remove an inventory items by server name, entity name
 void removeInventory(java.lang.String server, java.lang.String entity, java.lang.String attribute)
          Remove an inventory item by server name, entity name, and attribute name
 void removeTextInventory(java.lang.String name)
          Remove Text inventory by Text server name
 void removeTextInventory(java.lang.String server, java.lang.String index)
          Remove an text inventory item by server name and index name
 void setDatastore(dkDatastore ds)
          Sets datastore reference
 void unlockInventory()
           
 void updateInventory(DKAttrInventoryDefFed sd)
          Update an inventory entry by server name, entity, and attribute.
 void updateTextInventory(DKTextInventoryDefFed sd)
          Update a Text inventory entry by server name, index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception
Sets datastore reference

getDatastore

public dkDatastore getDatastore()
Gets datastore reference

listServers

public dkCollection listServers()
                         throws DKException,
                                java.lang.Exception
List the servers defined in the Federated database.
Returns:
a dkCollection of DKServerMapDefFed objects

listServerNames

public java.lang.String[] listServerNames()
                                   throws DKException,
                                          java.lang.Exception
List the servers defined in the Federated database.
Returns:
A String array of server names.

listServerEntities

public dkCollection listServerEntities(java.lang.String server)
                                throws DKException,
                                       java.lang.Exception
List the entity associated with the server.
Returns:
a dkCollection of DKEntityInventoryDefFed objects

listServerEntityNames

public java.lang.String[] listServerEntityNames(java.lang.String server)
                                         throws DKException,
                                                java.lang.Exception
List the entity associated with the server.
Returns:
A String array of entity names.

listServerEntityAttrs

public dkCollection listServerEntityAttrs(java.lang.String server,
                                          java.lang.String entity)
                                   throws DKException,
                                          java.lang.Exception
List the attributes associated with the entity.
Returns:
a dkCollection of DKAttrInventoryDefFed objects

listServerEntityAttrNames

public java.lang.String[] listServerEntityAttrNames(java.lang.String server,
                                                    java.lang.String entity)
                                             throws DKException,
                                                    java.lang.Exception
List the attributes associated with the entity.
Returns:
A String array of attribute names.

listInventory

public dkCollection listInventory()
                           throws DKException,
                                  java.lang.Exception
List inventories defined in the system

listInventory

public dkCollection listInventory(java.lang.String server)
                           throws DKException,
                                  java.lang.Exception
list the Inventory by server name
Returns:
a dkCollection of DKAttrInventoryDefFed objects

listInventory

public dkCollection listInventory(java.lang.String server,
                                  java.lang.String entity)
                           throws DKException,
                                  java.lang.Exception
list the Inventory by server and entity name
Returns:
a dkCollection of DKAttrInventoryDefFed objects

removeInventory

public void removeInventory(java.lang.String name)
                     throws DKException,
                            java.lang.Exception
Remove inventory by server name

removeAllInventory

public void removeAllInventory()
                        throws DKException,
                               java.lang.Exception
Remove the whole inventory

removeInventory

public void removeInventory(java.lang.String server,
                            java.lang.String entity)
                     throws DKException,
                            java.lang.Exception
Remove an inventory items by server name, entity name

removeInventory

public void removeInventory(java.lang.String server,
                            java.lang.String entity,
                            java.lang.String attribute)
                     throws DKException,
                            java.lang.Exception
Remove an inventory item by server name, entity name, and attribute name

getInventory

public DKAttrInventoryDefFed getInventory(java.lang.String server,
                                          java.lang.String entity,
                                          java.lang.String attribute)
                                   throws DKException,
                                          java.lang.Exception
Get an inventory item by server name, entity name, and attribute name

addInventory

public void addInventory(dkCollection attrCol,
                         java.lang.String nativeEntityName,
                         int serverId,
                         java.lang.String urlPrefixStr)
                  throws DKException,
                         java.lang.Exception
Add an inventory entry

addInventory

public void addInventory(DKAttrInventoryDefFed sd)
                  throws DKException,
                         java.lang.Exception
Add an inventory entry

updateInventory

public void updateInventory(DKAttrInventoryDefFed sd)
                     throws DKException,
                            java.lang.Exception
Update an inventory entry by server name, entity, and attribute. The server name, entity, and attribute can't be modified.

listTextInventory

public dkCollection listTextInventory()
                               throws DKException,
                                      java.lang.Exception
List inventories defined in the system

addTextInventory

public void addTextInventory(DKTextInventoryDefFed sd)
                      throws DKException,
                             java.lang.Exception
Add a Text inventory entry

removeAllTextInventory

public void removeAllTextInventory()
                            throws DKException,
                                   java.lang.Exception
Remove the whole Text inventory

listTextInventory

public dkCollection listTextInventory(java.lang.String server)
                               throws DKException,
                                      java.lang.Exception
list the Text Inventory by Text server name

removeTextInventory

public void removeTextInventory(java.lang.String name)
                         throws DKException,
                                java.lang.Exception
Remove Text inventory by Text server name

removeTextInventory

public void removeTextInventory(java.lang.String server,
                                java.lang.String index)
                         throws DKException,
                                java.lang.Exception
Remove an text inventory item by server name and index name

getTextInventory

public DKTextInventoryDefFed getTextInventory(java.lang.String server,
                                              java.lang.String index)
                                       throws DKException,
                                              java.lang.Exception
Get an Text inventory item by server name, index name returns a DKTextInventoryDefFed object.

updateTextInventory

public void updateTextInventory(DKTextInventoryDefFed sd)
                         throws DKException,
                                java.lang.Exception
Update a Text inventory entry by server name, index. The server name, index can't be modified.

checkServerInventory

public boolean checkServerInventory()
                             throws DKException,
                                    java.lang.Exception
Check the server inventory. The mismatched will be put into the log.
Returns:
boolean: true indicates there is missing items.

checkServerInventory

public boolean checkServerInventory(java.lang.String server)
                             throws DKException,
                                    java.lang.Exception
Check the server inventory for one sever. The mismatched will be put into the log.
Returns:
boolean: true indicates there is missing items.

getServerId

public int getServerId(java.lang.String server,
                       java.lang.String type)
                throws DKException,
                       java.lang.Exception

lockInventoryForUpdate

public void lockInventoryForUpdate()
                            throws DKException,
                                   java.lang.Exception

unlockInventory

public void unlockInventory()
                     throws DKException,
                            java.lang.Exception

EIP Java APIs

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