Config (Java API Reference for Oracle Service Bus)

java.lang.Object
- com.bea.wli.config.mbeans.Config

All Implemented Interfaces:

ConfigMBean
```
public class Config
extends java.lang.Object
implements ConfigMBean
```
implementation of the ConfigMBean API NOTE: This class must not be instantiated or accessed directly other than by the config framework itself.

Field Summary
- Fields inherited from interface com.bea.wli.config.mbeans.ConfigMBean
  NAME, TYPE

Constructor Summary

Constructors
Constructor and Description

Config(ConfigServiceImpl configService, java.lang.String session)

Constructors
Constructor and Description
`Config(ConfigServiceImpl configService, java.lang.String session)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignEnvValues(java.util.Collection<QualifiedEnvValue> envValues)` Sets one or more environment value directly.
`void`	`cloneLocation(Ref sourceLocation, Ref targetLocation, boolean merge)` Clones a given project or folder.
`void`	`cloneResource(Ref ref, Ref newref)` Clones a given resource.
`void`	`createChildResource(Ref parentref, NamedRef childref, java.lang.Object childResourceData)` Creates a resource that is logically contained within a parent resource.
`byte[]`	`createCustomizationFile(java.util.Set<Ref> refs, java.util.Set<java.lang.String> envValueTypes)` Creates a customization file from a set of resources/projects/folder.
`Ref`	`createFolder(Ref projectOrFolderRef, java.lang.String folderName, java.lang.String description)` Creates a folder with the given name under a project or another folder.
`void`	`createLocation(Ref location, java.lang.String description)` creates a location
`Ref`	`createProject(java.lang.String projectName, java.lang.String description)` Creates a project with the given name, and project data.
`void`	`createResource(Ref ref, java.lang.Object resourceData)` Creates a resource with the given reference.
`void`	`customize(java.util.List<Customization> customizations)` This API supports multiple customizations at one place.
`void`	`delete(java.util.Set<Ref> refs)` Deletes the given collection of references.
`void`	`delete(java.util.Set<Ref> refs, java.util.Set<Ref> exclusions)` Deletes the given collection of references.
`void`	`deleteFolder(Ref folderRef)` Deletes the given folder
`void`	`deleteLocation(Ref location)` deletes a particular location
`void`	`deleteProject(java.lang.String projectName)` Deletes the given project
`void`	`deleteResource(Ref ref)` Deletes the given resource
`boolean`	`exists(Ref ref)` Returns true if an entity exists in the project.
`byte[]`	`export(java.util.Collection<Ref> refsToExport, boolean includeDependencies, EncryptionScope escope, char[] passphrase)` Exports the given collection of references on-the-fly and returns bytes that make up the export data.
`byte[]`	`exportProjects(java.util.Collection<Ref> projectrefs, char[] passphrase)` Export resources at the project level.
`java.util.List<QualifiedEnvValue>`	`findEnvValues(EnvValueQuery query)` Searches environment specific values in the domain in a particular session and returns env values that satisfy the criteria constituted by the parameters
`SnapshotDelta<CanonicalResource,CanonicalDelta>`	`getCanonicalDelta(RefValueDomain valueDomain, java.util.Date date1, java.util.Date date2)` Returns the delta of canonical values between two snapshots at different dates.
`SnapshotDelta<CanonicalResource,CanonicalDelta>`	`getCanonicalDelta(Snapshot<Digest> source)` Compares the versions and references given in the sourceVersion with the current set of resources and their versions.
`Snapshot<CanonicalResource>`	`getCanonicalSnapshot(RefValueDomain valueDomain, java.util.Date date)` Returns snapshot of canonical values for resources that are in the given value domain as of the given time.
`java.util.List<ChangeRecord>`	`getChangeHistory(Ref ref, ChangeRecord.ChangeHistoryType historyType, int resultSize)` Returns a list of changes, in chronological order, that are performed over the given reference.
`SessionConflicts`	`getConflicts(java.lang.Boolean dummy)` Returns a list of conflicts
`java.lang.Object`	`getDelta(Ref ref1, long version1, Ref ref2, long version2)` Returns the delta (diff) between the two revisions of the given resources.
`java.util.Set<Ref>`	`getDependencies(Ref root)` Returns the collection of references that originate from a component in the tree rooted at the given reference to another component that is outside the tree.
`java.util.Set<Ref>`	`getDependents(Ref root)` Returns the collection of references from components outside the given tree to components that are inside the tree.
`java.util.Map<Ref,Diagnostics>`	`getDiagnostics(java.util.Collection<Ref> refs)` Returns a mapping from resource references to diagnostic objects for these resources.
`Diagnostics`	`getDiagnostics(Ref ref)` Returns the Diagnostics object for the given resource.
`SnapshotDelta<Digest,Digest>`	`getDigestDelta(RefValueDomain valueDomain, java.util.Date date1, java.util.Date date2)` Returns the delta of digests between two snapshots at different dates.
`Snapshot<Digest>`	`getDigestSnapshot(RefValueDomain valueDomain, java.util.Date date)` Returns snapshot of Digests for resources that are in the given value domain as of the given time.
`java.lang.Object`	`getEnvValue(Ref ref, java.lang.String envType, java.lang.String location)` returns the environment value with the given type and location in the given resource.
`java.util.List<EnvValueMetadata>`	`getEnvValueMetadata(java.util.Set<java.lang.String> envValueTypes)` returns a Collection of EnvValueMetadata of the respective envValueTypes that are passed.
`java.util.Set<java.lang.String>`	`getEnvValueTypes()` Returns a collection of all the known env value types registered
`java.util.List<ExecRecord>`	`getExecRecords(java.util.Date startDate, java.util.Date endDate, java.util.Set<TaskDescription.Type> taskTypes, java.util.Set<java.lang.String> userNames, java.util.Set<ExecRecord.Status> statusSet, java.util.Set<Ref> refsAffected)` Returns ExecRecords matching the criteria formed by the input arguments.
`java.util.List<ExecRecord>`	`getExecRecords(java.util.List<java.lang.String> taskIds)` Returns ExecRecord objects associated with the given list of task Ids.
`java.util.List<ExecRecord>`	`getExecutionHistory(int N)` Returns the execution records for the last `N` task executions that are performed in the given session or directly on the core state.
`ExportInfo`	`getExportInfo()` Returns information about all the resources in a session that can be exported
`java.lang.String`	`getFolderDescription(Ref folder)` returns the data associated with the folder
`java.util.Set<Ref>`	`getFolders(Ref root)` lists the folders dirctly undr the given parent location
`<T extends Metadata> T`	`getMetadata(Ref ref)` Returns the metadata about the given reference.
`java.util.Map<Ref,Metadata>`	`getMetadata(java.util.Set<Ref> refs)` Returns metadata information about the given references.
`SnapshotDelta<PortableResource,PortableDelta>`	`getPortableDelta(RefValueDomain valueDomain, java.util.Date date1, java.util.Date date2, PBE_EncryptionService es)` Returns the delta of portable values between two snapshots at different dates.
`SnapshotDelta<PortableResource,PortableDelta>`	`getPortableDelta(Snapshot<Digest> source)` Compares the versions and references given in the sourceVersion with the current set of resources and their versions.
`Snapshot<PortableResource>`	`getPortableSnapshot(RefValueDomain valueDomain, java.util.Date date)` Returns snapshot of portable values for resources that are in the given value domain as of the given time.
`java.lang.String`	`getProjectDescription(java.lang.String projectName)` returns the data associated with the project
`java.util.Set<Ref>`	`getProjects()` Convenience method for obtaining all the projects in the domain
`SnapshotDelta<Ref,Ref>`	`getRefDelta(RefValueDomain valueDomain, java.util.Date date1, java.util.Date date2)` Returns the delta of references between two snapshots at different dates.
`java.util.Set<Ref>`	`getRefs(BaseQuery query)` Searches for resources using the given query and returns a set of refs.
`Snapshot<Ref>`	`getRefSnapshot(RefValueDomain valueDomain, java.util.Date date)` Returns snapshot of references that are in the given value domain as of the given time.
`java.lang.Object`	`getResourceData(Ref ref)` Returns the resource data (by default this will be a copy).
`java.lang.Object`	`getResourceData(Ref ref, boolean copy)` Returns the resource data.
`ResourceMetadata`	`getResourceMetadata(Ref ref)` returns the metadata for the given resource ref
`java.util.Map<Ref,ResourceMetadata>`	`getResourceMetadata(ResourceQuery query)` Searches a particular resource type based in the given resource query and returns metadata for the resources that satisfy the given criteria.
`java.util.Map<Ref,ResourceMetadata>`	`getResourceMetadata(java.util.Set<Ref> refs)` Returns metadata information about the given references.
`java.util.Set<Ref>`	`getResources(Ref root)` Returns the resources that are directly under the given root.
`java.util.Set<Ref>`	`getResources(Ref root, boolean recursive)` Returns the resources that are under the given root.
`java.util.Set<Ref>`	`getResources(ResourceQuery query)` Returns references to all resources satisfying the given query
`java.util.Set<Ref>`	`getResources(java.lang.String typeId)` Returns references to all resources of the given type
`CanonicalResource`	`getRevision(Ref ref, long version)` Returns the the CanonicalResource representation of the given revision of a resource
`java.lang.String`	`getSession()` Returns the name of the session that whis mbean operates on
`SessionInfo`	`getSessionInfo()` returns the session info
`java.util.Set<java.lang.String>`	`getSimpleEnvValueTypes()` Returns a Set of the known env value types with simple value objects registered.
`UploadedJarInfo`	`getUploadedJarInfo()` Returns detailed information about the entities in the previously staged configuration jar file
`boolean`	`hasDependents(Ref root)` Returns true if there are any dependents on the given folder/project or resource.
`ImportResult`	`importUploaded(java.util.Collection<Ref> refs, boolean includeDependencies, boolean preserveExistingEnvValues, char[] passphrase)` imports selected resources/projects/folders from the previously uploaded jar file into the session.
`ImportResult`	`importUploaded(ImportPlan importPlan)` Import an already uploaded jar file in this session.
`java.util.Set<Ref>`	`mapReferences(java.util.Collection<Ref> resourcesToConsider, java.util.Map<Ref,Ref> refMap)` Modifies the existing references from all the resources in the given list (resourcesToConsider) to a new set of references passed in the refMap.
`Ref`	`moveResource(Ref ref, Ref location)` convenience method to move the given resource to a new location
`boolean`	`projectExists(java.lang.String projectName)` Convenience method that returns true if the given project exists
`int`	`purgeExecutionHistory(java.util.Date startTime, java.util.Date endTime, boolean deletePurgeRecords)` Purges execution and associated undo records for the given session.
`int`	`purgeExecutionHistory(int max)` Purges execution and associated undo records for the given session.
`void`	`renameLocation(Ref sourceLocation, Ref targetLocation, boolean merge)` Maps an existing project or folder to another project or folder.
`void`	`renameResource(Ref ref, Ref newref)` Changes the identity of an existing resource so that its name, or its location, or both are different.
`Ref`	`renameResource(Ref ref, java.lang.String name)` convenience methods to rename just the local name
`int`	`replaceEnvValues(EnvValueQuery query, java.lang.String replacement)` Find environment values as indicated by the query and replaces all occurances of the env value pattern (as returned by `EnvValueQuery.getSearchString()` ) with the given parameter.
`java.util.Map<Ref,ResourceMetadata>`	`searchResources(java.util.Set<ResourceQuery> queries)` Searches across multiple resource types based on a set of queries reusing the existing query infrastructure
`void`	`setFolderDescription(Ref folder, java.lang.String desc)` Sets the description associated with the folder
`void`	`setProjectDescription(java.lang.String projectName, java.lang.String description)` Sets the data associated with the project
`void`	`synchronizeResource(Ref resourceref)` synchronizes the value of a resource that has been modified in this session, with the value from the core.
`void`	`undoTask(java.lang.String taskId)` Undoes the execution of a config task whose task id is given.
`void`	`updateLocation(Ref location, java.lang.String description)` Sets the description associated with the location
`void`	`updateResource(Ref ref, java.lang.Object newResourceData)` Updates an existing resource
`byte[]`	`upgradeJarFile(byte[] input, char[] passphrase)` Re-exports an exported jar file without importing it.
`void`	`uploadJarFile(byte[] data)` obtains configuration data from a configuration jar file and locally (temporarily) stages it

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Config
```
public Config(ConfigServiceImpl configService,
              java.lang.String session)
```
- Method Detail
  - getSession
```
public java.lang.String getSession()
```
    Description copied from interface: ConfigMBean
    
    Returns the name of the session that whis mbean operates on
    
    Specified by:
    
    getSession in interface ConfigMBean
  - getSessionInfo
```
public SessionInfo getSessionInfo()
```
    Description copied from interface: ConfigMBean
    
    returns the session info
    
    Specified by:
    
    getSessionInfo in interface ConfigMBean
  - exists
```
public boolean exists(Ref ref)
```
    Description copied from interface: ConfigMBean
    
    Returns true if an entity exists in the project. The entity can be a project, folder, or a resource
    
    Specified by:
    
    exists in interface ConfigMBean
    
    Parameters:
    
    ref - reference to the entity
  - getMetadata
```
public <T extends Metadata> T getMetadata(Ref ref)
                                   throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the metadata about the given reference. If the ref is a resource reference, then all the key values (Attributes) for that resource is also returned in the ResourceMetadata object.
    Specified by:
    
    getMetadata in interface ConfigMBean
    
    Parameters:
    
    ref - reference to a domain, project, folder or resource.
    
    Returns:
    returns
    
    DomainMetadata if ref is Ref.DOMAIN.
    
    ProjectMetadata if ref is a reference to a project.
    
    FolderMetadata if ref is a reference to a folder.
    
    ResourceMetadata if ref is a reference to a resource.
    Throws:
    
    NotFoundException - when referenced object is not found
  - getMetadata
```
public java.util.Map<Ref,Metadata> getMetadata(java.util.Set<Ref> refs)
                                        throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns metadata information about the given references. see ConfigMBean.getMetadata(com.bea.wli.config.Ref) for more information on the data returned.
    
    Specified by:
    
    getMetadata in interface ConfigMBean
    
    Throws:
    
    NotFoundException
  - getRefs
```
public java.util.Set<Ref> getRefs(BaseQuery query)
                           throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Searches for resources using the given query and returns a set of refs.
    
    Specified by:
    
    getRefs in interface ConfigMBean
    
    Parameters:
    
    query - You can pass either ResourceQuery or DependencyQuery.
    
    Returns:
    
    the resulted resources as a set of refs
    
    Throws:
    
    NotFoundException - if a resource to a reference is not found
  - hasDependents
```
public boolean hasDependents(Ref root)
                      throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns true if there are any dependents on the given folder/project or resource. If root is a resource, returns true if there are other resources that depend on this resource. If root is a folder or project, returns true if there are resources outside of the folder/project that reference some resource inside this folder/project. This method should be used instead of ConfigMBean.getDependents(Ref) } when checking whether the root can be deleted.
    
    Specified by:
    
    hasDependents in interface ConfigMBean
    
    Returns:
    
    Throws:
    
    NotFoundException
  - getDependents
```
public java.util.Set<Ref> getDependents(Ref root)
                                 throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the collection of references from components outside the given tree to components that are inside the tree.
    
    Specified by:
    
    getDependents in interface ConfigMBean
    
    Returns:
    
    Throws:
    
    NotFoundException
  - getDependencies
```
public java.util.Set<Ref> getDependencies(Ref root)
                                   throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the collection of references that originate from a component in the tree rooted at the given reference to another component that is outside the tree.
    
    Specified by:
    
    getDependencies in interface ConfigMBean
    
    Throws:
    
    NotFoundException
  - delete
```
public void delete(java.util.Set<Ref> refs)
            throws DeleteException,
                   NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Deletes the given collection of references. The collection can contains a mixture of resource references as well as projects or folders. All projects and folders are expanded and all resources within those locations are deleted as well.
    
    Specified by:
    
    delete in interface ConfigMBean
    
    Parameters:
    
    refs - the collection of references to delete
    
    Throws:
    
    DeleteException
    
    NotFoundException - if a reference is not found
  - delete
```
public void delete(java.util.Set<Ref> refs,
                   java.util.Set<Ref> exclusions)
            throws DeleteException,
                   NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Deletes the given collection of references. The collection can contains a mixture of resource references as well as projects or folders. All projects and folders are expanded and all resources within those locations are deleted as well.
    
    Specified by:
    
    delete in interface ConfigMBean
    
    Parameters:
    
    refs - the collection of references to delete
    
    exclusions - collection of references to exclude from deletion
    
    Throws:
    
    DeleteException
    
    NotFoundException - if a reference is not found
  - getProjects
```
public java.util.Set<Ref> getProjects()
```
    Description copied from interface: ConfigMBean
    
    Convenience method for obtaining all the projects in the domain
    
    Specified by:
    
    getProjects in interface ConfigMBean
  - projectExists
```
public boolean projectExists(java.lang.String projectName)
```
    Description copied from interface: ConfigMBean
    
    Convenience method that returns true if the given project exists
    
    Specified by:
    
    projectExists in interface ConfigMBean
  - createProject
```
public Ref createProject(java.lang.String projectName,
                         java.lang.String description)
                  throws ValidationException,
                         CreateException
```
    Description copied from interface: ConfigMBean
    
    Creates a project with the given name, and project data.
    
    Specified by:
    
    createProject in interface ConfigMBean
    
    Parameters:
    
    projectName - name of the project.
    
    description - descriptions associated with the project
    
    Returns:
    
    a reference to the project that is created
    
    Throws:
    
    ValidationException
    
    CreateException
  - deleteProject
```
public void deleteProject(java.lang.String projectName)
                   throws DeleteException,
                          NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Deletes the given project
    
    Specified by:
    
    deleteProject in interface ConfigMBean
    
    Parameters:
    
    projectName - name of the project
    
    Throws:
    
    DeleteException
    
    NotFoundException - if the project is not found
  - setProjectDescription
```
public void setProjectDescription(java.lang.String projectName,
                                  java.lang.String description)
                           throws ValidationException,
                                  UpdateException
```
    Description copied from interface: ConfigMBean
    
    Sets the data associated with the project
    
    Specified by:
    
    setProjectDescription in interface ConfigMBean
    
    Throws:
    
    UpdateException
    
    ValidationException
  - getProjectDescription
```
public java.lang.String getProjectDescription(java.lang.String projectName)
                                       throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    returns the data associated with the project
    
    Specified by:
    
    getProjectDescription in interface ConfigMBean
    
    Throws:
    
    NotFoundException
  - getFolders
```
public java.util.Set<Ref> getFolders(Ref root)
                              throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    lists the folders dirctly undr the given parent location
    
    Specified by:
    
    getFolders in interface ConfigMBean
    
    Parameters:
    
    root - reference to the parent project or folder for which to lists the sub-folders
    
    Throws:
    
    NotFoundException - if the parnt is not found
  - createFolder
```
public Ref createFolder(Ref projectOrFolderRef,
                        java.lang.String folderName,
                        java.lang.String description)
                 throws CreateException,
                        ValidationException
```
    Description copied from interface: ConfigMBean
    
    Creates a folder with the given name under a project or another folder.
    
    Specified by:
    
    createFolder in interface ConfigMBean
    
    Parameters:
    
    projectOrFolderRef - reference to the project or folder under which the new folder will be created
    
    folderName - name of the folder
    
    description - description associated with the folder. Optional
    
    Returns:
    
    reference to the folder that is created
    
    Throws:
    
    CreateException - if a folder with the same name under the given parent exists.
    
    ValidationException
  - deleteFolder
```
public void deleteFolder(Ref folderRef)
                  throws DeleteException,
                         NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Deletes the given folder
    
    Specified by:
    
    deleteFolder in interface ConfigMBean
    
    Parameters:
    
    folderRef - reference to the folder
    
    Throws:
    
    DeleteException
    
    NotFoundException - if the folder is not found
  - setFolderDescription
```
public void setFolderDescription(Ref folder,
                                 java.lang.String desc)
                          throws ValidationException,
                                 UpdateException
```
    Description copied from interface: ConfigMBean
    
    Sets the description associated with the folder
    
    Specified by:
    
    setFolderDescription in interface ConfigMBean
    
    Throws:
    
    UpdateException
    
    ValidationException
  - getFolderDescription
```
public java.lang.String getFolderDescription(Ref folder)
                                      throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    returns the data associated with the folder
    
    Specified by:
    
    getFolderDescription in interface ConfigMBean
    
    Throws:
    
    NotFoundException
  - createLocation
```
public void createLocation(Ref location,
                           java.lang.String description)
                    throws CreateException,
                           ValidationException
```
    Description copied from interface: ConfigMBean
    
    creates a location
    
    Specified by:
    
    createLocation in interface ConfigMBean
    
    Parameters:
    
    location - the location to create
    
    Throws:
    
    CreateException
    
    ValidationException
  - updateLocation
```
public void updateLocation(Ref location,
                           java.lang.String description)
                    throws ValidationException,
                           UpdateException
```
    Description copied from interface: ConfigMBean
    
    Sets the description associated with the location
    
    Specified by:
    
    updateLocation in interface ConfigMBean
    
    Throws:
    
    ValidationException
    
    UpdateException
  - deleteLocation
```
public void deleteLocation(Ref location)
                    throws NotFoundException,
                           DeleteException
```
    Description copied from interface: ConfigMBean
    
    deletes a particular location
    
    Specified by:
    
    deleteLocation in interface ConfigMBean
    
    Parameters:
    
    location - the location to delete
    
    Throws:
    
    NotFoundException - if the locationdoes nto exist
    
    DeleteException - if the delete failed
  - cloneLocation
```
public void cloneLocation(Ref sourceLocation,
                          Ref targetLocation,
                          boolean merge)
                   throws ValidationException,
                          CreateException
```
    Description copied from interface: ConfigMBean
    
    Clones a given project or folder. When a folder or project is cloned, all resources under that location are cloned recursively
    
    Specified by:
    
    cloneLocation in interface ConfigMBean
    
    Parameters:
    
    sourceLocation - the reference to the source project / folder to be cloned.
    
    targetLocation - the target location of the clone.
    
    merge - If true, does not complain if the target location already exists, and contains other resources.
    
    Throws:
    
    ValidationException
    
    CreateException
  - renameLocation
```
public void renameLocation(Ref sourceLocation,
                           Ref targetLocation,
                           boolean merge)
                    throws NotFoundException,
                           AlreadyExistsException,
                           UpdateException
```
    Description copied from interface: ConfigMBean
    
    Maps an existing project or folder to another project or folder. Mapping causes all subfolders and resources under the source to be moved to the target location. Certain mappings are simple renames of folders or projects, whereas others could be more elaborate move operation that may result in merging resources. A project can be mapped to a folder, or a folder can be mapped to a project. It is also possible to map a source location to an existing target location so that both are merged under the identity of the target location. Mapping a location to one of its descendants is not allowed (e.g., A/B/C cannot be mapped to A/B/C/D). However a location can be mapped to one of its ancestors (e.g., A/B/C can be mapped to A/B)
    More precisely a mapping from A1/A2/.../An to B1/B2/.../Bm will change identity of all projects, folders, and resources under A1/A2/.../An (inclusive) to have a location prefix of B1/B2/.../Bm. For example if there is a folder A1/A2/.../An/Foo, it will become B1/B2/.../Bm/Foo.
    
    Specified by:
    
    renameLocation in interface ConfigMBean
    
    Parameters:
    
    sourceLocation - the reference to the source project / folder to be mapped.
    
    targetLocation - the target location to be mapped to.
    
    merge - allows merging a project/folder with an existing project/folder. For example if folder A/B is changed to be D/E, and if D/E already exists, resources inside A/B will simply be moved into D/E, thereby merging the two folders.
    
    Throws:
    
    NotFoundException - if the source location is not found.
    
    AlreadyExistsException - thrown when merge is false and another location with the new identity already exists, or if merge is true and resource in the source location conflicts with anothoer resource with the same name in the target location.
    
    UpdateException - any other failure is wrapped inside this exception.
  - getResources
```
public java.util.Set<Ref> getResources(java.lang.String typeId)
```
    Description copied from interface: ConfigMBean
    
    Returns references to all resources of the given type
    
    Specified by:
    
    getResources in interface ConfigMBean
    
    Parameters:
    
    typeId - the type id
  - getResources
```
public java.util.Set<Ref> getResources(Ref root)
                                throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the resources that are directly under the given root. The root can be a project or folder.
    
    Specified by:
    
    getResources in interface ConfigMBean
    
    Parameters:
    
    root - the location containing the resources
    
    Throws:
    
    NotFoundException - if the given root is not found
  - getResources
```
public java.util.Set<Ref> getResources(Ref root,
                                       boolean recursive)
                                throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the resources that are under the given root. the root can be a project, folder or the Domain (e.g., Ref.DOMAIN
    
    Specified by:
    
    getResources in interface ConfigMBean
    
    Parameters:
    
    root - the location to look under
    
    recursive - If true, returns resources of sub-folders as well
    
    Throws:
    
    NotFoundException - if the given root is not found
  - getResources
```
public java.util.Set<Ref> getResources(ResourceQuery query)
```
    Description copied from interface: ConfigMBean
    
    Returns references to all resources satisfying the given query
    
    Specified by:
    
    getResources in interface ConfigMBean
    
    Parameters:
    
    query - the main filtering query
  - getResourceMetadata
```
public ResourceMetadata getResourceMetadata(Ref ref)
                                     throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    returns the metadata for the given resource ref
    
    Specified by:
    
    getResourceMetadata in interface ConfigMBean
    
    Throws:
    
    NotFoundException - if the resource does not exist
  - getResourceMetadata
```
public java.util.Map<Ref,ResourceMetadata> getResourceMetadata(java.util.Set<Ref> refs)
                                                        throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns metadata information about the given references.
    
    Specified by:
    
    getResourceMetadata in interface ConfigMBean
    
    Parameters:
    
    refs - references of the resources to get metadata for
    
    Throws:
    
    NotFoundException - if one of the resources does not exist
  - getResourceMetadata
```
public java.util.Map<Ref,ResourceMetadata> getResourceMetadata(ResourceQuery query)
                                                        throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Searches a particular resource type based in the given resource query and returns metadata for the resources that satisfy the given criteria. This method is similar to select-from-where clause of SQL in spirit.
    
    Specified by:
    
    getResourceMetadata in interface ConfigMBean
    
    Parameters:
    
    query - the main filtering query
    
    Throws:
    
    NotFoundException
  - searchResources
```
public java.util.Map<Ref,ResourceMetadata> searchResources(java.util.Set<ResourceQuery> queries)
                                                    throws NotFoundException
```
    Searches across multiple resource types based on a set of queries reusing the existing query infrastructure
    
    Specified by:
    
    searchResources in interface ConfigMBean
    
    Parameters:
    
    queries -
    
    Returns:
    
    Throws:
    
    NotFoundException
  - getResourceData
```
public java.lang.Object getResourceData(Ref ref)
                                 throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the resource data (by default this will be a copy).
    
    Specified by:
    
    getResourceData in interface ConfigMBean
    
    Parameters:
    
    ref - reference to the resource
    
    Returns:
    
    the resource data. The type of the result depends on the type of the resource
    
    Throws:
    
    NotFoundException
  - getResourceData
```
public java.lang.Object getResourceData(Ref ref,
                                        boolean copy)
                                 throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the resource data.
    
    Specified by:
    
    getResourceData in interface ConfigMBean
    
    Parameters:
    
    ref - reference to the resource
    
    copy - whether to return a copy. If asked to return the underlying value, care must be given not to update it.
    
    Returns:
    
    the resource data. The type of the result depends on the type of the resource
    
    Throws:
    
    NotFoundException
  - createResource
```
public void createResource(Ref ref,
                           java.lang.Object resourceData)
                    throws ValidationException,
                           CreateException
```
    Description copied from interface: ConfigMBean
    
    Creates a resource with the given reference. The location (folder/project) must already exists
    
    Specified by:
    
    createResource in interface ConfigMBean
    
    resourceData - the resource data. The data type depends on the resource type
    
    Throws:
    
    AlreadyExistsException - if a resource already exists for this reference
    
    CreateException - if creation fails
    
    ValidationException
  - createChildResource
```
public void createChildResource(Ref parentref,
                                NamedRef childref,
                                java.lang.Object childResourceData)
                         throws ValidationException,
                                CreateException
```
    Description copied from interface: ConfigMBean
    
    Creates a resource that is logically contained within a parent resource.
    
    Specified by:
    
    createChildResource in interface ConfigMBean
    
    Parameters:
    
    parentref - reference to the parent resource that will contain this child resource
    
    childref - the reference to the child that will be created, the name attribute is an opaque representation of the location where the child reference will go inside the parent resource. The exact form and semantics of this argument is completely left to the developers of the parent resource. Can be null if the location attribute is irrelevant
    
    childResourceData - the initial value for the child
    
    Throws:
    
    ValidationException - if validation fails
    
    AlreadyExistsException - if another resource already exists for this Ref
    
    CreateException - if creation of the resource fails
  - updateResource
```
public void updateResource(Ref ref,
                           java.lang.Object newResourceData)
                    throws ValidationException,
                           UpdateException
```
    Description copied from interface: ConfigMBean
    
    Updates an existing resource
    
    Specified by:
    
    updateResource in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    newResourceData - the new resource data. The data type depends on the resource type
    
    Throws:
    
    NotFoundException - if the resource does not exist
    
    UpdateException - if the update fails
    
    ValidationException
  - renameResource
```
public void renameResource(Ref ref,
                           Ref newref)
                    throws ValidationException,
                           UpdateException
```
    Description copied from interface: ConfigMBean
    
    Changes the identity of an existing resource so that its name, or its location, or both are different.
    
    Specified by:
    
    renameResource in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    newref - the new identity for the resource
    
    Throws:
    
    NotFoundException - if the resource is not found, or if the newRef references a non-existing location.
    
    AlreadyExistsException - if another resource with the new identity already exists
    
    UpdateException - any other failure
    
    ValidationException
  - renameResource
```
public Ref renameResource(Ref ref,
                          java.lang.String name)
                   throws ValidationException,
                          UpdateException
```
    Description copied from interface: ConfigMBean
    
    convenience methods to rename just the local name
    
    Specified by:
    
    renameResource in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    name - the new local name for the resource
    
    Throws:
    
    NotFoundException - if the resource is not found, or if the newRef references a non-existing location.
    
    AlreadyExistsException - if another resource with the new identity already exists
    
    UpdateException - any other failure
    
    ValidationException
  - moveResource
```
public Ref moveResource(Ref ref,
                        Ref location)
                 throws ValidationException,
                        UpdateException
```
    Description copied from interface: ConfigMBean
    
    convenience method to move the given resource to a new location
    
    Specified by:
    
    moveResource in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    location - the new identity for the resource
    
    Throws:
    
    NotFoundException - if the resource is not found, or if the newRef references a non-existing location.
    
    AlreadyExistsException - if another resource with the new identity already exists
    
    UpdateException - any other failure
    
    ValidationException
  - cloneResource
```
public void cloneResource(Ref ref,
                          Ref newref)
                   throws ValidationException,
                          CreateException
```
    Description copied from interface: ConfigMBean
    
    Clones a given resource.
    
    Specified by:
    
    cloneResource in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    newref - the new identity for the resource
    
    Throws:
    
    NotFoundException - if the resource is not found, or if the newRef references a non-existing location.
    
    AlreadyExistsException - if another resource with the new identity already exists
    
    CreateException - any other failure
    
    ValidationException
  - deleteResource
```
public void deleteResource(Ref ref)
                    throws NotFoundException,
                           DeleteException
```
    Description copied from interface: ConfigMBean
    
    Deletes the given resource
    
    Specified by:
    
    deleteResource in interface ConfigMBean
    
    Throws:
    
    NotFoundException - if the resource does not exist
    
    DeleteException
  - synchronizeResource
```
public void synchronizeResource(Ref resourceref)
                         throws ValidationException,
                                UpdateException,
                                CreateException,
                                DeleteException
```
    Description copied from interface: ConfigMBean
    synchronizes the value of a resource that has been modified in this session, with the value from the core. This method simply updates the session copy with the value from the core state. More precisely :
    - if deleted in core the session copy will be deleted
    - if created or updated in core, the session copy will be updated/recreated with the value from the core.
    Specified by:
    
    synchronizeResource in interface ConfigMBean
    
    Throws:
    
    ValidationException - if a validation failure occurs during synchronization
    
    UpdateException - if the resource cannot be updated
    
    CreateException - if the resource cannot be created
    
    DeleteException - if the resource cannot be deleted
  - uploadJarFile
```
public void uploadJarFile(byte[] data)
                   throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    obtains configuration data from a configuration jar file and locally (temporarily) stages it
    
    Specified by:
    
    uploadJarFile in interface ConfigMBean
    
    Parameters:
    
    data - contents of a previously exported configuration jar file
    
    Throws:
    
    java.lang.Exception
  - getUploadedJarInfo
```
public UploadedJarInfo getUploadedJarInfo()
                                   throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns detailed information about the entities in the previously staged configuration jar file
    
    Specified by:
    
    getUploadedJarInfo in interface ConfigMBean
    
    Returns:
    
    detailed information about the entities in the previously staged configuration jar file
    
    Throws:
    
    NotFoundException - if no configuration jar has been uploaded, or a previously uploaded jar file has been imported
  - importUploaded
```
public ImportResult importUploaded(java.util.Collection<Ref> refs,
                                   boolean includeDependencies,
                                   boolean preserveExistingEnvValues,
                                   char[] passphrase)
                            throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    imports selected resources/projects/folders from the previously uploaded jar file into the session. Once the import finishes (successfully or not) the staged config information is removed. The import continues even if some resources fail to import, and does not result in an exception. The failed imports are reported in the result.
    Specified by:
    
    importUploaded in interface ConfigMBean
    
    Parameters:
    
    refs - references to the resources/folders/projects to be imported. An entity can be listed multiple times (directly or indirectly via its parent folder/project). A reference to project, folder will cause all resources in the configuration jar file under that location to be imported. If null or Ref.DOMAIN all resources in the config jar are imported.
    
    includeDependencies - whether to include dependencies of the resources that are given in the refs parameter which are also in uploaded jar file.
    preserveExistingEnvValues - This flag controls whether certain environment values inside of a resource will be overwritten or preserved during an import. The import always overwrites any existing data, except environment values that are found in both the existing data and imported data. If this argument is true, the import of a resource (which already exists) proceeds as follows:
    
    If an env value is in the existing data, but not in the imported data, then the env value is removed.
    
    If an env value is in the imported data, but not in the existing data, it is added
    
    If an env value is in both existing data, and imported data, the imported env value replaces the existing env value.
    passphrase - the pass phrase to use to decrypt resources that have been encrypted. Null value can be given if the jar file is known to not have been encrypted.
    
    Returns:
    
    ImportResult object that contains resources that are successfully imported, and those that have failed
    
    Throws:
    
    NotFoundException - if no configuration jar has been uploaded, or a previously uploaded jar file has been imported
    
    java.lang.Exception - any other exception
  - importUploaded
```
public ImportResult importUploaded(ImportPlan importPlan)
                            throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Import an already uploaded jar file in this session.
    
    Specified by:
    
    importUploaded in interface ConfigMBean
    
    Parameters:
    
    importPlan - ImportPlan
    
    Returns:
    
    ImportResult object that contains resources that are successfully imported, deleted and those that have failed
    
    Throws:
    
    java.lang.Exception
  - export
```
public byte[] export(java.util.Collection<Ref> refsToExport,
                     boolean includeDependencies,
                     EncryptionScope escope,
                     char[] passphrase)
              throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Exports the given collection of references on-the-fly and returns bytes that make up the export data.
    
    Specified by:
    
    export in interface ConfigMBean
    
    Parameters:
    
    refsToExport - array of references to items to be exported. A reference to a resource causes that resource to be exported. If there is a reference to a folder, project, or the domain (via Ref.DOMAIN) then all resources under these are exported as well. In order to export all the resources simply call this method with Ref.DOMAIN.
    
    includeDependencies - whether to include dependencies of the resources that are given in the refsToExport parameter
    
    escope - the scope of encryption
    
    passphrase - the passphrase to use if encryption will be done
    
    Returns:
    
    bytes that make up a configuration jar file
    
    Throws:
    
    java.lang.Exception - if a reference is not found.
  - exportProjects
```
public byte[] exportProjects(java.util.Collection<Ref> projectrefs,
                             char[] passphrase)
                      throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Export resources at the project level. A jar file that contains resources exported at the project level behaves differently from a jar file exported at the resource level (via ConfigMBean.export(java.util.Collection<com.bea.wli.config.Ref>, boolean, com.bea.wli.config.importexport.EncryptionScope, char[]) when imported to a target domain. Resource that are in the target domain, but not in the jar file are deleted by default. This behavior could be overriden or customized by modifying the import plan.
    
    Specified by:
    
    exportProjects in interface ConfigMBean
    
    Parameters:
    
    projectrefs - references to projects to be exported
    
    Returns:
    
    bytes that make up an exported configuration in the form of a zip file. The result can be saved as a zip file and inspected with relevant tools.
    
    Throws:
    
    java.lang.Exception
  - getExportInfo
```
public ExportInfo getExportInfo()
```
    Description copied from interface: ConfigMBean
    
    Returns information about all the resources in a session that can be exported
    
    Specified by:
    
    getExportInfo in interface ConfigMBean
    
    Returns:
  - upgradeJarFile
```
public byte[] upgradeJarFile(byte[] input,
                             char[] passphrase)
                      throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Re-exports an exported jar file without importing it. This causes the jar file to be upgraded automatically if it was an old version.
    
    Specified by:
    
    upgradeJarFile in interface ConfigMBean
    
    Parameters:
    
    input - bytes that supplies the contents of the exported jar file
    
    passphrase - the pass phrase to use to decrypt resources that have been encrypted. Null value can be given if the jar file is known to not have been encrypted.
    
    Returns:
    
    bytes that make up the upgraded jar file
    
    Throws:
    
    java.lang.Exception
  - getEnvValueTypes
```
public java.util.Set<java.lang.String> getEnvValueTypes()
```
    Description copied from interface: ConfigMBean
    
    Returns a collection of all the known env value types registered
    
    Specified by:
    
    getEnvValueTypes in interface ConfigMBean
  - getSimpleEnvValueTypes
```
public java.util.Set<java.lang.String> getSimpleEnvValueTypes()
```
    Description copied from interface: ConfigMBean
    
    Returns a Set of the known env value types with simple value objects registered.
    
    Specified by:
    
    getSimpleEnvValueTypes in interface ConfigMBean
    
    Returns:
    
    Set of simple env value types.
  - getEnvValueMetadata
```
public java.util.List<EnvValueMetadata> getEnvValueMetadata(java.util.Set<java.lang.String> envValueTypes)
```
    Description copied from interface: ConfigMBean
    
    returns a Collection of EnvValueMetadata of the respective envValueTypes that are passed.
    
    Specified by:
    
    getEnvValueMetadata in interface ConfigMBean
    
    Returns:
  - getEnvValue
```
public java.lang.Object getEnvValue(Ref ref,
                                    java.lang.String envType,
                                    java.lang.String location)
                             throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    returns the environment value with the given type and location in the given resource.
    
    Specified by:
    
    getEnvValue in interface ConfigMBean
    
    Parameters:
    
    ref - resource ref
    
    envType - environment value type
    
    location - environment value location
    
    Returns:
    
    environment value
    
    Throws:
    
    NotFoundException - if the resource is not found
  - findEnvValues
```
public java.util.List<QualifiedEnvValue> findEnvValues(EnvValueQuery query)
                                                throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Searches environment specific values in the domain in a particular session and returns env values that satisfy the criteria constituted by the parameters
    
    Specified by:
    
    findEnvValues in interface ConfigMBean
    
    Throws:
    
    NotFoundException
  - replaceEnvValues
```
public int replaceEnvValues(EnvValueQuery query,
                            java.lang.String replacement)
                     throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Find environment values as indicated by the query and replaces all occurances of the env value pattern (as returned by EnvValueQuery.getSearchString() ) with the given parameter.
    
    Specified by:
    
    replaceEnvValues in interface ConfigMBean
    
    Parameters:
    
    query - the query that indicates which env values to find
    
    replacement - the replacement text. This text will be substituted for the env value pattern given in the query.
    
    Throws:
    
    java.lang.Exception
  - assignEnvValues
```
public void assignEnvValues(java.util.Collection<QualifiedEnvValue> envValues)
                     throws ValidationException,
                            UpdateException
```
    Description copied from interface: ConfigMBean
    
    Sets one or more environment value directly. This method is typically used after obtaining the existing environment values via the ConfigMBean.findEnvValues(com.bea.wli.config.env.EnvValueQuery) method to obtain the location of a particular environment value.
    
    Specified by:
    
    assignEnvValues in interface ConfigMBean
    
    Parameters:
    
    envValues - Environment values to set.
    
    Throws:
    
    NotFoundException - if a resource is not found
    
    UpdateException - if any other exception occurs while updating the env values
    
    ValidationException
  - undoTask
```
public void undoTask(java.lang.String taskId)
              throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Undoes the execution of a config task whose task id is given. Silently returns if the task is undoable, or if no undo task exists
    
    Specified by:
    
    undoTask in interface ConfigMBean
    
    Parameters:
    
    taskId - the id of the task that will be undone
    
    Throws:
    
    java.lang.Exception - if the undo task fails.
  - purgeExecutionHistory
```
public int purgeExecutionHistory(java.util.Date startTime,
                                 java.util.Date endTime,
                                 boolean deletePurgeRecords)
                          throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Purges execution and associated undo records for the given session. Records between the specified purge times are deleted.
    
    Specified by:
    
    purgeExecutionHistory in interface ConfigMBean
    
    Parameters:
    
    startTime - the start of time range for execution history purging. If null all records older than the endTime are deleted
    
    endTime - the end of the time range for execution history purging
    
    deletePurgeRecords - purge records are not automatically deleted. Set this flag to true to also delete any purge record in the time window. The deleted purge records will be accounted for in the count returned
    
    Returns:
    
    the number of execution history records purged
    
    Throws:
    
    java.lang.Exception
  - purgeExecutionHistory
```
public int purgeExecutionHistory(int max)
                          throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Purges execution and associated undo records for the given session. Only the 'max' more recent records are kept, all others are purged.
    
    Specified by:
    
    purgeExecutionHistory in interface ConfigMBean
    
    Parameters:
    
    max - maximum number of records to keep
    
    Returns:
    
    the number of execution history records purged
    
    Throws:
    
    java.lang.Exception
  - getExecutionHistory
```
public java.util.List<ExecRecord> getExecutionHistory(int N)
```
    Description copied from interface: ConfigMBean
    
    Returns the execution records for the last N task executions that are performed in the given session or directly on the core state. The result includes successful and unsuccessful executions. The result is ordered in reverse chronological order and is limited to the top N elements. This method returns empty list if no config operation has been executed so far.
    
    Specified by:
    
    getExecutionHistory in interface ConfigMBean
    
    Parameters:
    
    N - the number of most recent executions to return. a negative value returns all records
    
    Returns:
  - getExecRecords
```
public java.util.List<ExecRecord> getExecRecords(java.util.List<java.lang.String> taskIds)
                                          throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns ExecRecord objects associated with the given list of task Ids. The ordering of the ExecRecords in the result list is the same as the ordering of the corresponding task ids
    
    Specified by:
    
    getExecRecords in interface ConfigMBean
    
    Parameters:
    
    taskIds - list of task ids
    
    Returns:
    
    Throws:
    
    NotFoundException - if no information about the task was not found
  - getExecRecords
```
public java.util.List<ExecRecord> getExecRecords(java.util.Date startDate,
                                                 java.util.Date endDate,
                                                 java.util.Set<TaskDescription.Type> taskTypes,
                                                 java.util.Set<java.lang.String> userNames,
                                                 java.util.Set<ExecRecord.Status> statusSet,
                                                 java.util.Set<Ref> refsAffected)
```
    Description copied from interface: ConfigMBean
    
    Returns ExecRecords matching the criteria formed by the input arguments. The result is not ordered in any way
    
    Specified by:
    
    getExecRecords in interface ConfigMBean
    
    Parameters:
    
    startDate - return ExecRecords after and including this date. A null value indicates the beginning of time
    
    endDate - return ExecRecords before but not including this date. A null value indicates the all records since the start date
    
    taskTypes - return only the tasks whose type is included in this set. If null return all task types
    
    userNames - return only the tasks executed by any user in this set. If null return all tasks executed by any user
    
    statusSet - return only the tasks whose status is in this set. If null return all tasks regardless of their status
    
    refsAffected - return only the tasks that have modified *ANY* of the references included here. If null return all tasks regardless of what is modified. Renames and moves are handled in a special way. If a task renames/moves a resource from Ref1 to Ref2, it will appear as if the task has modified both Ref1 and Ref2
  - getChangeHistory
```
public java.util.List<ChangeRecord> getChangeHistory(Ref ref,
                                                     ChangeRecord.ChangeHistoryType historyType,
                                                     int resultSize)
                                              throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns a list of changes, in chronological order, that are performed over the given reference.
    
    Specified by:
    
    getChangeHistory in interface ConfigMBean
    
    Parameters:
    
    ref - the reference to the resource
    
    historyType - type of history to return. See ChangeRecord.ChangeHistoryType for more information
    
    resultSize - the number of results to return. If historyType is ChangeRecord.ChangeHistoryType#Progressive, the first resultSize changes are returned. Otherwise the most recent resultSize changes are returned
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - getRefSnapshot
```
public Snapshot<Ref> getRefSnapshot(RefValueDomain valueDomain,
                                    java.util.Date date)
                             throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns snapshot of references that are in the given value domain as of the given time. The result will include any changes that committed at exactly the given time
    
    Specified by:
    
    getRefSnapshot in interface ConfigMBean
    
    Parameters:
    
    valueDomain - the value domain
    
    date - indicates the date for which to return the snapshot. A null value indicates the most recent snapshot
    
    Throws:
    
    java.lang.Exception
  - getDigestSnapshot
```
public Snapshot<Digest> getDigestSnapshot(RefValueDomain valueDomain,
                                          java.util.Date date)
                                   throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns snapshot of Digests for resources that are in the given value domain as of the given time. The result will include any changes that committed at exactly the given time
    
    Specified by:
    
    getDigestSnapshot in interface ConfigMBean
    
    Parameters:
    
    valueDomain - the value domain
    
    date - indicates the date for which to return the snapshot. A null value indicates the most recent snapshot
    
    Throws:
    
    java.lang.Exception
  - getCanonicalSnapshot
```
public Snapshot<CanonicalResource> getCanonicalSnapshot(RefValueDomain valueDomain,
                                                        java.util.Date date)
                                                 throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns snapshot of canonical values for resources that are in the given value domain as of the given time. The result will include any changes that committed at exactly the given time
    
    Specified by:
    
    getCanonicalSnapshot in interface ConfigMBean
    
    Parameters:
    
    valueDomain - the value domain
    
    date - indicates the date for which to return the snapshot. A null value indicates the most recent snapshot
    
    Throws:
    
    java.lang.Exception
  - getPortableSnapshot
```
public Snapshot<PortableResource> getPortableSnapshot(RefValueDomain valueDomain,
                                                      java.util.Date date)
                                               throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns snapshot of portable values for resources that are in the given value domain as of the given time. The result will include any changes that committed at exactly the given time
    
    Specified by:
    
    getPortableSnapshot in interface ConfigMBean
    
    Parameters:
    
    valueDomain - the value domain
    
    date - indicates the date for which to return the snapshot. A null value indicates the most recent snapshot
    
    Throws:
    
    java.lang.Exception
  - getRefDelta
```
public SnapshotDelta<Ref,Ref> getRefDelta(RefValueDomain valueDomain,
                                          java.util.Date date1,
                                          java.util.Date date2)
                                   throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the delta of references between two snapshots at different dates. Only references that are in the value domains of both snapshots are returned.
    The delta is expressed in terms of add and delete operations, which when applied to the first snapshot will yield the second snapshot.
    
    The delta does not contain any entries for updated references, since this information cannot be derived from reference snapshots.
    
    Specified by:
    
    getRefDelta in interface ConfigMBean
    
    Throws:
    
    java.lang.Exception
  - getDigestDelta
```
public SnapshotDelta<Digest,Digest> getDigestDelta(RefValueDomain valueDomain,
                                                   java.util.Date date1,
                                                   java.util.Date date2)
                                            throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the delta of digests between two snapshots at different dates. Only resources that are in the value domains of both snapshots are returned
    The delta is expressed in terms of add, update and delete operations, which when applied to the first snapshot will yield the second snapshot.
    
    Specified by:
    
    getDigestDelta in interface ConfigMBean
    
    Throws:
    
    java.lang.Exception
  - getCanonicalDelta
```
public SnapshotDelta<CanonicalResource,CanonicalDelta> getCanonicalDelta(RefValueDomain valueDomain,
                                                                         java.util.Date date1,
                                                                         java.util.Date date2)
                                                                  throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the delta of canonical values between two snapshots at different dates. Only resources that are in the value domains of both snapshots are returned
    The delta is expressed in terms of add, update and delete operations, which when applied to the first snapshot will yield the second snapshot.
    
    Specified by:
    
    getCanonicalDelta in interface ConfigMBean
    
    Throws:
    
    java.lang.Exception
  - getPortableDelta
```
public SnapshotDelta<PortableResource,PortableDelta> getPortableDelta(RefValueDomain valueDomain,
                                                                      java.util.Date date1,
                                                                      java.util.Date date2,
                                                                      PBE_EncryptionService es)
                                                               throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the delta of portable values between two snapshots at different dates. Only resources that are in the value domains of both snapshots are returned
    The delta is expressed in terms of add, update and delete operations, which when applied to the first snapshot will yield the second snapshot.
    
    The result can optionally be encrypted
    
    Specified by:
    
    getPortableDelta in interface ConfigMBean
    
    Throws:
    
    java.lang.Exception
  - getCanonicalDelta
```
public SnapshotDelta<CanonicalResource,CanonicalDelta> getCanonicalDelta(Snapshot<Digest> source)
                                                                  throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Compares the versions and references given in the sourceVersion with the current set of resources and their versions. Finds the necessary delta, in terms of create, update and deleted operations, which brings the source version in sync with this session.
    
    Specified by:
    
    getCanonicalDelta in interface ConfigMBean
    
    Parameters:
    
    source - the digest snapshot of the source system
    
    Returns:
    
    CanonicalSnapshotDelta object which contains resources that needs to be created, and updated on the source system, along with their canonical values, and references to resources that needs to deleted
    
    Throws:
    
    java.lang.Exception
  - getPortableDelta
```
public SnapshotDelta<PortableResource,PortableDelta> getPortableDelta(Snapshot<Digest> source)
                                                               throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Compares the versions and references given in the sourceVersion with the current set of resources and their versions. Finds the necessary delta, in terms of create, update and deleted operations, which brings the source version in sync with this session.
    
    Specified by:
    
    getPortableDelta in interface ConfigMBean
    
    Parameters:
    
    source - the digest snapshot of the source system
    
    Returns:
    
    PortableSnapshotDelta object which contains resources that needs to be created, and updated on the source system, along with their portable (serialized) values, and references to resources that needs to deleted
    
    Throws:
    
    java.lang.Exception
  - getRevision
```
public CanonicalResource getRevision(Ref ref,
                                     long version)
                              throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the the CanonicalResource representation of the given revision of a resource
    
    Specified by:
    
    getRevision in interface ConfigMBean
    
    Parameters:
    
    ref - reference to the resource
    
    version - the version to return.
    
    Throws:
    
    java.lang.Exception
  - getDelta
```
public java.lang.Object getDelta(Ref ref1,
                                 long version1,
                                 Ref ref2,
                                 long version2)
                          throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Returns the delta (diff) between the two revisions of the given resources. Null value if the delta could not be determined. Both resources must be ty
    
    Specified by:
    
    getDelta in interface ConfigMBean
    
    Parameters:
    
    ref1 - the reference to the first resource.
    
    version1 - the version number of the first resource
    
    ref2 - the reference to the second resource
    
    version2 - the version number of the second resource
    
    Returns:
    
    the delta (diff) between the two revisions of the given resources. Null value if the delta could not be determined.
    
    Throws:
    
    java.lang.Exception
  - getConflicts
```
public SessionConflicts getConflicts(java.lang.Boolean dummy)
```
    Description copied from interface: ConfigMBean
    
    Returns a list of conflicts
    
    Specified by:
    
    getConflicts in interface ConfigMBean
    
    Parameters:
    
    dummy - must be null. This is here to get around a JMX behavior that was making this method invisible
  - getDiagnostics
```
public Diagnostics getDiagnostics(Ref ref)
                           throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns the Diagnostics object for the given resource.
    
    Specified by:
    
    getDiagnostics in interface ConfigMBean
    
    Returns:
    
    the Diagnostics object for the given resource. may be null.
    
    Throws:
    
    NotFoundException - if resource is not found
  - getDiagnostics
```
public java.util.Map<Ref,Diagnostics> getDiagnostics(java.util.Collection<Ref> refs)
                                              throws NotFoundException
```
    Description copied from interface: ConfigMBean
    
    Returns a mapping from resource references to diagnostic objects for these resources. The result contains mappings for only those references given in the argument that have a diagnostic object. If a resource does not have any diagnostics associated with it, the map does not contain an entry for this resource. A null refs collection returns all available diagnostics.
    
    Specified by:
    
    getDiagnostics in interface ConfigMBean
    
    Parameters:
    
    refs - the resource references for which to return the diagnostics.
    
    Returns:
    
    Throws:
    
    NotFoundException
  - mapReferences
```
public java.util.Set<Ref> mapReferences(java.util.Collection<Ref> resourcesToConsider,
                                        java.util.Map<Ref,Ref> refMap)
                                 throws NotFoundException,
                                        UpdateException
```
    Description copied from interface: ConfigMBean
    
    Modifies the existing references from all the resources in the given list (resourcesToConsider) to a new set of references passed in the refMap. refMap is validated first for any invalid or cyclic references. resourcesToConsider can also contain Project or Folder, in which case all the resources in that project or folder are modified with the new set of references passed in the refMap.
    
    Specified by:
    
    mapReferences in interface ConfigMBean
    
    Parameters:
    
    resourcesToConsider - list of resources to be modified with the new references
    
    refMap - map of references. key is the old ref and value is the new ref
    
    Returns:
    
    the set of refs to resources that were changed
    
    Throws:
    
    NotFoundException - if the resource to a reference is not found
    
    UpdateException - if there is any error while trying to update the resources
  - customize
```
public void customize(java.util.List<Customization> customizations)
               throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    This API supports multiple customizations at one place. As of now, you can do one of the following or any combinations of these: Assign Env Values | Find and Replace Env Values | Reference Mapping
    
    Specified by:
    
    customize in interface ConfigMBean
    
    Parameters:
    
    customizations - Customization
    
    Throws:
    
    java.lang.Exception
  - createCustomizationFile
```
public byte[] createCustomizationFile(java.util.Set<Ref> refs,
                                      java.util.Set<java.lang.String> envValueTypes)
                               throws java.lang.Exception
```
    Description copied from interface: ConfigMBean
    
    Creates a customization file from a set of resources/projects/folder. All projects and folders are expanded and all resources within those locations are considered.
    
    Specified by:
    
    createCustomizationFile in interface ConfigMBean
    
    Parameters:
    
    refs - set of resources/project/folder
    
    envValueTypes - only these environment value types are considered
    
    Returns:
    
    byte array of the file
    
    Throws:
    
    java.lang.Exception

Class Config

Field Summary

Fields inherited from interface com.bea.wli.config.mbeans.ConfigMBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Method Detail

getSession

getSessionInfo

exists

getMetadata

getMetadata

getRefs

hasDependents

getDependents

getDependencies

delete

delete

getProjects

projectExists

createProject

deleteProject

setProjectDescription

getProjectDescription

getFolders

createFolder

deleteFolder

setFolderDescription

getFolderDescription

createLocation

updateLocation

deleteLocation

cloneLocation

renameLocation

getResources

getResources

getResources

getResources

getResourceMetadata

getResourceMetadata

getResourceMetadata

searchResources

getResourceData

getResourceData

createResource

createChildResource

updateResource

renameResource

renameResource

moveResource

cloneResource

deleteResource

synchronizeResource

uploadJarFile

getUploadedJarInfo

importUploaded

importUploaded

export

exportProjects

getExportInfo

upgradeJarFile

getEnvValueTypes

getSimpleEnvValueTypes

getEnvValueMetadata

getEnvValue

findEnvValues

replaceEnvValues

assignEnvValues

undoTask

purgeExecutionHistory

purgeExecutionHistory

getExecutionHistory

getExecRecords

getExecRecords

getChangeHistory

getRefSnapshot

getDigestSnapshot

getCanonicalSnapshot