WebSphere:*,type=ConfigService
true
MBean ConfigService
Config Service component provides service of configuration related tasks along with 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. |
ValidationResult | validate( validate the configuration. |
Operation Detail |
---|
public void discard(
Session session
)
reload the session, discard all the changes in the session made after last save call.
session
-
The session id.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void save(
Session session,
boolean overwriteOnConflict
)
save the changes made in the session to config repository.
session
-
The session id. overwriteOnConflict
-
If user wants to overwrite the conflict document or roll back all the changes made after last save.
administrator
configurator
public java.lang.String[] getUnsavedChanges(
Session session
)
get all the documents that changed in the session after last save call.
session
-
the seesion id.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.util.Map getConflictDocuments(
Session session
)
get all the documents that have conflict changes with updates introduced by other session.
session
-
the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String[] getSupportedConfigObjectTypes()
returns the list of supported Config object types.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.AttributeList getRelationshipsMetaInfo(
java.lang.String configObjectType
)
get the detailed information about the relationships.
configObjectType
-
config ojbect type. It must be one of the types returned from <code>getSupportedConfigObjectTypes</code>.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.AttributeList getAttributesMetaInfo(
java.lang.String configDataType
)
get the detailed information about the attributes of specified config data type.
configDataType
-
config data type.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName createConfigData(
Session session,
javax.management.ObjectName parent,
java.lang.String attributeName,
java.lang.String type,
javax.management.AttributeList attrList
)
create a Config object or config Data.
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.
administrator
configurator
public javax.management.ObjectName createConfigDataByTemplate(
Session session,
javax.management.ObjectName parent,
java.lang.String attributeName,
javax.management.AttributeList attrList,
javax.management.ObjectName template
)
create a Config object or config Data based on default 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.
administrator
configurator
public void setAttributes(
Session session,
javax.management.ObjectName configData,
javax.management.AttributeList attrList
)
Modify the configuration of a config data. Note this method does not change the attributes that are not specified in the attribute list.
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.
administrator
configurator
public void resetAttributes(
Session session,
javax.management.ObjectName configData,
javax.management.AttributeList attrList
)
reset the attribute list for the config data. This method is basically do the same thing as the setAttributes call except that this method replace the old attribute list with the supplied attribute list.
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.
administrator
configurator
public void unsetAttributes(
Session session,
javax.management.ObjectName configData,
java.lang.String[] attributes
)
remove the specified attributes from the attribute list of the config data.
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.
administrator
configurator
public void addElement(
Session session,
javax.management.ObjectName configData,
java.lang.String attribute,
java.lang.Object element,
int position
)
add an element into the list type attribute of a config data.
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.
administrator
configurator
public void removeElement(
Session session,
javax.management.ObjectName configData,
java.lang.String attribute,
java.lang.Object element
)
remove an element from list type attribute of a config data.
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.
administrator
configurator
public java.lang.Object getAttribute(
Session session,
javax.management.ObjectName parent,
java.lang.String attributeName
)
Get the attribute of the config data.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.AttributeList getAttributes(
Session session,
javax.management.ObjectName parent,
java.lang.String[] attributes,
boolean recursive
)
Get the attribute values of the config data.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void deleteConfigData(
Session session,
javax.management.ObjectName parent
)
Delete the specified config data and its children.
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.
administrator
configurator
public javax.management.ObjectName[] getRelationship(
Session session,
javax.management.ObjectName parent,
java.lang.String relationshipNames
)
get the named relationship value of the specified config object.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.AttributeList getRelationships(
Session session,
javax.management.ObjectName parent,
java.lang.String[] relationshipNames
)
get the named relationship values of specified config object.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName[] queryConfigObjects(
Session session,
javax.management.ObjectName scope,
javax.management.ObjectName name,
javax.management.QueryExp query
)
The query method for specific type of config objects.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName[] queryConfigObjectsAtCurrentScope(
Session session,
javax.management.ObjectName scope,
java.lang.String type
)
The query method for specific type of config objects at the scope specified.
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
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName[] queryTemplates(
Session session,
java.lang.String type
)
The query method for specific type of templates.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName[] resolve(
Session session,
java.lang.String containmentPath
)
resolve the config object from its containment path.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public javax.management.ObjectName[] resolve(
Session session,
javax.management.ObjectName scope,
java.lang.String containmentPath
)
resolve the config object from its containment path.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void setProperties(
Session session,
java.util.HashMap props
)
set properties that associates with the session.
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.
administrator
configurator
public ValidationResult validate(
Session session,
javax.management.ObjectName scope
)
validate the configuration.
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.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager