View Javadoc

1   /**
2    *
3    *  Licensed to the Apache Software Foundation (ASF) under one or more
4    *  contributor license agreements.  See the NOTICE file distributed with
5    *  this work for additional information regarding copyright ownership.
6    *  The ASF licenses this file to You under the Apache License, Version 2.0
7    *  (the "License"); you may not use this file except in compliance with
8    *  the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing, software
13   *  distributed under the License is distributed on an "AS IS" BASIS,
14   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *  See the License for the specific language governing permissions and
16   *  limitations under the License.
17   */
18  package org.apache.geronimo.j2ee.deployment;
19  
20  import org.apache.geronimo.common.DeploymentException;
21  import org.apache.geronimo.gbean.GBeanData;
22  import org.apache.geronimo.deployment.DeploymentContext;
23  import org.apache.geronimo.kernel.repository.Environment;
24  import org.apache.xmlbeans.XmlObject;
25  
26  import java.util.jar.JarFile;
27  import java.util.Map;
28  
29  /**
30   * @version $Rev: 470597 $ $Date: 2006-11-02 15:30:55 -0800 (Thu, 02 Nov 2006) $
31   */
32  public interface WebServiceBuilder {
33  
34     /**
35      * Introspects on the module file to locate web service for deployment.
36      *
37      * @param moduleFile J2EE module
38      * @param isEJB is this an EJB archive?
39      * @param correctedPortLocations mapping between port locations and paths.
40      * @param environment
41      * @return Mapping of servlet names to port information, or an
42      * empty map if no web services found.  Port information is opaque
43      * to all except the WebServiceBuilder itself.
44      * @throws DeploymentException if error encountered while introspecting the module.
45      */
46     Map findWebServices(JarFile moduleFile, boolean isEJB, Map correctedPortLocations, Environment environment) throws DeploymentException;
47  
48      //obviously these need the deployment descriptors, but I'm not sure in what form yet.
49      /**
50       * configure the supplied GBeanData to implement the POJO web service described in the deployment descriptor.
51       * The GBeanData will be for a ServletHolder like gbean that is adapted to holding a ws stack that talks to a
52       * POJO web service.  The web deployer is responsible for filling in the standard servlet info such as init params.
53       * @param targetGBean
54       * @param module
55       * @param portInfo
56       * @param seiClassName
57       * @param context
58       * @throws DeploymentException
59       */
60      void configurePOJO(GBeanData targetGBean, Module module, Object portInfo, String seiClassName, DeploymentContext context) throws DeploymentException;
61  
62      /**
63       * configure the supplied EJBContainer gbeandata to implement the ejb web service described in the deployment descriptor
64       * N.B. this method is a complete guess and should be replaced by something useable right away!
65       * @param targetGBean
66       * @param moduleFile
67       * @param classLoader
68       * @throws DeploymentException
69       */
70      void configureEJB(GBeanData targetGBean, JarFile moduleFile, Object portInfo, ClassLoader classLoader) throws DeploymentException;
71  
72  }