|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SessionMBean
A core session maintains the currently active artifacts for all data spaces. A change session maintains the modifications associated with one or more data spaces.
Field Summary | |
---|---|
static java.lang.String |
NAME_PREFIX
|
Method Summary | |
---|---|
void |
changeOwner()
Sets the owner of this session to the current user. |
void |
deploy(DeploymentUnit deploymentUnit,
DeploymentOptions deploymentOptions)
Models the import of a set of changes in an existing data space during this session. |
void |
export(java.lang.String dataSpaceName,
java.lang.String jarFilePath,
ExportOptions exportOptions)
Models the export of the definition and optionally also the configuration artifacts in a data space in this session to a jar file. |
javax.management.ObjectName |
getAdministrationService(java.lang.String dataSpaceName)
|
javax.management.ObjectName |
getMetadataService(java.lang.String dataSpaceName)
|
java.lang.String |
getOwner()
|
javax.management.ObjectName |
getRuntimeService(java.lang.String dataSpaceName)
Returns the object name for the RuntimeServiceMBean for the dataspace. |
DataSpaceVersion |
getVersion(java.lang.String dataSpaceName)
|
DeploymentUnit.ContentType |
importJar(java.lang.String dataSpaceName,
java.lang.String jarFilePath,
DeploymentOptions deploymentOptions)
Models the import of a set of changes in the specified data space during this session. |
Field Detail |
---|
static final java.lang.String NAME_PREFIX
Method Detail |
---|
DeploymentUnit.ContentType importJar(java.lang.String dataSpaceName, java.lang.String jarFilePath, DeploymentOptions deploymentOptions) throws java.lang.Exception
This method is not applicable to the core session.
dataSpaceName
- The name of the data space to import into.
Must exist and may not be null.jarFilePath
- The path to the jar file on the admin server's file system.
May not be null and the file must exist.deploymentOptions
- See DeploymentOptions
. null denotes the default options.
May not be null.
java.lang.Exception
- The ManagementException instances thrown by this method have one
of the following error codes:
for details about how you can set various flags while importing a jar.
,
This method constructs an
in memory deployment unit and then delegates to that method.
void deploy(DeploymentUnit deploymentUnit, DeploymentOptions deploymentOptions) throws java.lang.Exception
If the deployment unit contains administrative artifacts, the following constraints apply:
This operation involves the following stages:
This method is not applicable to the core session.
deploymentUnit
- A unit capturing the set of artifact changes
to be applied on a particular data space in this session.
May not be null.deploymentOptions
- See DeploymentOptions
. null denotes the default options.
java.lang.Exception
- The ManagementException instances thrown by this method have one
of the following error codes:
DeploymentUnit
void export(java.lang.String dataSpaceName, java.lang.String jarFilePath, ExportOptions exportOptions) throws java.lang.Exception
dataSpaceName
- The name of the data space to extract the resources from.
May not be null and must exist.jarFilePath
- The location of the generated jar file.
May not be null.exportOptions
-
java.lang.Exception
- If the above conditions are not met, or the jar file cannot be generated.for details about all the flags that you can set while exporting a dataspace
void changeOwner() throws java.lang.Exception
NOTE: This method is primarily meant to be used when an inactive, long-standing session prevents other administrators from making changes. Use of this method to perform session changes when a session is active and application of other changes are pending will result in non-deterministic behavior.
This method is not applicable to the core session.
java.lang.Exception
- If problems are encountered while associating the session
with the current user (e.g. because of security permissions
or file I/O).java.lang.String getOwner() throws java.lang.Exception
This method is not applicable to the core session.
java.lang.Exception
- If problems are encountered while retrieving the owner
of the current session (e.g. because of security permissions
or file I/O).javax.management.ObjectName getAdministrationService(java.lang.String dataSpaceName) throws java.lang.Exception
dataSpaceName
- The name of a data space.
Must exist and not be null.
java.lang.Exception
- If the dataspace does not exist.javax.management.ObjectName getMetadataService(java.lang.String dataSpaceName) throws java.lang.Exception
dataSpaceName
- The name of a data space.
Must exist and not be null.
java.lang.Exception
- If the dataspace does not exist.javax.management.ObjectName getRuntimeService(java.lang.String dataSpaceName) throws java.lang.Exception
This method is applicable only to the core session.
dataSpaceName
- The name of a data space.
Must exist and not be null.
java.lang.Exception
- If the dataspace does not exist.
java.lang.UnsupportedOperationException
- If this method is called on any session other
than the core session.DataSpaceVersion getVersion(java.lang.String dataSpaceName) throws java.lang.Exception
dataSpaceName
- The name of a data space. May not be null.
java.lang.Exception
- In the specified data space does not exist.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |