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.webservices.client.interfaces;
18  
19  import org.apache.geronimo.ews.ws4j2ee.context.webservices.server.interfaces.WSCFHandler;
20  
21  import javax.xml.namespace.QName;
22  
23  /***
24   * This class represent the service-ref element as define by the j2ee webserice
25   * client schema. this elemet may in the web.xml or ejb-jar.xml.
26   *
27   * @author Srinath Perera(hemapani@opensource.lk)
28   */
29  public interface ServiceReferanceContext {
30      /***
31       * Service type: The service-interface element defines the
32       * fully qualified name of the JAXRPC Service Interface class
33       * returned by the JNDI lookup.
34       */
35      public void setServiceInterface(String string);
36  
37      public String getServiceInterface();
38  
39      /***
40       * WSDL definition (optional). The wsdl-file element specifies a
41       * location of the WSDL description of the service. The location
42       * is relative to the root of the module. The WSDL description may
43       * be a partial WSDL, but must at least include the portType and
44       * binding elements. The WSDL description provided by the developer
45       * is considered a template that must be preserved by the
46       * assembly/deployment process. In other words, the WSDL description contains
47       * a declaration of the application?s dependency on portTypes, bindings, and QNames.
48       * The WSDL document must be fully specified, including the service and port elements,
49       * if the application is dependent on port QNames
50       * (e.g. uses the Service.getPort(QName,Class) method). The developer must
51       * specify the wsdl-file if any of the Service methods declared
52       * in section 4.2.2.4 or 4.2.2.5 are used
53       */
54      public String getWsdlFile();
55  
56      public void setWsdlFile(String string);
57  
58      /***
59       * Service Port. If the specified wsdl-file has more than
60       * one service element, the developer must specify the service-qname.
61       */
62      public void setServcieQName(QName name);
63  
64      public QName getServcieQName();
65  
66      /***
67       * JAX-RPC Mapping. The developer specifies the correlation
68       * of the WSDL definition to the interfaces using the jaxrpc-mapping-file element.
69       * The location is relative to the root of the module. The same mapping file must
70       * be used for all interfaces associated with a wsdl-file. The developer must
71       * specify the jaxrpc-mapping-file if the wsdl-file is specified.
72       */
73      public String getJaxrpcmappingFile();
74  
75      public void setJaxrpcmappingFile(String string);
76  
77      /***
78       * Service Reference Name. This defines a logical name for the
79       * reference that is used in the client source code. It is recommended,
80       * but not required that the name begin with service/*.
81       */
82      public String getServicerefName();
83  
84      public void setServicerefName(String string);
85  
86      public WSCFHandler[] getHandlers();
87  
88      public void addHandler(WSCFHandler handler);
89  }