ServiceUnitManager.deploy method signature

The preferred method of returning an error from ServiceUnitManager.deploy() is to use the method return value, with task-result (and other fields in the XML structure) set appropriately. deploy() can throw a DeploymentException, in which case the JBI implementation hosting the component will convert the exception message to a suitable XML string, for return to the deployment MBean (and subsequently the admin tool).

The preferred method is to use the XML String return value; this allows the component to return a parameterized message string that can be localized at the admin tool, as well as error context information.

The use of DeploymentException is a hold-over from an earlier version of the JBI specification, while it was being developed. It was, previously, the only way SUM.deploy() implementations could signal a failure, and a number of components were developed that relied on that. When the XML String return value was introduced, the DeploymentException was retained to make migration of those existing components easier. Strictly speaking, Deployment exception should have been removed before JBI 1.0 was released, but such changes were not deemed important enough to slip JBI 1.0 from its original schedule. Again, either technique for indicating failure will work.

RonTen-Hovea at 2007-7-8 1:33:17 >