|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractDatastoreAdmin | +--com.ibm.mm.sdk.common.DKDatastoreAdminFed
DKDatastoreAdminFed : This class provides administrative functions to manage the federated database.
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 |
public boolean isAdminUser(java.lang.String userId) throws DKNotExistException, DKException, java.lang.Exception
public boolean isServiceAvailable(int service_id)
service_id
- public boolean[] areServicesAvailable(int[] service_id) throws DKException, java.lang.Exception
public void setServiceAvailable(int service_id, boolean enabled) throws DKException, java.lang.Exception
service_id
- enabled
- either true or falsepublic void setServicesAvailable(int[] service_ids, boolean[] enabled) throws DKException, java.lang.Exception
service_id[]
- an array of service idsenabled[]
- an array of either true or falsepublic dkDatastore datastore()
public dkUserManagement userManagement() throws DKException, java.lang.Exception
userManagement
in class dkAbstractDatastoreAdmin
public DKFolderMgmtFed folderManagement() throws DKException, java.lang.Exception
public DKServerInventoryMgmtFed inventoryManagement() throws DKException, java.lang.Exception
public DKErrorLogMgmtFed logManagement() throws DKException, java.lang.Exception
public dkWorkFlowMgmt workFlowManagement() throws DKException
workFlowManagement
in class dkAbstractDatastoreAdmin
public dkAdminDomainsMgmt adminDomainsMgmt() throws DKException, java.lang.Exception
adminDomainsMgmt
in class dkAbstractDatastoreAdmin
public DKMimetypeMgmtFed mimetypeManagement() throws DKException, java.lang.Exception
public DKACLMgmtFed aclManagement() throws DKException
public dkAuthorizationMgmt authorizationMgmt() throws DKException
authorizationMgmt
in class dkAbstractDatastoreAdmin
public void setDefLanguage(java.lang.String lang)
public dkCollection listServers() throws DKException, java.lang.Exception
public java.lang.String[] listServerNames() throws DKException, java.lang.Exception
public java.lang.String[] listServerNames(java.lang.String type) throws DKException, java.lang.Exception
public void addServer(DKServerMapDefFed server) throws DKException, java.lang.Exception
public DKServerMapDefFed getServer(java.lang.String name) throws DKException, java.lang.Exception
serverName
- the string containing the server namepublic void updateServer(DKServerMapDefFed server) throws DKException, java.lang.Exception
public void removeServer(java.lang.String server) throws DKException, java.lang.Exception
public dkCollection listAssocSearchServers(java.lang.String server) throws DKException, java.lang.Exception
server
- the backend server namepublic java.lang.String[] listAssocBackendServerNames(java.lang.String server) throws DKException, java.lang.Exception
server
- the serarch server server namepublic java.lang.String[] listAllAssocSearchServerNames() throws DKException, java.lang.Exception
public void assocSearchServer(java.lang.String cmServer, java.lang.String searchServer) throws DKException, java.lang.Exception
cmnServer
- the backend server namesearchServer
- The Search Serverpublic void disassocSearchServer(java.lang.String cmServer, java.lang.String searchServer) throws DKException, java.lang.Exception
cmnServer
- the backend server namesearchServer
- The Search Serverpublic java.lang.String[] listServerTypeNames() throws DKException, java.lang.Exception
public dkCollection listServerTypes() throws DKException, java.lang.Exception
public DKServerTypeDefFed getServerType(java.lang.String key) throws DKException, java.lang.Exception
key
- Key that represents this server typepublic void addServerType(DKServerTypeDefFed type) throws DKException, java.lang.Exception
type
- a DKServerTypeDefFed objectpublic void removeServerType(java.lang.String key) throws DKException, java.lang.Exception
public void updateServerType(DKServerTypeDefFed type) throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |