public interface DeploymentMXBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE |
Modifier and Type | Method and Description |
---|---|
ApplicationID |
getSipServletApplicationID(SipServletServiceID serviceID)
Get the
ApplicationID corresponding to the given SLEE ServiceID . |
ApplicationID |
getSipServletApplicationID(java.lang.String appName)
Get the
ApplicationID corresponding to the given servlet application name. |
ApplicationID[] |
getSipServletApplications()
Get the SIP Servlet Applications that are deployed in the SLEE.
|
ApplicationID[] |
getSipServletApplications(java.lang.String duUrl)
Get the SIP Servlet Applications that were deployed in a DU.
|
ApplicationID |
install(java.lang.String sarUrl,
byte[] sarContent,
java.lang.String appName,
SipServletServiceID serviceID)
Installs a SIP Servlet Application archive (SAR) in the container.
|
ApplicationID |
install(java.lang.String sarUrl,
byte[] sarContent,
java.lang.String appName,
SipServletServiceID serviceID,
java.lang.String linkName)
Installs a SIP Servlet Application archive (SAR) in the container.
|
static final java.lang.String TYPE
ApplicationID install(java.lang.String sarUrl, byte[] sarContent, java.lang.String appName, SipServletServiceID serviceID) throws java.lang.NullPointerException, javax.slee.management.DeploymentException, javax.slee.management.ManagementException
sarUrl
- URL to use for the SAR deployable unit in the SLEE. Does not need to
be a real location, just needs to be a uniquely identify the DU within the SLEE.sarContent
- the contents of a SAR file in the form of a byte array.appName
- an optional servlet application name. If null
, the container will obtain it
from the SAR's deployment descriptor. Otherwise the application will be deployed using
this name, which must be used in Application Router configurations. The deployed
app name is returned in the ApplicationID
returned by this method.serviceID
- an optional ServiceID
that will be used for the deployed servlet application.
If null
, the container will generate a default ServiceID
.
The deployed ServiceID
is returned in the ApplicationID
returned by this
method.ApplicationID
containing the deployed application's name and ServiceID
java.lang.NullPointerException
- if either of the sarUrl
or sarContent
arguments is null
javax.slee.management.DeploymentException
javax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.ApplicationID install(java.lang.String sarUrl, byte[] sarContent, java.lang.String appName, SipServletServiceID serviceID, java.lang.String linkName) throws java.lang.NullPointerException, javax.slee.management.DeploymentException, javax.slee.management.ManagementException
sarUrl
- URL to use for the SAR deployable unit in the SLEE. Does not need to
be a real location, just needs to be a uniquely identify the DU within the SLEE.sarContent
- the contents of a SAR file in the form of a byte array.appName
- an optional servlet application name. If null
, the container will obtain it
from the SAR's deployment descriptor. Otherwise the application will be deployed using
this name, which must be used in Application Router configurations. The deployed
app name is returned in the ApplicationID
returned by this method.serviceID
- an optional ServiceID
that will be used for the deployed servlet application.
If null
, the container will generate a default ServiceID
.
The deployed ServiceID
is returned in the ApplicationID
returned by this
method.linkName
- an optional RA entity link name, specifying the RA entity binding for the deployed application.
If null
or empty, one of the existing link names for this RA entity will be used.
Otherwise, the name must match an existing link name that is bound to this RA entity.
If this RA entity is not bound to any link names, a DeploymentException
is thrown.ApplicationID
containing the deployed application's name and ServiceID
java.lang.NullPointerException
- if either of the sarUrl
or sarContent
arguments is null
javax.slee.management.DeploymentException
- if this RA entity is not bound to any link names, or if the requested link name
is not bound to this RA entityjavax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.ApplicationID[] getSipServletApplications(java.lang.String duUrl) throws java.lang.NullPointerException, javax.slee.management.UnrecognizedDeployableUnitException, javax.slee.management.ManagementException
ApplicationNameRefManagementMXBean
. All services deployed using install(String, byte[], String, SipServletServiceID)
are automatically mapped to a servlet application name, but other services may be mapped manually
as well.duUrl
- the URL of the SLEE or SAR deployable unit.ApplicationID
, one for each servlet application, or an empty array if none
are found. The ordering of the array elements is undefined.java.lang.NullPointerException
- if duURL is nulljavax.slee.management.UnrecognizedDeployableUnitException
- if duURL is not installed in the SLEEjavax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.ApplicationID[] getSipServletApplications() throws javax.slee.management.ManagementException
install(String, byte[], String, SipServletServiceID)
, or any services that have an
application name ref with the ApplicationNameRefManagementMXBean
.ApplicationID
objects, empty if no servlet applications are deployed.
The ordering of the array elements is undefined.javax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.ApplicationID getSipServletApplicationID(java.lang.String appName) throws java.lang.NullPointerException, javax.slee.management.ManagementException
ApplicationID
corresponding to the given servlet application name.appName
- a servlet application nameApplicationID
, or null
if not found.java.lang.NullPointerException
- if appName
is null
javax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.ApplicationID getSipServletApplicationID(SipServletServiceID serviceID) throws java.lang.NullPointerException, javax.slee.management.ManagementException
ApplicationID
corresponding to the given SLEE ServiceID
.serviceID
- a SLEE ServiceID
.ApplicationID
, or null
if not found.java.lang.NullPointerException
- if serviceID
is null
javax.slee.management.ManagementException
- if the operation could not be completed due to a system-level failure.