|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DomainService
This is the top level service entry for an ALDSP domain. It may be used to manage:
Method Summary | |
---|---|
void |
activateDataSpace(java.lang.String dataSpaceName,
ActivationOptions options)
Activates the client request handlers for the specified data space in test or full operation mode. |
void |
activateDeploymentSession(java.lang.String sessionName)
Activates the specified user-defined session. |
void |
createDataSpace(java.lang.String dataSpaceName,
java.util.Set<DeploymentTarget> deploymentTarget)
Creates a new data space on the specified set of deployment targets. |
javax.management.ObjectName |
createDeploymentSession(java.lang.String sessionName)
Creates a new user-defined, deployment session in this domain. |
void |
deactivateDataSpace(java.lang.String dataSpaceName,
DeactivationOptions options)
Deactivates the client request handlers for the specified dataspace. |
void |
deleteDataSpace(java.lang.String dataSpaceName)
Deletes a data space. |
void |
discardDeploymentSession(java.lang.String sessionName)
Discards the specified user-defined session. |
javax.management.ObjectName |
getCoreSession()
|
java.util.Map<java.lang.String,javax.management.ObjectName> |
getCurrentDeploymentSessions()
|
java.util.Set<DeploymentTarget> |
getDeployedTargets(java.lang.String dataSpaceName)
|
java.util.Map<DeploymentTarget,DeploymentStatus> |
getDeploymentStatus(java.lang.String dataspaceName)
|
java.util.Set<DeploymentTarget> |
getTargets()
|
java.util.Set<java.lang.String> |
listDataSpaceNames()
|
java.util.Set<java.lang.String> |
listDeploymentSessionNames()
|
void |
retargetDataSpace(java.lang.String dataSpaceName,
java.util.Set<DeploymentTarget> deploymentTargets)
Deployed targets for the dataspace are changed to the passed set. |
Method Detail |
---|
void createDataSpace(java.lang.String dataSpaceName, java.util.Set<DeploymentTarget> deploymentTarget) throws java.lang.Exception
Creation of a data space involves:
All of the above tasks are executed as an atomic operation: If any of the tasks fails, the effects of the previous tasks are reverted (or compensated) and the operation is a no-op.
The registration and initialization of data space administration request handlers on the admin server takes place on-demand (lazily).
Data space creation occurs within a system-defined session provided that no other sessions are present.
While the data space repository is created and populated on all servers in the domain, the deployment of client request handlers is determined based on the set of deployment targets passed to the call. If the set of deployment targets is null, the client request handlers are deployed on all individual server instances in the domain. The client request handlers are not activated until activateDataSpace() is called. If the set is empty or contains targets not found in the domain, an exception indicating the problem is thrown.
dataSpaceName
- The name of data space to be created.
May not be null.
deploymentTarget
- A set of deployment targets.
May be null but not empty.
java.lang.Exception
- The ManagementException instances thrown by this method have one
of the following error codes:
void deleteDataSpace(java.lang.String dataSpaceName) throws java.lang.Exception
Deletion of a data space involves:
All of the above tasks are executed as an atomic operation: If any of the tasks fails, the effects of the previous tasks are reverted (or compensated) and the operation is a no-op.
Data space deletion occurs within a system-defined session provided that no other sessions are present.
In order for a data space to be deleted, it must first have been deactivated.
dataSpaceName
- The name of data space to be deleted. May not be null.
java.lang.Exception
- The ManagementException instances thrown by this method have one
of the following error codes:
void activateDataSpace(java.lang.String dataSpaceName, ActivationOptions options) throws java.lang.Exception
In order for a data space to be activated in a certain mode, it must have been created or activated in a different mode. An Exception is thrown if a dataspace in CLIENT mode is activated to ADMIN mode. If the intention is to bring the state down to ADMIN, use deactivateDataSpace(dataspaceName, ADMIN).
dataSpaceName
- The name of data space to be activated. May not be null.
options
- Either ADMIN or CLIENT. If null it defaults to CLIENT.
java.lang.Exception
void deactivateDataSpace(java.lang.String dataSpaceName, DeactivationOptions options) throws java.lang.Exception
In order for a data space to be deactivated, it must have been activated.
dataSpaceName
- The name of data space to be deactivated. May not be null.
options
- Either ADMIN or DOWN. If null it defaults to DOWN.
java.lang.Exception
void retargetDataSpace(java.lang.String dataSpaceName, java.util.Set<DeploymentTarget> deploymentTargets) throws java.lang.Exception
dataSpaceName
- The name of data space to be retargeted. May not be null.
deploymentTargets
- May not be null or empty.
java.lang.Exception
java.util.Map<DeploymentTarget,DeploymentStatus> getDeploymentStatus(java.lang.String dataspaceName) throws java.lang.Exception
dataspaceName
- The name of a data space. May not be null.
May be empty but not null.
java.lang.Exception
- If the deployment status cannot be determined.DeploymentStatus
java.util.Set<DeploymentTarget> getDeployedTargets(java.lang.String dataSpaceName) throws java.lang.Exception
dataSpaceName
- The name of a data space. May not be null.
May be empty but not null.
java.lang.Exception
- If the targets cannot be determined.java.util.Set<DeploymentTarget> getTargets() throws java.lang.Exception
May be empty but not null.
java.lang.Exception
- If the targets cannot be determined.java.util.Set<java.lang.String> listDataSpaceNames() throws java.lang.Exception
May be empty but not null.
java.lang.Exception
javax.management.ObjectName createDeploymentSession(java.lang.String sessionName) throws java.lang.Exception
There can be at most one active session at a time.
sessionName
- The session name. May not be null.
java.lang.Exception
- If:
void activateDeploymentSession(java.lang.String sessionName) throws java.lang.Exception
sessionName
- May not be null.
java.lang.Exception
void discardDeploymentSession(java.lang.String sessionName) throws java.lang.Exception
sessionName
- May not be null.
java.lang.Exception
java.util.Map<java.lang.String,javax.management.ObjectName> getCurrentDeploymentSessions()
May be empty but not null.
javax.management.ObjectName getCoreSession()
java.lang.Exception
java.util.Set<java.lang.String> listDeploymentSessionNames()
May be empty but not null.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |