ConfigRepository MBean

Partial ObjectName:
WebSphere:*,type=ConfigRepository

MinimalAccessCheck:
true


MBean ConfigRepository

Management interface for the configuration repository.


Operation Summary
DocumentDigestcreate(DocumentContentSource docContents)
           Create a new document in the repository
DocumentDigest[]create(DocumentContentSource[] docContents)
           Create new documents in the repository
voiddelete(java.lang.String docURI)
           Delete a document from the repository
voiddelete(java.lang.String[] docURIs)
           Delete documents from the repository
voiddelete(Document doc)
           Delete a document from the repository
voiddelete(Document[] docs)
           Delete documents from the repository
java.lang.Stringrename(java.lang.String docURI, java.lang.String newdocURI)
           Rename a document in the repository
java.lang.Stringrename(Document doc, Document newdoc)
           Rename a document in the repository
DocumentContentSourceextract(java.lang.String docURI)
           Extract a document from the repository
DocumentContentSource[]extract(java.lang.String[] docURI)
           Extract documents from the repository
DocumentContentSourceextract(Document doc)
           Extract a document from the repository
DocumentContentSource[]extract(Document[] docs)
           Extract documents from the repository
DocumentDigestmodify(DocumentContentSource docContents)
           Modify a document in the repository
DocumentDigest[]modify(DocumentContentSource[] docContents)
           Modify documents in the repository
java.util.HashMapupdate(DocumentContentSource[] docContents, DocumentContentSource[] docContents, Document[] docContents)
           Add, modify, and/or, delete documents in the repository
java.lang.BooleanlockRepository(java.lang.String reason)
           Lock the repository
java.lang.BooleanunlockRepository(java.lang.String reason)
           Unlock the repository
java.util.PropertiesgetConfig()
           Get the configuration of the repository.
ConfigEpochgetRepositoryEpoch()
           Get the current epoch of the repository.
ConfigEpochrefreshRepositoryEpoch()
           Refresh the epoch of the repository.
java.lang.String[]listResourceNames(java.lang.String parent, int type, int depth)
           List repository contents
DocumentDigestgetDigest(java.lang.String docURI)
           Get the digest for a document in the repository
DocumentDigest[]getDigest(java.lang.String[] docURI)
           Get the digests for documents in the repository
voidcreateDigestFile(java.lang.String docURI, boolean delete)
           Create a digest file for a document

Notification Summary
websphere.repository.change
           The configuration repository contents have changed.
websphere.repository.lock
           The configuration repository is locked.
websphere.repository.unlock
           The configuration repository is unlocked.
websphere.repository.epoch.refresh
           The configuration repository's epoch is refreshed.

Operation Detail

create

public DocumentDigest create(DocumentContentSource docContents)
Create a new document in the repository
Parameters:
docContents - The new document contents
Security Roles:
administrator
configurator

create

public DocumentDigest[] create(DocumentContentSource[] docContents)
Create new documents in the repository
Parameters:
docContents - The new document contents
Security Roles:
administrator
configurator

delete

public void delete(java.lang.String docURI)
Delete a document from the repository
Parameters:
docURI - the URI of the document
Security Roles:
administrator
configurator

delete

public void delete(java.lang.String[] docURIs)
Delete documents from the repository
Parameters:
docURIs - the URI of the document
Security Roles:
administrator
configurator

delete

public void delete(Document doc)
Delete a document from the repository
Parameters:
doc - the URI of the document
Security Roles:
administrator
configurator

delete

public void delete(Document[] docs)
Delete documents from the repository
Parameters:
docs - the URI of the document
Security Roles:
administrator
configurator

rename

public java.lang.String rename(java.lang.String docURI, java.lang.String newdocURI)
Rename a document in the repository
Parameters:
docURI - the current URI of the document
newdocURI - the new URI of the document
Security Roles:
administrator
configurator

rename

public java.lang.String rename(Document doc, Document newdoc)
Rename a document in the repository
Parameters:
doc - the current URI of the document
newdoc - the new URI of the document
Security Roles:
administrator
configurator

extract

public DocumentContentSource extract(java.lang.String docURI)
Extract a document from the repository
Parameters:
docURI - the URI of the document
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

extract

public DocumentContentSource[] extract(java.lang.String[] docURI)
Extract documents from the repository
Parameters:
docURI - the URI of the document
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

extract

public DocumentContentSource extract(Document doc)
Extract a document from the repository
Parameters:
doc - the URI of the document
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

extract

public DocumentContentSource[] extract(Document[] docs)
Extract documents from the repository
Parameters:
docs - the URI of the document
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

modify

public DocumentDigest modify(DocumentContentSource docContents)
Modify a document in the repository
Parameters:
docContents - The new document contents
Security Roles:
administrator
configurator

modify

public DocumentDigest[] modify(DocumentContentSource[] docContents)
Modify documents in the repository
Parameters:
docContents - The new document contents
Security Roles:
administrator
configurator

update

public java.util.HashMap update(DocumentContentSource[] docContents, DocumentContentSource[] docContents, Document[] docContents)
Add, modify, and/or, delete documents in the repository
Parameters:
docContents - The document contents for new documents
docContents - The document contents for modified documents
docContents - The document contents for deleted documents
Security Roles:
administrator
configurator

lockRepository

public java.lang.Boolean lockRepository(java.lang.String reason)
Lock the repository
Parameters:
reason - a description of the reason for locking the repository
Security Roles:
administrator
configurator

unlockRepository

public java.lang.Boolean unlockRepository(java.lang.String reason)
Unlock the repository
Parameters:
reason - a description of the reason for locking the repository - this should match the reason given in the lockRepository call.
Security Roles:
administrator
configurator

getConfig

public java.util.Properties getConfig()
Get the configuration of the repository.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getRepositoryEpoch

public ConfigEpoch getRepositoryEpoch()
Get the current epoch of the repository.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

refreshRepositoryEpoch

public ConfigEpoch refreshRepositoryEpoch()
Refresh the epoch of the repository.
Security Roles:
administrator
configurator

listResourceNames

public java.lang.String[] listResourceNames(java.lang.String parent, int type, int depth)
List repository contents
Parameters:
parent -
type -
depth -
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getDigest

public DocumentDigest getDigest(java.lang.String docURI)
Get the digest for a document in the repository
Parameters:
docURI - the URI of the document
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getDigest

public DocumentDigest[] getDigest(java.lang.String[] docURI)
Get the digests for documents in the repository
Parameters:
docURI - the URIs of the documents
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

createDigestFile

public void createDigestFile(java.lang.String docURI, boolean delete)
Create a digest file for a document
Parameters:
docURI - the URI of the document
delete - a flag to indicate if the original document should be deleted
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Notification Detail

websphere.repository.change

The configuration repository contents have changed.
Severity:
5  (Warning)

websphere.repository.lock

The configuration repository is locked.
Severity:
5  (Warning)

websphere.repository.unlock

The configuration repository is unlocked.
Severity:
5  (Warning)

websphere.repository.epoch.refresh

The configuration repository's epoch is refreshed.
Severity:
5  (Warning)

Copyright IBM Corp. 1996-2005