Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreAdminFed

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

public class DKDatastoreAdminFed
extends dkAbstractDatastoreAdmin
implements DKConstantFed, DKMessageIdFed

DKDatastoreAdminFed : This class provides administrative functions to manage the federated database.

See Also:
Serialized Form

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.DKConstant
    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
 DKACLMgmtFed aclManagement()
          Gets the reference to the access control list management object.
 void addServer(DKServerMapDefFed server)
          Add a server to the Federated database.Administrator only function.
 void addServerType(DKServerTypeDefFed type)
          Add a new server type to the database.
 dkAdminDomainsMgmt adminDomainsMgmt()
          Gets the reference to the admin domains management object.
 boolean[] areServicesAvailable(int[] service_id)
           
 void assocSearchServer(java.lang.String cmServer, java.lang.String searchServer)
          Associate a Text search server to the backend server.
 dkAuthorizationMgmt authorizationMgmt()
          Gets the reference to the access control list management object.
 dkDatastore datastore()
          Get the reference to the owner datastore object
 void disassocSearchServer(java.lang.String cmServer, java.lang.String searchServer)
          Disassociate a search server from the backend server, Administrator only function.
 DKFolderMgmtFed folderManagement()
          Gets the reference to the folder management object.
 DKServerMapDefFed getServer(java.lang.String name)
          Get the DKServerMapDefFed object defined in the Federated database.
 DKServerTypeDefFed getServerType(java.lang.String key)
          Get type object by its key ( the datasttype field )
 DKServerInventoryMgmtFed inventoryManagement()
          Gets the reference to the inventory management object.
 boolean isAdminUser(java.lang.String userId)
           
 boolean isServiceAvailable(int service_id)
          Checks to see if the service is available
 java.lang.String[] listAllAssocSearchServerNames()
          List all the associated search servers
 java.lang.String[] listAssocBackendServerNames(java.lang.String server)
          List the backend server associated with the specified search server
 dkCollection listAssocSearchServers(java.lang.String server)
          List the Text Search Servers associated with the specified backend server
 java.lang.String[] listServerNames()
          List the servers defined in the Federated database.
 java.lang.String[] listServerNames(java.lang.String type)
          List the servers defined in the Federated database based on server type.
 dkCollection listServers()
          List the servers defined in the Federated database.
 java.lang.String[] listServerTypeNames()
          List all the defined server types
 dkCollection listServerTypes()
          List the server types defined in the Federated database.
 DKErrorLogMgmtFed logManagement()
          Gets the reference to the log management object.
 DKMimetypeMgmtFed mimetypeManagement()
          Gets the reference to the mime type management object.
 void removeServer(java.lang.String server)
          Remove server from the Federated database.Administrator only function.
 void removeServerType(java.lang.String key)
          Remove a server type by its key ( the datasttype field ).Administrator only function.
 void setDefLanguage(java.lang.String lang)
          Set the default language to use.
 void setServiceAvailable(int service_id, boolean enabled)
          Sets whether the service is available
 void setServicesAvailable(int[] service_ids, boolean[] enabled)
          Sets whether the service is available
 void updateServer(DKServerMapDefFed server)
          Update an existing server.
 void updateServerType(DKServerTypeDefFed type)
          Update a server type based on its key.Administrator only function.
 dkUserManagement userManagement()
          Gets the reference to the user management object.
 dkWorkFlowMgmt workFlowManagement()
          Gets the reference to the workflow management object.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin
accessControl, clearCache, configurationManagement, getDatastore, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isAdminUser

public boolean isAdminUser(java.lang.String userId)
                    throws DKNotExistException,
                           DKException,
                           java.lang.Exception

isServiceAvailable

public boolean isServiceAvailable(int service_id)
Checks to see if the service is available
Parameters:
service_id -  
Returns:
true if available, false otherwise

areServicesAvailable

public boolean[] areServicesAvailable(int[] service_id)
                               throws DKException,
                                      java.lang.Exception

setServiceAvailable

public void setServiceAvailable(int service_id,
                                boolean enabled)
                         throws DKException,
                                java.lang.Exception
Sets whether the service is available
Parameters:
service_id -  
enabled - either true or false

setServicesAvailable

public void setServicesAvailable(int[] service_ids,
                                 boolean[] enabled)
                          throws DKException,
                                 java.lang.Exception
Sets whether the service is available
Parameters:
service_id[] - an array of service ids
enabled[] - an array of either true or false

datastore

public dkDatastore datastore()
Get the reference to the owner datastore object
Returns:
The dkDatastore object

userManagement

public dkUserManagement userManagement()
                                throws DKException,
                                       java.lang.Exception
Gets the reference to the user management object. The return object can be casted to DKUserMgmtFed object.
Overrides:
userManagement in class dkAbstractDatastoreAdmin
Returns:
the dkUserManagement object

folderManagement

public DKFolderMgmtFed folderManagement()
                                 throws DKException,
                                        java.lang.Exception
Gets the reference to the folder management object. The return object can be casted to DKFolderMgmtFed object.
Returns:
the DKFolderMgmtFed object

inventoryManagement

