ConfigService MBean

Partial ObjectName:
WebSphere:*,type=ConfigService

MinimalAccessCheck:

true


MBean ConfigService

Config Service component provides service of configuration related tasks on top of config repository service.


Operation Summary
voiddiscard(com.ibm.websphere.management.Session session)
           reload the session, discard all the changes in the session made after last save call.
voidsave(com.ibm.websphere.management.Session session, boolean overwriteOnConflict)
           save the changes made in the session to config repository.
java.lang.String[]getUnsavedChanges(com.ibm.websphere.management.Session session)
           get all the documents that changed in the session after last save call.
java.util.MapgetConflictDocuments(com.ibm.websphere.management.Session session)
           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.AttributeListgetRelationshipsMetaInfo(java.lang.String configObjectType)
           get the detailed information about the relationships.
javax.management.AttributeListgetAttributesMetaInfo(java.lang.String configDataType)
           get the detailed information about the attributes of specified config data type.
javax.management.ObjectNamecreateConfigData(com.ibm.websphere.management.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.
javax.management.ObjectNamecreateConfigDataByTemplate(com.ibm.websphere.management.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.
voidsetAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName configData, javax.management.AttributeList attrList)
           Modify the configuration of a config data.
voidresetAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName configData, javax.management.AttributeList attrList)
           reset the attribute list for the config data.
voidunsetAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName configData, java.lang.String[] attributes)
           remove the specified attributes from the attribute list of the config data.
voidaddElement(com.ibm.websphere.management.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.
voidremoveElement(com.ibm.websphere.management.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.
java.lang.ObjectgetAttribute(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String attributeName)
           Get the attribute of the config data.
javax.management.AttributeListgetAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String[] attributes, boolean recursive)
           Get the attribute values of the config data.
voiddeleteConfigData(com.ibm.websphere.management.Session session, javax.management.ObjectName parent)
           Delete the specified config data and its children.
javax.management.ObjectName[]getRelationship(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String relationshipNames)
           get the named relationship value of the specified config object.
javax.management.AttributeListgetRelationships(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String[] relationshipNames)
           get the named relationship values of specified config object.
javax.management.ObjectName[]queryConfigObjects(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, javax.management.ObjectName name, javax.management.QueryExp query)
           The query method for specific type of config objects.
javax.management.ObjectName[]queryConfigObjectsAtCurrentScope(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, java.lang.String type)
           The query method for specific type of config objects at the scope specified.
javax.management.ObjectName[]queryTemplates(com.ibm.websphere.management.Session session, java.lang.String type)
           The query method for specific type of templates.
javax.management.ObjectName[]resolve(com.ibm.websphere.management.Session session, java.lang.String containmentPath)
           resolve the config object from its containment path.
javax.management.ObjectName[]resolve(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, java.lang.String containmentPath)
           resolve the config object from its containment path.
voidsetProperties(com.ibm.websphere.management.Session session, java.util.HashMap props)
           set properties that associates with the session.
com.ibm.websphere.management.configservice.ValidationResultvalidate(com.ibm.websphere.management.Session session, javax.management.ObjectName scope)
           validate the configuration.

Operation Detail

discard

public void discard(com.ibm.websphere.management.Session session)
reload the session, discard all the changes in the session made after last save call.
Parameters:
session - The session id.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

save

public void save(com.ibm.websphere.management.Session session, boolean overwriteOnConflict)
save the changes made in the session to config repository.
Parameters:
session - The session id.
overwriteOnConflict - If user wants to overwrite the conflict document or roll back all the changes made after last save.
Security Roles:
administrator
configurator

getUnsavedChanges

public java.lang.String[] getUnsavedChanges(com.ibm.websphere.management.Session session)
get all the documents that changed in the session after last save call.
Parameters:
session - the seesion id.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getConflictDocuments

public java.util.Map getConflictDocuments(com.ibm.websphere.management.Session session)
get all the documents that have conflict changes with updates introduced by other session.
Parameters:
session - the seesion id. null may be supplied there a workspace will be created automatically and the change will be saved to repository.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getSupportedConfigObjectTypes

public java.lang.String[] getSupportedConfigObjectTypes()
returns the list of supported Config object types.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getRelationshipsMetaInfo

public javax.management.AttributeList getRelationshipsMetaInfo(java.lang.String configObjectType)
get the detailed information about the relationships.
Parameters:
configObjectType - config ojbect type. It must be one of the types returned from <code>getSupportedConfigObjectTypes</code>.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAttributesMetaInfo

public javax.management.AttributeList getAttributesMetaInfo(java.lang.String configDataType)
get the detailed information about the attributes of specified config data type.
Parameters:
configDataType - config data type.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

createConfigData

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)
create a Config object or config Data.
Parameters:
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.
Security Roles:
administrator
configurator

createConfigDataByTemplate

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)
create a Config object or config Data based on default template.
Parameters:
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.
Security Roles:
administrator
configurator

setAttributes

public void setAttributes(com.ibm.websphere.management.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.
Parameters:
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.
Security Roles:
administrator
configurator

resetAttributes

public void resetAttributes(com.ibm.websphere.management.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.
Parameters:
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.
Security Roles:
administrator
configurator

unsetAttributes

public void unsetAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName configData, java.lang.String[] attributes)
remove the specified attributes from the attribute list of the config data.
Parameters:
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.
Security Roles:
administrator
configurator

addElement

public void addElement(com.ibm.websphere.management.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.
Parameters:
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.
Security Roles:
administrator
configurator

removeElement

public void removeElement(com.ibm.websphere.management.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.
Parameters:
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.
Security Roles:
administrator
configurator

getAttribute

public java.lang.Object getAttribute(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String attributeName)
Get the attribute of the config data.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAttributes

public javax.management.AttributeList getAttributes(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String[] attributes, boolean recursive)
Get the attribute values of the config data.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

deleteConfigData

public void deleteConfigData(com.ibm.websphere.management.Session session, javax.management.ObjectName parent)
Delete the specified config data and its children.
Parameters:
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.
Security Roles:
administrator
configurator

getRelationship

public javax.management.ObjectName[] getRelationship(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String relationshipNames)
get the named relationship value of the specified config object.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getRelationships

public javax.management.AttributeList getRelationships(com.ibm.websphere.management.Session session, javax.management.ObjectName parent, java.lang.String[] relationshipNames)
get the named relationship values of specified config object.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

queryConfigObjects

public javax.management.ObjectName[] queryConfigObjects(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, javax.management.ObjectName name, javax.management.QueryExp query)
The query method for specific type of config objects.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

queryConfigObjectsAtCurrentScope

public javax.management.ObjectName[] queryConfigObjectsAtCurrentScope(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, java.lang.String type)
The query method for specific type of config objects at the scope specified.
Parameters:
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
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

queryTemplates

public javax.management.ObjectName[] queryTemplates(com.ibm.websphere.management.Session session, java.lang.String type)
The query method for specific type of templates.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

resolve

public javax.management.ObjectName[] resolve(com.ibm.websphere.management.Session session, java.lang.String containmentPath)
resolve the config object from its containment path.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

resolve

public javax.management.ObjectName[] resolve(com.ibm.websphere.management.Session session, javax.management.ObjectName scope, java.lang.String containmentPath)
resolve the config object from its containment path.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

setProperties

public void setProperties(com.ibm.websphere.management.Session session, java.util.HashMap props)
set properties that associates with the session.
Parameters:
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.
Security Roles:
administrator
configurator

validate

public com.ibm.websphere.management.configservice.ValidationResult validate(com.ibm.websphere.management.Session session, javax.management.ObjectName scope)
validate the configuration.
Parameters:
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.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Copyright IBM Corp. 1996-2005