|
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.beans.CMBSchemaManagement
The CMBSchemaManagement bean provides EIP federated schema management and specific content server schema management functions. These functions include obtaining the defined search templates, entities, and attributes.
Summary of properties and events:
imported properties traceEnabled, defaulting on, will not veto exported properties none standalone properties cacheEnabled, defaulting on, caching the retrieved schema information interested in events CMBConnectionReplyEvent - to get connection handle CMBSchemaRequestEvent - to perform functions PropertyChangeEvent - to import traceEnabled source of events CMBSchemaReplyEvent - to reply the request CMBExceptionEvent - to post exception CMBTraceEvent - to let logger trace
CMBConnection
, Serialized FormConstructor Summary | |
CMBSchemaManagement()
Default constructor. |
Method Summary | |
void |
addCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent registration method. |
void |
addCMBSchemaReplyListener(CMBSchemaReplyListener listener)
CMBSchemaReplyEvent registration method. |
void |
addCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent registration method. |
void |
clearSchemaCache()
Clear out all current values in memory. |
CMBConnection |
getConnection()
Gets the connection bean reference. |
java.lang.String |
getCurrentServerName()
Gets the current server name. |
java.lang.String |
getCurrentServerType()
Gets the current server type |
java.util.Properties |
getDefaultMime2App()
Gets the definitions of applications to be launched for certain mime types as defined in System Administration. |
CMBEntity[] |
getEntities()
Return all top-level entity objects |
CMBEntity |
getEntity(java.lang.String entityName)
Return the entity object for the given name mapped entity names are supported in form: FedEntityName;nativeServername;NativeEntityName |
CMBAttribute |
getEntityAttr(java.lang.String entityName,
java.lang.String attrName)
Deprecated. Use getEntityAttrs instead |
java.lang.String[] |
getEntityAttrName(java.lang.String entityName)
Deprecated. Use getEntityAttrNames instead |
java.lang.String |
getEntityAttrName(java.lang.String entityName,
int index)
Deprecated. Use getEntityAttrNames instead |
java.lang.String[] |
getEntityAttrNames(java.lang.String entityName)
Get attribute names for the specified entity. |
java.lang.String |
getEntityAttrNames(java.lang.String entityName,
int index)
Indexed getter for attribute name of the specified entity. |
CMBAttribute |
getEntityAttrs(java.lang.String entityName,
java.lang.String attrName)
Gets entity attribute's data. |
short |
getEntityAttrType(java.lang.String entityName,
java.lang.String attrName)
Gets entity attribute's data type. |
java.lang.String[] |
getEntityName()
Deprecated. Use getEntityNames instead |
java.lang.String |
getEntityName(int index)
Indexed getter for entity name. |
java.lang.String[] |
getEntityNames()
Get all entity names. |
short |
getEntityType(java.lang.String entityName)
Returns the entity type |
CMBExceptionEvent |
getExceptionEvent()
To support VisualCafe 3.0 "Add Interaction..." |
java.lang.String[] |
getNativeServerNames()
Gets the names of all servers that are mapped to by this Federated server. |
java.lang.String[] |
getNativeServerNames(java.lang.String serverType)
Gets the names of all servers of the given type that are mapped to by this Federated server. |
java.lang.String[] |
getNativeServerTypes()
Gets the types of all servers that are mapped to by this Federated server. |
java.lang.String |
getParentEntityName(java.lang.String entityName)
Returns the name of the parent entity. |
CMBSchemaReplyEvent |
getSchemaReplyEvent()
To support VisualCafe 3.0 "Add Interaction..." |
CMBSearchTemplate[] |
getSearchTemplate()
Deprecated. Use getSearchTemplates instead |
CMBSearchTemplate |
getSearchTemplate(int index)
Indexed getter for search template object. |
CMBSearchTemplate |
getSearchTemplate(java.lang.String name)
Get a specified search template object. |
java.lang.String[] |
getSearchTemplateName()
Deprecated. Use getSearchTemplateNames instead |
java.lang.String |
getSearchTemplateName(int index)
Indexed getter for search template name. |
java.lang.String[] |
getSearchTemplateNames()
Get all search template names. |
CMBSearchTemplate[] |
getSearchTemplates()
Get all search template objects. |
java.lang.String[] |
getServerName()
Deprecated. Use getServerNames instead |
java.lang.String |
getServerName(int index)
Indexed getter for server name. |
java.lang.String[] |
getServerNames()
Get all server names. |
CMBEntity[] |
getSubEntities(java.lang.String entityName)
Return all sub entities of the given entity |
CMBTraceEvent |
getTraceEvent()
To support VisualCafe 3.0 "Add Interaction..." |
boolean |
hasSubEntities(java.lang.String entityName)
Determines whether the entity has sub entities |
boolean |
isCacheEnabled()
Property getter. |
boolean |
isEntityTextSearchable(java.lang.String entityName)
Determines whether the entity is text searchable. |
boolean |
isTraceEnabled()
Property getter. |
void |
onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of connection reply service method= update the connection handle accordingly. |
void |
onCMBSchemaRequest(CMBSchemaRequestEvent evt)
Implementation of schema request service method: perform the requested function. |
void |
propertyChange(java.beans.PropertyChangeEvent evt)
On property change, import the traceEnabled property value. |
void |
removeCMBExceptionListener(CMBExceptionListener listener)
CMBExceptionEvent unregistration method. |
void |
removeCMBSchemaReplyListener(CMBSchemaReplyListener listener)
CMBSchemaReplyEvent unregistration method. |
void |
removeCMBTraceListener(CMBTraceListener listener)
CMBTraceEvent unregistration method. |
void |
setCacheEnabled(boolean newValue)
Property setter. |
void |
setConnection(CMBConnection conn)
Set the connection handle from the CMBConnection bean. |
void |
setCurrentServer(java.lang.String serverName,
java.lang.String serverType)
Sets the current server. |
void |
setTraceEnabled(boolean newValue)
Property setter. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBSchemaManagement()
Method Detail |
public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
onCMBConnectionReply
in interface CMBConnectionReplyListener
evt
- a CMBConnectionReplyEventpublic void onCMBSchemaRequest(CMBSchemaRequestEvent evt)
onCMBSchemaRequest
in interface CMBSchemaRequestListener
evt
- a CMBSchemaRequestEventpublic void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange
in interface java.beans.PropertyChangeListener
evt
- a property changed eventpublic void addCMBExceptionListener(CMBExceptionListener listener)
listener
- listener to be registeredpublic void removeCMBExceptionListener(CMBExceptionListener listener)
listener
- listener to be unregisteredpublic void addCMBTraceListener(CMBTraceListener listener)
listener
- listener to be registeredpublic void removeCMBTraceListener(CMBTraceListener listener)
listener
- listener to be unregisteredpublic void addCMBSchemaReplyListener(CMBSchemaReplyListener listener)
listener
- listener to be registeredpublic void removeCMBSchemaReplyListener(CMBSchemaReplyListener listener)
listener
- listener to be unregisteredpublic boolean isTraceEnabled()
public void setTraceEnabled(boolean newValue)
newValue
- new trace option valuepublic boolean isCacheEnabled()
public void setCacheEnabled(boolean newValue)
newValue
- new cache option valuepublic void setConnection(CMBConnection conn)
conn
- reference of connection beanpublic CMBConnection getConnection()
public void clearSchemaCache()
public java.lang.String[] getServerName() throws CMBException
CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getServerNames() throws CMBException
CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getServerName(int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBException
index
- indexCMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
java.lang.ArrayIndexOutOfBoundsException
- index is out of boundspublic java.lang.String[] getNativeServerNames(java.lang.String serverType) throws CMBException, java.lang.Exception
serverType
- String which specifies the type of native servers to return.CMBException
- public java.lang.String[] getNativeServerNames() throws CMBException, java.lang.Exception
CMBException
- public java.lang.String[] getNativeServerTypes() throws CMBException, java.lang.Exception
CMBException
- public java.lang.String[] getSearchTemplateName() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getSearchTemplateNames() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getSearchTemplateName(int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- indexjava.lang.ArrayIndexOutOfBoundsException
- index is out of boundsCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getEntityName() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getEntityNames() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getEntityName(int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- indexjava.lang.ArrayIndexOutOfBoundsException
- index is out of boundsCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getEntityAttrName(java.lang.String entityName) throws CMBNoConnectionException, CMBException
entityName
- the entity name to get its attributesCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String[] getEntityAttrNames(java.lang.String entityName) throws CMBNoConnectionException, CMBException
entityName
- the entity name to get its attributesCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getEntityAttrName(java.lang.String entityName, int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
entityName
- the entity name to get its attributesindex
- indexjava.lang.ArrayIndexOutOfBoundsException
- index is out of boundsCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getEntityAttrNames(java.lang.String entityName, int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
entityName
- the entity name to get its attributesindex
- indexjava.lang.ArrayIndexOutOfBoundsException
- index is out of boundsCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public short getEntityAttrType(java.lang.String entityName, java.lang.String attrName) throws CMBNoConnectionException, CMBException
entityName
- name of entityattrName
- name of attributeCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBAttribute getEntityAttr(java.lang.String entityName, java.lang.String attrName) throws CMBNoConnectionException, CMBException
entityName
- name of entityattrName
- name of attributeCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBAttribute getEntityAttrs(java.lang.String entityName, java.lang.String attrName) throws CMBNoConnectionException, CMBException
entityName
- name of entityattrName
- name of attributeCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBEntity[] getEntities() throws CMBException, CMBNoConnectionException
CMBException
- will be thrown for the following errorCode from CMBException.getErrorCode():
public CMBEntity getEntity(java.lang.String entityName) throws CMBException, CMBNoConnectionException
entityName
- name of the desired entityCMBException
- will be thrown for the following errorCode from CMBException.getErrorCode():
public boolean hasSubEntities(java.lang.String entityName) throws CMBException
entityName
- name of entityCMBException
- will be thrown for the following errorCode from CMBException.getErrorCode():
public CMBEntity[] getSubEntities(java.lang.String entityName) throws CMBException
entityName
- name of the parent entityCMBException
- will be thrown for the following errorCode from CMBException.getErrorCode():
public CMBSearchTemplate[] getSearchTemplate() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBSearchTemplate[] getSearchTemplates() throws CMBNoConnectionException, CMBException
CMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBSearchTemplate getSearchTemplate(int index) throws java.lang.ArrayIndexOutOfBoundsException, CMBNoConnectionException, CMBException
index
- indexjava.lang.ArrayIndexOutOfBoundsException
- index is out of boundsCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public CMBSearchTemplate getSearchTemplate(java.lang.String name) throws CMBNoConnectionException, CMBException
name
- search template nameCMBNoConnectionException
- if there is no connection to the server.CMBException
- will be thrown for the following errorCode form CMBException.getErrorCode():
public java.lang.String getCurrentServerName()
public java.lang.String getCurrentServerType()
public void setCurrentServer(java.lang.String serverName, java.lang.String serverType)
serverName
- the server nameserverType
- the server typepublic java.util.Properties getDefaultMime2App() throws CMBException
public java.lang.String getParentEntityName(java.lang.String entityName)
entityName
- name of entitypublic boolean isEntityTextSearchable(java.lang.String entityName)
entityName
- name of entitypublic short getEntityType(java.lang.String entityName)
entityName
- name of entitypublic CMBSchemaReplyEvent getSchemaReplyEvent()
public CMBTraceEvent getTraceEvent()
public CMBExceptionEvent getExceptionEvent()
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |