Source code: de/danet/an/staffmgmt/resource/StaffMgmtResourceManagementServiceFactory.java

   /*
    * This file is part of the WfMCore/WfMOpen project.
    * Copyright (C) 2001-2003 Danet GmbH (www.danet.de), GS-AN.
    * All rights reserved.
    *
    * This program is free software; you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
    * the Free Software Foundation; either version 2 of the License, or
    * (at your option) any later version.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   *
   * $Id: StaffMgmtResourceManagementServiceFactory.java,v 1.16 2003/06/27 08:51:47 lipp Exp $
   *
   * $Log: StaffMgmtResourceManagementServiceFactory.java,v $
   * Revision 1.16  2003/06/27 08:51:47  lipp
   * Fixed copyright/license information.
   *
   * Revision 1.15  2003/05/23 15:42:41  lipp
   * Fixed deployment unit dependencies.
   *
   * Revision 1.14  2003/04/25 14:50:59  lipp
   * Fixed javadoc errors and warnings.
   *
   * Revision 1.13  2002/12/19 21:37:43  lipp
   * Reorganized interfaces.
   *
   * Revision 1.12  2002/06/27 10:54:17  lipp
   * Moved attributes to base class.
   *
   * Revision 1.11  2002/06/24 17:29:12  lipp
   * Fixed resource path.
   *
   * Revision 1.10  2002/01/09 11:53:01  lipp
   * Clarified documentation.
   *
   * Revision 1.9  2001/12/18 13:22:28  robert
   * JavaDoc
   *
   * Revision 1.8  2001/12/17 19:56:03  lipp
   * Implementation of equality checking improved.
   *
   * Revision 1.7  2001/12/17 12:14:04  lipp
   * Adapted to configurable ResourceManagement/AssignmentServices.
   *
   * Revision 1.6  2001/12/17 10:52:41  lipp
   * Merged changes.
   *
   * Revision 1.5  2001/12/17 10:14:54  robert
   * User preferences service implemented.
   *
   * Revision 1.4  2001/12/17 08:44:19  lipp
   * Added configurable resource assignment service.
   *
   * Revision 1.3  2001/12/13 16:19:59  robert
   * Temporary test method for resource management service.
   *
   * Revision 1.2  2001/12/06 14:07:15  robert
   * removes newInstance
   *
   * Revision 1.1  2001/12/05 13:49:28  robert
   * initial version
   *
   * Revision 1.2  2001/11/30 11:43:26  lipp
   * javadoc fixes.
   *
   * Revision 1.1  2001/11/27 18:26:42  lipp
   * Resource handling redesigned.
   *
   */
  package de.danet.an.staffmgmt.resource;
  
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.Serializable;
  
  import java.util.Properties;
  
  import java.rmi.RemoteException;
  
  import javax.ejb.CreateException;
  import javax.naming.NamingException;
  
  import de.danet.an.util.EJBUtil;
  
  import de.danet.an.staffmgmt.domain.StaffDirectory;
  import de.danet.an.staffmgmt.ejbs.StaffDirectoryHome;
  import de.danet.an.workflow.spis.rms.FactoryConfigurationError;
  import de.danet.an.workflow.spis.rms.ResourceManagementService;
  import de.danet.an.workflow.spis.rms.ResourceManagementServiceFactory;
  
  /**
  * Implements the factory API that enables a workflow component to
  * obtain a workflow resource management service.
  *
  * Usage of this class as service factory requires an additional
  * configuration parameter. The service factory implementation needs to
  * connect to the staff management EJBs. In order to do so, it needs a
  * JNDI name to look up the home interface. As JNDI names must be changeable
  * by the application deployer, the name can't be hard coded.<P>
  *
  * This factory therefore uses the following ordered lookup procedure 
  * to determine the JNDI name of the staff management EJB home interface:
  * <ul>
  *   <li>Look for a name in
  *   <code>java:comp/env/de.danet.an.staffmgmt.resource.staffDirectory</code>. 
  *     The configuration for
  *     <code>StaffMgmtResourceManagementServiceFactory</code> using 
  *     this mechanism thus looks like:
  * <PRE>&lt;env-entry&gt;
  *   &lt;description&gt;Configure the chosen factory&lt;/description&gt;
  *   &lt;env-entry-name&gt;de.danet.an.staffmgmt.resource.staffDirectory&lt;/env-entry-name&gt;
  *   &lt;env-entry-type&gt;java.lang.String&lt;/env-entry-type&gt;
  *   &lt;env-entry-value&gt;<i>JNDI name of staff directory EJB home</i>&lt;/env-entry-value&gt;
  * &lt;/env-entry&gt;</PRE>
  *     Note that this environment entry must be inserted in the
  *     <code>ejb-jar.xml</code> or <code>web.xml</code> for every EJB
  *     resp. servlet that calls the
  *     {@link de.danet.an.workflow.spis.rms.ResourceManagementServiceFactory#newInstance
  *     <code>newInstance</code>} method of 
  *     <code>ResourceManagementServiceFactory</code>.</li>
  *
  *   <li>Find the application resource file 
  *     <code>de.danet.an.staffmgmt-rms.properties</code>
  *     and look for an entry "<code>staffDirectory
  *     = <i>JNDI name of assignment service EJB home</i></code>".</li>
  *
  *   <li>Use the fallback JNDI name
  *     <code>de.danet.an.staffmgmt.StaffDirectory</code>.</li>
  * </ul>
  */
 public class StaffMgmtResourceManagementServiceFactory 
     extends ResourceManagementServiceFactory implements Serializable {
     
     /** The staff directory home passed to service instances. */
     private StaffDirectory sd = null;
 
     /** The home interface name of the staff management service. */
     private static String homeName = null;
 
     /**
      * Constructor, called by the {@link
      * ResourceManagementServiceFactory#newInstance
      * <code>newInstance</code>} method of
      * <code>ResourceManagementServiceFactory</code>.
      * @throws FactoryConfigurationError if the required resources cannot 
      * be found.
      */
     public StaffMgmtResourceManagementServiceFactory ()
   throws FactoryConfigurationError {
   // get home name
   if (homeName == null) {
       homeName = findHomeName();
   }
   // Lookup staff management service home JNDI name in JNDI
   try {
       StaffDirectoryHome sdh = (StaffDirectoryHome)EJBUtil.lookupEJBHome
     (StaffDirectoryHome.class, homeName);
       sd = sdh.create ();
   } catch (NamingException nex) {
       throw new FactoryConfigurationError 
     ("StaffDirectory home not bound: " + nex.getMessage());
   } catch (CreateException cex) {
       throw new FactoryConfigurationError 
     ("Cannot create StaffDirectoryEJB: " + cex.getMessage());
   } catch (RemoteException rex) {
       throw new FactoryConfigurationError 
     ("Cannot create StaffDirectoryEJB: " + rex.getMessage());
   }
     }
 
     /**
      * Tries to find the name of the staff management service home interface
      * as described {@link StaffMgmtResourceManagementServiceFactory
      * for the class}.
      */
     private static String findHomeName () {
   String home = null;
   try {
       home = (String)EJBUtil.lookupJNDIEntry
     ("java:comp/env/de.danet.an.staffmgmt.resource"
      + ".staffDirectory");
       return home;
   } catch (NamingException ne) {
       // Name not defined
   }
   // try properties
   try {
       InputStream is = StaffMgmtResourceManagementServiceFactory.class
     .getResourceAsStream
     ("/de.danet.an.staffmgmt-rms.properties");
       if (is != null) {
     Properties props = new Properties();
     props.load (is);
     home = props.getProperty("staffDirectory");
     if (home != null) {
         return home;
     }
       }
   } catch (IOException ioe) {
   } 
   // fallback
   return "de.danet.an.staffmgmt.StaffDirectory";
     }
     
     /* Comment copied from interface. */
     public ResourceManagementService newResourceManagementService ()
   throws FactoryConfigurationError {
   if (getResourceAssignmentService() == null) {
       throw new FactoryConfigurationError
     ("Resource assignment service not configured.");
   }
   return new StaffMgmtResourceManagementService
       (sd, getResourceAssignmentService());
     }
 
     /**
      * Two resource management service factories are equal if they are
      * identically configured.
      *
      * @param obj the factory to compare with.
      * @return <code>true</code> if the objects are equal.
      */
     public boolean equals (Object obj) {
   StaffMgmtResourceManagementServiceFactory other
       = (StaffMgmtResourceManagementServiceFactory)obj;
   return (getResourceAssignmentService() 
     .equals (other.getResourceAssignmentService()));
     }
 
     /**
      * Generate a hash code.
      *
      * @return the hash code.
      */
     public int hashCode () {
   return homeName.hashCode();
     }
 }