View Javadoc

1   /*
2    * Copyright 2001-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.geronimo.ews.ws4j2ee.context;
18  
19  import org.apache.geronimo.ews.ws4j2ee.context.webservices.server.interfaces.WSCFHandler;
20  
21  import java.util.ArrayList;
22  
23  /***
24   * <p>This class interface the importent information about the webservice
25   * under consideration. E.g. the webservice DD may have one or more
26   * WebserviceDescriptions, WSDLportType's WSDLBindings ect. This type of object
27   * provide acsess to the instance's under the consideration. It is recomended to
28   * acscess these instances over MiscInfo snd It will make sure everybody is
29   * acsessing same port type ect.
30   *
31   * @author Srinath Perera(hemapani@opensource.lk)
32   */
33  public interface MiscInfo {
34      /***
35       * the root diretory for the output
36       *
37       * @param outputpath
38       */
39      public void setOutputPath(String outputpath);
40  
41      public String getOutPutPath();
42  
43      /***
44       * @return ArrayList of SEIOperations
45       */
46      public ArrayList getSEIOperations();
47  
48      public void setSEIOperations(SEIOperation operation);
49  
50      public void setSEIExists(boolean seiExists);
51  
52      public boolean isSEIExists();
53  
54      /***
55       * Names of the classes corresponding to SEI, Implementation bean and the
56       * web service and the sessionless EJB.
57       *
58       * @return
59       */
60      public String getJaxrpcSEI();
61  
62      public void setJaxrpcSEI(String string);
63  
64      public String getJ2eeComponetLink();
65  
66      public void setJ2eeComponetLink(String string);
67  
68      /***
69       * Validate the Content of the Misc Info
70       */
71      public void validate();
72  
73      public boolean isVerbose();
74  
75      public void setVerbose(boolean b);
76  
77      /***
78       * The jaxrpc-file specifies a location of the WSDL description of
79       * a set of Web services. The location is relative to the root of the module
80       * and must be specified by the developer.
81       */
82      public InputOutputFile getJaxrpcfile();
83  
84      public void setJaxrpcfile(InputOutputFile string);
85  
86      /***
87       * The wsdl-file specifies a location of the WSDL description of
88       * a set of Web services. The location is relative to the root of the module
89       * and must be specified by the developer.
90       */
91      public InputOutputFile getWsdlFile();
92  
93      public void setWsdlFile(InputOutputFile string);
94  
95      /***
96       * <p>One of the following values and specify how the ejb based web service
97       * Obtain the referance to the sessionless web service</p>
98       * public static final String USE_REMOTE ="use-remote";
99       * public static final String USE_LOCAL =  "use-local";
100      * public static final String USE_INTERNALS = "use-internals";
101      * public static final String USE_LOCAL_AND_REMOTE = "use-local-remote";
102      */
103     public String getImplStyle();
104 
105     public void setImplStyle(String string);
106 
107     /***
108      * <p>One of the following values and specify what is the j2ee container the
109      * implementation is based on.</p>
110      * public static final String JBOSS_CONTAINER = "jboss";
111      * public static final String JONAS_CONTAINER = "jonas";
112      * public static final String GERONIMO_CONTAINER = "geronimo";
113      */
114     public String getTargetJ2EEContainer();
115 
116     public void setTargetJ2EEContainer(String string);
117 
118     /***
119      * Say the implementation of the webservice is based on the sessionless web service
120      * or a java class.
121      *
122      * @return
123      */
124     public boolean isImplwithEJB();
125 
126     public void setImplwithEJB(boolean b);
127 
128     /***
129      * Say wheather the Implementation bean is avalible when gererating without wsdl.
130      * For other cases it does not make sense.
131      *
132      * @return
133      */
134     public boolean isImplAvalible();
135 
136     public void setImplAvalible(boolean b);
137 
138     /***
139      * The webservices.xml specifies a location of the WSDL description of
140      * a set of Web services. The location is relative to the root of the module
141      * and must be specified by the developer.
142      */
143     public InputOutputFile getWsconffile();
144 
145     public void setWsconffile(InputOutputFile string);
146 
147     /***
148      * Handlers. A developer may optionally specify handlers associated with the
149      * service-ref using the handler element.
150      */
151     public WSCFHandler[] getHandlers();
152 
153     public void setHandlers(WSCFHandler[] handlers);
154 
155     /***
156      * the class path elemnts added via jar,war,ear files this is a Vector of
157      * java.io.File
158      */
159     public ArrayList getClasspathElements();
160 
161     public void setClassPathElements(ArrayList classpathelements);
162 
163     public ClassLoader getClassloader();
164 
165     public void setClassloader(ClassLoader loader);
166 
167     public boolean isCompile();
168 
169     public void setCompile(boolean compile);
170     
171     public Object getProprty(Object key);
172 }