WebServiceInfo


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  package com.sun.enterprise.admin.wsmgmt.repository.spi;
24  
25  /**
26   * This is the mechanism to provide web service information for a given module.  
27   * A WebServiceInfoProvider implementation is a class that extends the 
28   * WebServiceInfoProvider abstract class. Some WebServiceInfoProvider can deal
29   * with ejb and web module. Some only deal with web modules.
30   * <br>
31   */
32  public interface WebServiceInfo {
33  
34      /**
35       * Returns the name of the WebService.
36       *
37       * @return fully qualified name of this WebService
38       */
39      public String   getName();
40  
41      /**
42       * Returns the relative URI of this endpoint.
43       *
44       * @return the uri string
45       */
46      public String   getEndpointUri();
47  
48      /**
49       * Returns the name of the application or stand alone module that has 
50       * this web service. 
51       *
52       * @return the Application Id
53       */
54      public String   getAppId();
55  
56      /**
57       * Returns true if this web service belongs to a stand alone module.
58       *
59       * @return true, if this web service belongs to a stand alone module
60       */
61      public boolean isAppStandAloneModule();
62     
63      /**
64       * Returns the module name within a EAR or null if it is a stand alone 
65       * module. 
66       *
67       * @return the bundle name
68       */
69      public String   getBundleName();
70  
71      /**
72       * Returns the implementation type of this web service.
73       *
74       * @return either "EJB" or "SERVLET"
75       */
76      public String   getServiceImplType();
77  
78      /**
79       * Returns the implementation Ejb or Servlet name of this web service.
80       *
81       * @return the Ejb or Servlet name
82       */
83      public String   getServiceImplName();
84  
85      /**
86       * Returns the implementation Ejb or Servlet class name of this web service.
87       *
88       * @return the Ejb or Servlet class name
89       */
90      public String   getServiceImplClass();
91  
92      /**
93       * Returns the WSDL file location. 
94       *
95       * @return the WSDL file location
96       */
97      public String   getWSDLFileLocation();
98       
99      /**
100      * Returns the webservices.xml file location.
101      *
102      * @return the webservices file location
103      */ 
104     public String   getWebservicesFileLocation();
105  
106     /**
107      * Returns the mapping file location. 
108      *
109      * @return the mapping file location
110      */
111     public String   getMappingFileLocation();
112 
113     /**
114      * Returns the descriptor locations. The descriptors include WSDL, 
115      * webservices.xml and mapping file. If the alt WSDL location is specified
116      * in the archive, the overridden (correct) WSDL file location is returned.
117      *
118      * @return the descriptor locations
119      */
120     public String  [] getDescriptorLocations();
121 }
122
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags