WebSphere:*,type=ConfigService
MinimalAccessCheck:
MBean ConfigService
Config Service component provides service of configuration related tasks on top of config repository service.
Operation Summary | |
void | discard( reload the session, discard all the changes in the session made after last save call. |
void | save( save the changes made in the session to config repository. |
java.lang.String[] | getUnsavedChanges( get all the documents that changed in the session after last save call. |
java.util.Map | getConflictDocuments( get all the documents that have conflict changes with updates introduced by other session. |
java.lang.String[] | getSupportedConfigObjectTypes() returns the list of supported Config object types. |
javax.management.AttributeList | getRelationshipsMetaInfo( get the detailed information about the relationships. |
javax.management.AttributeList | getAttributesMetaInfo( get the detailed information about the attributes of specified config data type. |
javax.management.ObjectName | createConfigData( create a Config object or config Data. |
javax.management.ObjectName | createConfigDataByTemplate( create a Config object or config Data based on default template. |
void | setAttributes( Modify the configuration of a config data. |
void | resetAttributes( reset the attribute list for the config data. |
void | unsetAttributes( remove the specified attributes from the attribute list of the config data. |
void | addElement( add an element into the list type attribute of a config data. |
void | removeElement( remove an element from list type attribute of a config data. |
java.lang.Object | getAttribute( Get the attribute of the config data. |
javax.management.AttributeList | getAttributes( Get the attribute values of the config data. |
void | deleteConfigData( Delete the specified config data and its children. |
javax.management.ObjectName[] | getRelationship( get the named relationship value of the specified config object. |
javax.management.AttributeList | getRelationships( get the named relationship values of specified config object. |
javax.management.ObjectName[] | queryConfigObjects( The query method for specific type of config objects. |
javax.management.ObjectName[] | queryConfigObjectsAtCurrentScope( The query method for specific type of config objects at the scope specified. |
javax.management.ObjectName[] | queryTemplates( The query method for specific type of templates. |
javax.management.ObjectName[] | resolve( resolve the config object from its containment path. |
javax.management.ObjectName[] | resolve( resolve the config object from its containment path. |
void | setProperties( set properties that associates with the session. |
com.ibm.websphere.management.configservice.ValidationResult | validate( validate the configuration. |
Operation Detail |
public void discard(com.ibm.websphere.management.Session session
)
session
-
The session id.
public void save(com.ibm.websphere.management.Session session,
boolean overwriteOnConflict
)
session
-
The session id.overwriteOnConflict
-
If user wants to overwrite the conflict document or roll back all the changes made after last save.
public java.lang.String[] getUnsavedChanges(com.ibm.websphere.management.Session session
)
session
-
the seesion id.
public java.util.Map getConflictDocuments(com.ibm.websphere.management.Session session
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.
public java.lang.String[] getSupportedConfigObjectTypes()
public javax.management.AttributeList getRelationshipsMetaInfo(java.lang.String configObjectType
)
configObjectType
-
config ojbect type. It must be one of the types returned from <code>getSupportedConfigObjectTypes</code>.
public javax.management.AttributeList getAttributesMetaInfo(java.lang.String configDataType
)
configDataType
-
config data type.
public javax.management.ObjectName createConfigData(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String attributeName,
java.lang.String type,
javax.management.AttributeList attrList
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.attributeName
-
the name of the relationship between the parent and child if create config object, it must be an attribute name if create config data.type
-
the type of newly created config data. The type may be the type of the attribute specified in the attribute meta info, but it could also be one of the subtypes listed in the attribute ATTRIBUTE_METAINFO_SUBTYPES in the meta info of the attribute.attrList
-
the attribute List of newly created config object.
public javax.management.ObjectName createConfigDataByTemplate(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String attributeName,
javax.management.AttributeList attrList,
javax.management.ObjectName template
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.attributeName
-
the name of the relationship between the parent and child if create config object, it must be an attribute name if create config data.attrList
-
the attribute List of newly created config object.template
-
the template to be used during creation. Use system default template if null is supplied. The template may be one of the template returned from queryTemplates call, but it may be a config object or data in the repository.
public void setAttributes(com.ibm.websphere.management.Session session,
javax.management.ObjectName configData,
javax.management.AttributeList attrList
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.configData
-
the ObjectName of the config data.attrList
-
the attribute list that contains the list of attributes to be modified.
public void resetAttributes(com.ibm.websphere.management.Session session,
javax.management.ObjectName configData,
javax.management.AttributeList attrList
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.configData
-
the ObjectName of the config data.attrList
-
the attribute list that contains the list of attributes to be modified.
public void unsetAttributes(com.ibm.websphere.management.Session session,
javax.management.ObjectName configData,
java.lang.String[] attributes
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.configData
-
the ObjectName of the config data.attributes
-
a list of attributes to be unset.
public void addElement(com.ibm.websphere.management.Session session,
javax.management.ObjectName configData,
java.lang.String attribute,
java.lang.Object element,
int position
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.configData
-
the ObjectName of the config data.attribute
-
the name of the attribute.element
-
the value of the element. It might be a primary data type, an attribute list or a object reference.position
-
the position added in the list. append at the end if -1.
public void removeElement(com.ibm.websphere.management.Session session,
javax.management.ObjectName configData,
java.lang.String attribute,
java.lang.Object element
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.configData
-
the ObjectName of the config data.attribute
-
the name of the attribute.element
-
the value of the element. It might be a primary data type, an attribute list or a object reference.
public java.lang.Object getAttribute(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String attributeName
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.attributeName
-
the attribute name.
public javax.management.AttributeList getAttributes(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String[] attributes,
boolean recursive
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.attributes
-
the list of attribute names whose value should be returned. null means all the attributes.recursive
-
return the nested attribute list as the value of complex attribute type if recursive is set to be true, return the object name for the value of complex attribute type if recursive is false.
public void deleteConfigData(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
object name of the config data.
public javax.management.ObjectName[] getRelationship(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String relationshipNames
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.relationshipNames
-
list of the relationship names.
public javax.management.AttributeList getRelationships(com.ibm.websphere.management.Session session,
javax.management.ObjectName parent,
java.lang.String[] relationshipNames
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.parent
-
the id of the parent config data/object.relationshipNames
-
list of the relationship names.
public javax.management.ObjectName[] queryConfigObjects(com.ibm.websphere.management.Session session,
javax.management.ObjectName scope,
javax.management.ObjectName name,
javax.management.QueryExp query
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.scope
-
the scope of search. scope may be a cell, node or server. we do cell wide search if scope is null.name
-
The object name pattern identifying the MBeans to be retrieved.query
-
The query expression to be applied for selecting config ojbects. If null no query expression will be applied for selecting config objects.
public javax.management.ObjectName[] queryConfigObjectsAtCurrentScope(com.ibm.websphere.management.Session session,
javax.management.ObjectName scope,
java.lang.String type
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.scope
-
the scope of search. scope may be a cell, node or server. type
-
the config data type
public javax.management.ObjectName[] queryTemplates(com.ibm.websphere.management.Session session,
java.lang.String type
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.type
-
the type of newly created config data. The type may be the type of the attribute specified in the attribute meta info, but it could also be one of the subtypes listed in the attribute ATTRIBUTE_METAINFO_SUBTYPES in the meta info of the attribute.
public javax.management.ObjectName[] resolve(com.ibm.websphere.management.Session session,
java.lang.String containmentPath
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.containmentPath
-
the containment path of config object.
public javax.management.ObjectName[] resolve(com.ibm.websphere.management.Session session,
javax.management.ObjectName scope,
java.lang.String containmentPath
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.scope
-
the scope of search. scope may be a cell, node or server. we do cell wide search if scope is null.containmentPath
-
the containment path of config object.
public void setProperties(com.ibm.websphere.management.Session session,
java.util.HashMap props
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.props
-
tthe session property.
public com.ibm.websphere.management.configservice.ValidationResult validate(com.ibm.websphere.management.Session session,
javax.management.ObjectName scope
)
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.scope
-
the scope of validation. Scope may be cell, node or server. Null means all. If scope is any other type object, trace back and use its nearest ancestor which is valid scope.