public DKServerInventoryMgmtFed inventoryManagement()
                                             throws DKException,
                                                    java.lang.Exception
Gets the reference to the inventory management object. This is for admin user only.
Returns:
the DKServerInventoryMgmtFed object

logManagement

public DKErrorLogMgmtFed logManagement()
                                throws DKException,
                                       java.lang.Exception
Gets the reference to the log management object. This is for admin user only.
Returns:
the DKErrorLogMgmtFed object

workFlowManagement

public dkWorkFlowMgmt workFlowManagement()
                                  throws DKException
Gets the reference to the workflow management object. This is for admin user only.
Overrides:
workFlowManagement in class dkAbstractDatastoreAdmin
Returns:
the DKWorkFlowMgmtFed object

adminDomainsMgmt

public dkAdminDomainsMgmt adminDomainsMgmt()
                                    throws DKException,
                                           java.lang.Exception
Gets the reference to the admin domains management object. This is for admin user only.
Overrides:
adminDomainsMgmt in class dkAbstractDatastoreAdmin
Returns:
the dkAdminDomainsMgmt object

mimetypeManagement

public DKMimetypeMgmtFed mimetypeManagement()
                                     throws DKException,
                                            java.lang.Exception
Gets the reference to the mime type management object. This is for admin user only.
Returns:
the DKWorkFlowMgmtFed object

aclManagement

public DKACLMgmtFed aclManagement()
                           throws DKException
Gets the reference to the access control list management object.
Returns:
the DKACLMgmtFed object

authorizationMgmt

public dkAuthorizationMgmt authorizationMgmt()
                                      throws DKException
Gets the reference to the access control list management object.
Overrides:
authorizationMgmt in class dkAbstractDatastoreAdmin
Returns:
the DKACLMgmtFed object

setDefLanguage

public void setDefLanguage(java.lang.String lang)
Set the default language to use.

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.

listServerNames

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

addServer

public void addServer(DKServerMapDefFed server)
               throws DKException,
                      java.lang.Exception
Add a server to the Federated database.Administrator only function.

getServer

public DKServerMapDefFed getServer(java.lang.String name)
                            throws DKException,
                                   java.lang.Exception
Get the DKServerMapDefFed object defined in the Federated database.
Parameters:
serverName - the string containing the server name

updateServer

public void updateServer(DKServerMapDefFed server)
                  throws DKException,
                         java.lang.Exception
Update an existing server. Administrator only function.

removeServer

public void removeServer(java.lang.String server)
                  throws DKException,
                         java.lang.Exception
Remove server from the Federated database.Administrator only function.

listAssocSearchServers

public dkCollection listAssocSearchServers(java.lang.String server)
                                    throws DKException,
                                           java.lang.Exception
List the Text Search Servers associated with the specified backend server
Parameters:
server - the backend server name
Returns:
a dkCollection of DKServerMapDefFed objects

listAssocBackendServerNames

public java.lang.String[] listAssocBackendServerNames(java.lang.String server)
                                               throws DKException,
                                                      java.lang.Exception
List the backend server associated with the specified search server
Parameters:
server - the serarch server server name
Returns:
A String array of server names.

listAllAssocSearchServerNames

public java.lang.String[] listAllAssocSearchServerNames()
                                                 throws DKException,
                                                        java.lang.Exception
List all the associated search servers
Returns:
A String array of server names.

assocSearchServer

public void assocSearchServer(java.lang.String cmServer,
                              java.lang.String searchServer)
                       throws DKException,
                              java.lang.Exception
Associate a Text search server to the backend server. Administrator only function.
Parameters:
cmnServer - the backend server name
searchServer - The Search Server

disassocSearchServer

public void disassocSearchServer(java.lang.String cmServer,
                                 java.lang.String searchServer)
                          throws DKException,
                                 java.lang.Exception
Disassociate a search server from the backend server, Administrator only function.
Parameters:
cmnServer - the backend server name
searchServer - The Search Server

listServerTypeNames

public java.lang.String[] listServerTypeNames()
                                       throws DKException,
                                              java.lang.Exception
List all the defined server types
Returns:
A String array of server types.

listServerTypes

public dkCollection listServerTypes()
                             throws DKException,
                                    java.lang.Exception
List the server types defined in the Federated database.
Returns:
a dkCollection of DKServerTypeDefFed objects

getServerType

public DKServerTypeDefFed getServerType(java.lang.String key)
                                 throws DKException,
                                        java.lang.Exception
Get type object by its key ( the datasttype field )
Parameters:
key - Key that represents this server type
Returns:
a DKServerTypeDefFed object

addServerType

public void addServerType(DKServerTypeDefFed type)
                   throws DKException,
                          java.lang.Exception
Add a new server type to the database. Administrator only function.
Parameters:
type - a DKServerTypeDefFed object

removeServerType

public void removeServerType(java.lang.String key)
                      throws DKException,
                             java.lang.Exception
Remove a server type by its key ( the datasttype field ).Administrator only function.

updateServerType

public void updateServerType(DKServerTypeDefFed type)
                      throws DKException,
                             java.lang.Exception
Update a server type based on its key.Administrator only function. The key can't be changed.

EIP Java APIs

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