Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKServerMapDefFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKServerMapDefFed
All Implemented Interfaces:
dkServerDef, java.io.Serializable

public class DKServerMapDefFed
extends java.lang.Object
implements dkServerDef, java.io.Serializable

See Also:
Serialized Form

Constructor Summary
DKServerMapDefFed()
           
DKServerMapDefFed(dkDatastore ds)
          Constructs a new DKServerMapDefFed class with owner datastore object
DKServerMapDefFed(java.lang.String name)
          Construct a DKServerMapDefFed object initialized to the specified name
 
Method Summary
 void add()
          Adds this Server entry to become a persistent part in the federated database
 java.lang.String datastoreName()
          Gets the name of this datastore object.
 java.lang.String datastoreType()
          Gets datastore type
 void del()
          Removes this Server entry from the persistent federated database
 java.lang.String getAXClass()
          Get ActiveX class name.
 java.lang.String getConnectString()
          Get the Initial Parameter String that contains information to connect to Content Management server.
 java.lang.String getCppClass()
          Get C++ class name.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getDescription()
          Get the description for this server.
 java.lang.String getInitializationString()
          Get the Initial Parameter String that contains information to initialize Content Management server.
 java.lang.String getJavaClass()
          Get Java class name.
 java.lang.String getName()
          Get the server name.
 java.lang.String getNativeServerType()
          Get the server type.
 java.lang.String getNewServerName()
          Get the new server name.
 DKTimestamp getRefreshTime()
          Get the DKTimestamp of the last time Federated Server Inventory program has collected information form this server.
 java.lang.String getRemoteHost()
          Get the remote host name.
 int getRemotePort()
          Get port number for remote host.
 java.lang.String getServerType()
          Get the server type in String.
 dkCollection listEntities()
          List the entities associated with this server in the inventory table.
 java.lang.String[] listEntityNames()
          List the entities associated with this server in the inventory table.
 java.lang.String[] listNativeEntityNames(java.lang.String fedEntityName)
          Gets a list of native entity names for the specified federate entity name
 dkCollection listSearchServices()
          Gets a list of associated Search Services
 void retrieve()
          Retrieves this Server entry from the persistent part in the federated database
 void setAXClass(java.lang.String name)
          Set ActiveX class name.
 void setConnectString(java.lang.String connParam)
          Set the Initial Parameter String that contains information to connect to Content Management server.
 void setCppClass(java.lang.String name)
          Set C++ class name.
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setDescription(java.lang.String desc)
          Set the description for this server.
 void setInitializationString(java.lang.String initParam)
          Set the Initial Parameter String that contains information to initialize Content Management server.
 void setJavaClass(java.lang.String name)
          Set Java class name.
 void setName(java.lang.String name)
          Set the server name.
 void setNativeServerType(java.lang.String name)
          Set the server type.
 void setNewServerName(java.lang.String name)
          Set the new server name.
 void setRefreshTime(DKTimestamp time)
          Set the Timestamp to indicate the last time Federated Server Inventory program has collected information from this server.
 void setRemoteHost(java.lang.String name)
          Set the remote host name.
 void setRemotePort(int port)
          Set the port number for remote host
 void setSearchService(java.lang.String name, dkServerDef searchService)
          Sets the Search Service for this server
 void setServerType(java.lang.String type)
          Set the server type in String.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKServerMapDefFed

public DKServerMapDefFed()

DKServerMapDefFed

public DKServerMapDefFed(java.lang.String name)
Construct a DKServerMapDefFed object initialized to the specified name

DKServerMapDefFed

public DKServerMapDefFed(dkDatastore ds)
                  throws java.lang.Exception,
                         DKException
Constructs a new DKServerMapDefFed class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkServerDef
Following copied from interface: com.ibm.mm.sdk.common.dkServerDef
Parameters:
ds - datastore

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkServerDef
Returns:
the dkDatastore object

datastoreType

public java.lang.String datastoreType()
Gets datastore type
Specified by:
datastoreType in interface dkServerDef
Returns:
name of type of datastore this server belongs to

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this Server entry to become a persistent part in the federated database

retrieve

public void retrieve()
              throws DKException,
                     java.lang.Exception
Retrieves this Server entry from the persistent part in the federated database

del

public void del()
         throws DKException,
                java.lang.Exception
Removes this Server entry from the persistent federated database

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
List the entities associated with this server in the inventory table.
Returns:
a dkCollection of DKEntityInventoryDefFed objects

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException,
                                          java.lang.Exception
List the entities associated with this server in the inventory table.
Returns:
A String array of entity names.

listNativeEntityNames

public java.lang.String[] listNativeEntityNames(java.lang.String fedEntityName)
                                         throws DKException,
                                                java.lang.Exception
Gets a list of native entity names for the specified federate entity name
Parameters:
fedEntityName - a federate entity name
Returns:
an array of native entity names

getName

public java.lang.String getName()
Get the server name.
Specified by:
getName in interface dkServerDef
Following copied from interface: com.ibm.mm.sdk.common.dkServerDef
Returns:
name of this server

setName

public void setName(java.lang.String name)
Set the server name.
Specified by:
setName in interface dkServerDef
Following copied from interface: com.ibm.mm.sdk.common.dkServerDef
Parameters:
name - new name to be set to this server object

datastoreName

public java.lang.String datastoreName()
                               throws java.lang.Exception
Gets the name of this datastore object.
Returns:
datastore name

getNativeServerType

public java.lang.String getNativeServerType()
Get the server type. This is the Content Mangement Server type. same as getServerType().

setNativeServerType

public void setNativeServerType(java.lang.String name)
Set the server type. This is the Content Mangement Server type same as setServerType().

getNewServerName

public java.lang.String getNewServerName()
Get the new server name.

setNewServerName

public void setNewServerName(java.lang.String name)
Set the new server name.

getServerType

public java.lang.String getServerType()
Get the server type in String.

setServerType

public void setServerType(java.lang.String type)
Set the server type in String.

getRemoteHost

public java.lang.String getRemoteHost()
Get the remote host name.

setRemoteHost

public void setRemoteHost(java.lang.String name)
Set the remote host name.

getRemotePort

public int getRemotePort()
Get port number for remote host.

setRemotePort

public void setRemotePort(int port)
Set the port number for remote host

getJavaClass

public java.lang.String getJavaClass()
Get Java class name.

setJavaClass

public void setJavaClass(java.lang.String name)
Set Java class name.

getCppClass

public java.lang.String getCppClass()
Get C++ class name.

setCppClass

public void setCppClass(java.lang.String name)
Set C++ class name.

getAXClass

public java.lang.String getAXClass()
Get ActiveX class name.

setAXClass

public void setAXClass(java.lang.String name)
Set ActiveX class name.

getDescription

public java.lang.String getDescription()
Get the description for this server.

setDescription

public void setDescription(java.lang.String desc)
Set the description for this server.

getRefreshTime

public DKTimestamp getRefreshTime()
Get the DKTimestamp of the last time Federated Server Inventory program has collected information form this server.

setRefreshTime

public void setRefreshTime(DKTimestamp time)
Set the Timestamp to indicate the last time Federated Server Inventory program has collected information from this server.

getConnectString

public java.lang.String getConnectString()
Get the Initial Parameter String that contains information to connect to Content Management server.

setConnectString

public void setConnectString(java.lang.String connParam)
Set the Initial Parameter String that contains information to connect to Content Management server.

getInitializationString

public java.lang.String getInitializationString()
Get the Initial Parameter String that contains information to initialize Content Management server.

setInitializationString

public void setInitializationString(java.lang.String initParam)
Set the Initial Parameter String that contains information to initialize Content Management server.

listSearchServices

public dkCollection listSearchServices()
                                throws DKException,
                                       java.lang.Exception
Gets a list of associated Search Services
Returns:
a collection of search service objects.

setSearchService

public void setSearchService(java.lang.String name,
                             dkServerDef searchService)
                      throws DKException,
                             java.lang.Exception
Sets the Search Service for this server
Parameters:
name - search service name
searchService - search service object

EIP Java APIs

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