Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkFederation

All Known Implementing Classes:
DKDatastoreFed

public interface dkFederation

The base interface for a federated datastore. Provides general methods for the datastore.


Method Summary
 void changePassword(java.lang.String serverName, java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd)
          Changes the password of a given user Id for a specifed server (Administrator only function)
 void clearExcludedServers(java.lang.String templateName)
          Clears all the excluded servers for the named search template
 void connectToService(dkService service)
          Connects to a service
 void connectToService(java.lang.String serviceId)
          Connects to a service
 dkDatastore datastoreByServerName(java.lang.String dsType, java.lang.String dsName)
          Gets a reference to the specified datastore
The datastore must be connected, otherwise it returns a null even if one is found.
 dkDatastore datastoreByServerName(java.lang.String dsType, java.lang.String dsName, boolean connect)
          Gets a reference to the specified datastore When looking for the datastore, it first looks in the free connection pool.
 void excludeServer(java.lang.String serverName, java.lang.String templateName)
          Requests to skip the named server for the named search template
 dkSearchTemplate getSearchTemplate(java.lang.String templateName)
          Gets the search template information for a given template name
 java.lang.String[] listExcludedServers(java.lang.String templateName)
          Lists all the excluded servers for the named search template
 java.lang.String[] listSearchTemplateNames()
          Gets a listof the search template names from an federated datastore
 dkCollection listSearchTemplates()
          Gets a list of the search templates from an federated datastore
 void requestConnection(java.lang.String serverName, java.lang.String userId, java.lang.String passwd, java.lang.String connectString)
          Requests a connection to a particular server with the given user ID, password, and connect string
 dkServiceMgr serviceMgr()
          Gets a service manager
 

Method Detail

listSearchTemplates

public dkCollection listSearchTemplates()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of the search templates from an federated datastore
Returns:
a DKSequentialCollection of search templates
Throws:
DKException - if internal datastore error occurs

listSearchTemplateNames

public java.lang.String[] listSearchTemplateNames()
                                           throws DKException,
                                                  java.lang.Exception
Gets a listof the search template names from an federated datastore
Returns:
an array of search template names
Throws:
DKException - if internal datastore error occurs

getSearchTemplate

public dkSearchTemplate getSearchTemplate(java.lang.String templateName)
                                   throws DKException,
                                          java.lang.Exception
Gets the search template information for a given template name
Parameters:
templateName - the name of the search template
Returns:
dkSearchTemplate object.
Throws:
DKException - if internal datastore error occurs

datastoreByServerName

public dkDatastore datastoreByServerName(java.lang.String dsType,
                                         java.lang.String dsName)
                                  throws DKException,
                                         java.lang.Exception
Gets a reference to the specified datastore
The datastore must be connected, otherwise it returns a null even if one is found.

When looking for the datastore, it first looks in the free connection pool. If none is found, it looks under the connection pool held by active cursors. You should consider the case when transaction is active

Throws:
DKException - if internal datastore error occurs

datastoreByServerName

public dkDatastore datastoreByServerName(java.lang.String dsType,
                                         java.lang.String dsName,
                                         boolean connect)
                                  throws DKException,
                                         java.lang.Exception
Gets a reference to the specified datastore When looking for the datastore, it first looks in the free connection pool. If none is found, it looks under the connection pool held by active cursors. You should consider the case when transaction is active
Throws:
DKException - if internal datastore error occurs

changePassword

public void changePassword(java.lang.String serverName,
                           java.lang.String userId,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Changes the password of a given user Id for a specifed server (Administrator only function)
Parameters:
userId - the user ID
oldPwd - the old password
newPwd - the new password
Throws:
DKException - if internal datastore error occurs

requestConnection

public void requestConnection(java.lang.String serverName,
                              java.lang.String userId,
                              java.lang.String passwd,
                              java.lang.String connectString)
                       throws DKException,
                              java.lang.Exception
Requests a connection to a particular server with the given user ID, password, and connect string
Parameters:
userId - the user ID
passwd - the password
connectString - the connect string to logon
Throws:
DKException - if internal datastore error occurs

excludeServer

public void excludeServer(java.lang.String serverName,
                          java.lang.String templateName)
                   throws DKException,
                          java.lang.Exception
Requests to skip the named server for the named search template
Parameters:
serverName - a back end server name
templateName - a search template name
Throws:
DKException - if internal datastore error occurs

listExcludedServers

public java.lang.String[] listExcludedServers(java.lang.String templateName)
                                       throws DKException,
                                              java.lang.Exception
Lists all the excluded servers for the named search template
Parameters:
templateName - a search template name
Returns:
an array of server names that were excluded during search
Throws:
DKException - if internal datastore error occurs

clearExcludedServers

public void clearExcludedServers(java.lang.String templateName)
                          throws DKException,
                                 java.lang.Exception
Clears all the excluded servers for the named search template
Parameters:
templateName - a search template name
Throws:
DKException - if internal datastore error occurs

serviceMgr

public dkServiceMgr serviceMgr()
                        throws DKException,
                               java.lang.Exception
Gets a service manager
Returns:
the service manager
Throws:
DKException - if internal datastore error occurs

connectToService

public void connectToService(dkService service)
                      throws DKException,
                             java.lang.Exception
Connects to a service
Parameters:
service - a service object
Throws:
DKException - if internal datastore error occurs

connectToService

public void connectToService(java.lang.String serviceId)
                      throws DKException,
                             java.lang.Exception
Connects to a service
Parameters:
service - a service ID
Throws:
DKException - if internal datastore error occurs

EIP Java APIs

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