|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeploymentServiceMBean
The deployment service MBean allows administrative tools to manage service assembly deployments. The tasks supported are:
Field Summary | |
---|---|
static String |
SHUTDOWN
The service assembly has been deployed, or shutdown |
static String |
STARTED
The service assembly is started. |
static String |
STOPPED
The service assembly is stopped. |
Method Summary | |
---|---|
boolean |
canDeployToComponent(String componentName)
Returns true if the the given component accepts the
deployment of service units. |
String |
deploy(String saZipURL)
Deploys the given Service Assembly to the JBI environment. |
String[] |
getComponentsForDeployedServiceAssembly(String saName)
Returns an array of component names, where for each the given assembly contains a service unit for the component. |
String[] |
getDeployedServiceAssemblies()
Returns a list of Service Assemblies deployed to the JBI environment. |
String[] |
getDeployedServiceAssembliesForComponent(String componentName)
Returns an array of Service Assembly names, where each assembly contains Service Units for the given component. |
String[] |
getDeployedServiceUnitList(String componentName)
Returns an array of service unit names that are currently deployed to the named component. |
String |
getServiceAssemblyDescriptor(String saName)
Returns the deployment descriptor of the Service Assembly that was deployed to the JBI enviroment, serialized to a String . |
String |
getState(String serviceAssemblyName)
Get the running state of a service assembly. |
boolean |
isDeployedServiceUnit(String componentName,
String suName)
Queries if the named Service Unit is currently deployed to the named component. |
String |
shutDown(String serviceAssemblyName)
Shut down the service assembly. |
String |
start(String serviceAssemblyName)
Start the service assembly. |
String |
stop(String serviceAssemblyName)
Stop the service assembly. |
String |
undeploy(String saName)
Undeploys the given Service Assembly from the JBI environment. |
Field Detail |
---|
static final String STARTED
static final String SHUTDOWN
static final String STOPPED
Method Detail |
---|
String deploy(String saZipURL) throws Exception
Note that the implementation must not automatically start the service
assembly after deployment; it must wait for the start(String)
method to be invoked by the administrative tool.
saZipURL
- String containing the location URL of the
Service Assembly ZIP file; must be non-null, non-empty, and a
legal URL
Exception
- if complete deployment failsString undeploy(String saName) throws Exception
saName
- name of the Service Assembly that is to be
undeployed; must be non-null and non-empty
Exception
- if compelete undeployment failsString[] getDeployedServiceUnitList(String componentName) throws Exception
componentName
- the name of the component to query; must be
non-null and non-empty
Exception
- if a processing error occursString[] getDeployedServiceAssemblies() throws Exception
Exception
- if a processing error occursString getServiceAssemblyDescriptor(String saName) throws Exception
String
.
saName
- name of the service assembly to be queried;
must be non-null and non-empty
Exception
- if a processing error occursString[] getDeployedServiceAssembliesForComponent(String componentName) throws Exception
componentName
- name of the component to query; must be non-null
and non-empty
Exception
- if a processing error occursString[] getComponentsForDeployedServiceAssembly(String saName) throws Exception
saName
- the service assembly to be queried; must be
non-null and non-empty
Exception
- if a processing error occursboolean isDeployedServiceUnit(String componentName, String suName) throws Exception
componentName
- name of the component to query; must be non-null
and non-emptysuName
- name of the subject service unit; must be non-null
and non-empty
true
if the named service unit is currently deployed
to the named component
Exception
boolean canDeployToComponent(String componentName)
true
if the the given component accepts the
deployment of service units. This is used by admin tools to
determine which components can be named in service assembly
deployment descriptors.
componentName
- name of the component; must be non-null and
non-empty
true
if the named component accepts deployments;
false
if the named component does not accept
deployments or it does not existString start(String serviceAssemblyName) throws Exception
STARTED
state.
serviceAssemblyName
- name of the assembly to be started; must be
non-null and non-empty
Exception
- if there is no such assembly
Exception
- if the assembly fails to startString stop(String serviceAssemblyName) throws Exception
STOPPED
state.
serviceAssemblyName
- name of the assembly to be stopped; must be
non-null and non-empty
Exception
- if there is no such assembly
Exception
- if the assembly fails to stopString shutDown(String serviceAssemblyName) throws Exception
SHUTDOWN
state.
serviceAssemblyName
- name of the assembly to be shut down; must be
non-null and non-empty
Exception
- if there is no such assembly
Exception
- if the assembly fails to shut downString getState(String serviceAssemblyName) throws Exception
SHUTDOWN
, STOPPED
, STARTED
.
serviceAssemblyName
- name of the assembly to query; must be
non-null and non-empty
SHUTDOWN
, STOPPED
, or STARTED
Exception
- if there is no such assembly
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |