[jboss-cvs] contrib/varia/src/main/org/jboss/services/deployment ...

[Peter J. <pet...@un...>]

  User: peterj  
  Date: 06/04/04 18:42:25

  Modified:    varia/src/main/org/jboss/services/deployment 
                        DeploymentServiceMBean.java
  Log:
  JBAS-2580
  Added extra javadoc to explain the parameters to the updateDatasource method since how
  to get all of the property values for an existing data source is not obvious.
  
  Revision  Changes    Path
  1.9       +32 -2     contrib/varia/src/main/org/jboss/services/deployment/DeploymentServiceMBean.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: DeploymentServiceMBean.java
  ===================================================================
  RCS file: /cvsroot/jboss/contrib/varia/src/main/org/jboss/services/deployment/DeploymentServiceMBean.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -b -r1.8 -r1.9
  --- DeploymentServiceMBean.java	20 Mar 2006 23:34:15 -0000	1.8
  +++ DeploymentServiceMBean.java	4 Apr 2006 22:42:24 -0000	1.9
  @@ -33,7 +33,7 @@
    *
    * @author  <a href="mailto:dim...@jb...">Dimitris Andreadis</a>
    * @author  <a href="mailto:pet...@un...">Peter Johnson</a>
  - * @version $Revision: 1.8 $
  + * @version $Revision: 1.9 $
    */
   public interface DeploymentServiceMBean extends ListenerServiceMBean
   {
  @@ -115,10 +115,32 @@
       * a new data source or updating an existing data source can be the same, and
       * only the code that makes the deployment service call needs to differentiate
       * between calling createModule and updateDataSource.
  +    * <p>
  +    * Before updating a data source, you will need to gather the properties for the
  +    * existing data source.  The properties can be found in the following MBeans
  +    * (where XXX is the data source jndi name, and YYY corresponds to the transaction
  +    * type: NoTxCM, LocalTxCM, XATxCM):
  +    * <ul>
  +    * <li>jboss.jca:name=XXX,service=DataSourceBinding</li>
  +    * <li>jboss.jca:name=XXX,service=YYY</li>
  +    * <li>jboss.jca:name=XXX,service=ManagedConnectionFactory</li>
  +    * <li>jboss.jca:name=XXX,service=ManagedConnectionPool</li>
  +    * <li>jboss.jdbc:datasource=XXX,service=metadata</li>
  +    * </ul> 
  +    * The service=metadata MBean provides the type-mapping, which should be provided
  +    * as a property named "type-mapping".
  +    * <p>
  +    * To find the dependencies, get the jboss.system:service=ServiceController MBean
  +    * and invoke the listDeployed method.  Then search through the returned results for
  +    * the jboss.jca:name=XXX,service=ManagedConnectionFactory MBean.  That entry will
  +    * contain the dependecies.  Note that there will be an extra implied dependency
  +    * named "jboss.jca:service=RARDeployment,name='jboss-ZZZ-jdbc.rar'", where ZZZ
  +    * is 'local' (local and no transaction types) or 'xa'.  Ignore this
  +    * extra dependency, do not provide it when doing an update. 
       *
       * @param module The name of the model that contains the data source definition.
       * For example, the default data source, DefaultDS, is typically found in a
  -    * module named "hsqldb-ds.xml", which "hsqldb" being an acceptable abbreviation.
  +    * module named "hsqldb-ds.xml", with "hsqldb" being an acceptable abbreviation.
       * @param template The name of the template to use to update the data source.
       * You must select the proper template based on the data source transaction type.
       * Use one of the following: "local-tx-datasource", "no-tx-datasource", or
  @@ -136,6 +158,14 @@
       * and the input properties.  This method takes the same parameters
       * as the updateDataSource method.  Refer to the comments of the
       * updateDataSource method for more descriptions.
  +    * @param module The name of the model that contains the data source definition.
  +    * See the module parameter under updateDataSource for more information. 
  +    * @param template There is only one delete template: "datasource".  Optionally,
  +    * you can use the template name "datasource-remove".
  +    * @param properties The key property to provide is "jndi-name".  This property
  +    * if used to determine which data source to remove.
  +    * @return The full module name, with the suffix.
  +    * @see #updateDataSource(String, String, HashMap)
       */
      String removeDataSource(String module, String template, HashMap properties) throws Exception;