|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public dkCollection listSearchTemplates() throws DKException, java.lang.Exception
DKException
- if internal datastore error occurspublic java.lang.String[] listSearchTemplateNames() throws DKException, java.lang.Exception
DKException
- if internal datastore error occurspublic dkSearchTemplate getSearchTemplate(java.lang.String templateName) throws DKException, java.lang.Exception
templateName
- the name of the search templateDKException
- if internal datastore error occurspublic dkDatastore datastoreByServerName(java.lang.String dsType, java.lang.String dsName) throws DKException, java.lang.Exception
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
DKException
- if internal datastore error occurspublic dkDatastore datastoreByServerName(java.lang.String dsType, java.lang.String dsName, boolean connect) throws DKException, java.lang.Exception
DKException
- if internal datastore error occurspublic void changePassword(java.lang.String serverName, java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
userId
- the user IDoldPwd
- the old passwordnewPwd
- the new passwordDKException
- if internal datastore error occurspublic void requestConnection(java.lang.String serverName, java.lang.String userId, java.lang.String passwd, java.lang.String connectString) throws DKException, java.lang.Exception
userId
- the user IDpasswd
- the passwordconnectString
- the connect string to logonDKException
- if internal datastore error occurspublic void excludeServer(java.lang.String serverName, java.lang.String templateName) throws DKException, java.lang.Exception
serverName
- a back end server nametemplateName
- a search template nameDKException
- if internal datastore error occurspublic java.lang.String[] listExcludedServers(java.lang.String templateName) throws DKException, java.lang.Exception
templateName
- a search template nameDKException
- if internal datastore error occurspublic void clearExcludedServers(java.lang.String templateName) throws DKException, java.lang.Exception
templateName
- a search template nameDKException
- if internal datastore error occurspublic dkServiceMgr serviceMgr() throws DKException, java.lang.Exception
DKException
- if internal datastore error occurspublic void connectToService(dkService service) throws DKException, java.lang.Exception
service
- a service objectDKException
- if internal datastore error occurspublic void connectToService(java.lang.String serviceId) throws DKException, java.lang.Exception
service
- a service IDDKException
- if internal datastore error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |