WebServiceEndpointInfo


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.appserv.management.ext.wsmgmt;
24  
25  import com.sun.appserv.management.base.MapCapable;
26  
27  /**
28   * WebServiceInfo provides information for a particular web service end point. 
29   * Information includes name, URI, descriptor locations, type of implementation
30   * (EJB or Servlet), etc.
31   *
32   * @since AppServer 9.0
33   */
34  public interface WebServiceEndpointInfo extends MapCapable {
35  
36      /**
37       * Returns the name of the WebService.
38       * Corresponds to the {@link #NAME_KEY} key.
39       *
40       * @return fully qualified name of this WebService
41       */
42      public String   getName();
43  
44      /**
45       * Returns the relative URI of this endpoint.
46       * Corresponds to the {@link #END_POINT_URI_KEY} key.
47       *
48       * @return the uri string
49       */
50      public String   getEndpointURI();
51  
52      /**
53       * Returns the name of the application or stand alone module that has 
54       * this web service. 
55       * Corresponds to the {@link #APP_ID_KEY} key.
56       *
57       * @return the Application Id
58       */
59      public String   getAppID();
60  
61      /**
62       * Returns true if this web service belongs to a stand alone module.
63       * Corresponds to the {@link #IS_STAND_ALONE_MODULE_KEY} key.
64       *
65       * @return true, if this web service belongs to a stand alone module
66       */
67      public boolean isAppStandaloneModule();
68     
69      /**
70       * Returns the module name within a EAR or null if it is a stand alone 
71       * module. 
72       * Corresponds to the {@link #BUNDLE_NAME_KEY} key.
73       *
74       * @return the bundle name
75       */
76      public String   getBundleName();
77  
78      /**
79       * Returns the implementation type of this web service.
80       * Corresponds to the {@link #SERVICE_IMPL_TYPE_KEY} key.
81       *
82       * @return either  @see #EJB_IMPL or @ see #SERVLET_IMPL
83       */
84      public String   getServiceImplType();
85  
86      /**
87       * Returns the implementation Ejb or Servlet name of this web service.
88       * Corresponds to the {@link #SERVICE_IMPL_NAME_KEY} key.
89       *
90       * @return the Ejb or Servlet name
91       */
92      public String   getServiceImplName();
93  
94      /**
95       * Returns the implementation Ejb or Servlet class name of this web service.
96       * Corresponds to the {@link #SERVICE_IMPL_CLASS_KEY} key.
97       *
98       * @return the Ejb or Servlet class name
99       */
100     public String   getServiceImplClass();
101 
102     /**
103      * Returns the WSDL file 
104      * Corresponds to the {@link #WSDL_FILE_KEY} key.
105      *
106      * @return the WSDL file 
107      */
108     public String   getWSDLFile();
109      
110     /**
111      * Returns the webservices.xml file .
112      * Corresponds to the {@link #WEB_SERVICES_FILE_KEY} key.
113      *
114      * @return the webservices file 
115      */ 
116     public String   getWebservicesFile();
117  
118     /**
119      * Returns the mapping file. This is null for JAX-WS applications.
120      * Corresponds to the {@link #MAPPING_FILE_KEY} key.
121      *
122      * @return the mapping file 
123      */
124     public String   getMappingFile();
125 
126 
127     /**
128      * Gets the web.xml file. This will be null for EJB web service endpoints.
129      * Corresponds to the {@link #WEB_XML_KEY} key.
130      *
131      * @return webXML the web.xml file as String
132      */
133     public String   getWebXML(); 
134 
135     /**
136      * Gets the sun-web.xml file. This will be null for EJB web service
137      * endpoints. 
138      * Corresponds to the {@link #SUN_WEB_XML_KEY} key.
139      *
140      * @return sunWebXML the sun-web.xml file 
141      */
142     public String   getSunWebXML();
143 
144     /**
145      * Gets the ejb.xml file. This will be null for Servlet web service
146      * endpoints. 
147      * Corresponds to the {@link #EJB_XML_KEY} key.
148      *
149      * @return EJBXML the ejb.xml file 
150      */
151     public String   getEJBXML();
152 
153     /**
154      * Gets the sun-ejb.xml file. This will be null for Servlet web service
155      * endpoints. 
156      * Corresponds to the {@link #SUN_EJB_XML_KEY} key.
157      *
158      * @return sunEJBXML the sun-ejb.xml file 
159      */
160     public String   getSunEJBXML();
161 
162     /**
163      * Gets the application.xml file. This will be null for web service in a
164      * standalone module.
165      * Corresponds to the {@link #APPLICATION_XML_KEY} key.
166      *
167      * @return applicationXML the application.xml file 
168      */
169     public String   getApplicationXML();
170 
171     /**
172      * Returns the descriptor . The descriptors includes:
173      * <pre>
174      *   WSDL, 
175      *   webservices.xml, 
176      *   mapping file 
177      * </pre>
178      * in the above specified order. If the alt WSDL location is specified 
179      * in the archive, the overridden (correct) WSDL file is returned.
180      *
181      * @return the descriptor 
182      */
183     public String  [] getDescriptors();
184 
185     /**
186      * Returns true if this web service is secured or not.
187      * Corresponds to the {@link #IS_SECURE_KEY} key.
188      *
189      * @return true, if this web service is secured, false otherwise
190      */
191     public boolean isSecure();
192    
193     // Keys to be used in Map returned from 
194     // {@link WebServiceMgr#getWebServiceEndpointInfo}
195 
196     /** Application ID */
197     public static final String   APP_ID_KEY = "AppID";
198 
199     /** Name of the web service */
200     public static final String   NAME_KEY = "Name";
201 
202     /** Relative end point URI */
203     public static final String   END_POINT_URI_KEY = "EndPointURI";
204 
205     /**
206      * Decides if this web service end point is in a stand alone
207      * Module or not. 
208      */
209     public static final String   IS_STAND_ALONE_MODULE_KEY = 
210                 "IsAppStandAloneModule";
211 
212     /** Bundle (embedded module) name, if applicable */
213     public static final String   BUNDLE_NAME_KEY = "BundleName";
214 
215     /** EJB or Servlet name */
216     public static final String   SERVICE_IMPL_NAME_KEY = "ServiceImplName";
217 
218     /** EJB or Servlet class name */
219     public static final String   SERVICE_IMPL_CLASS_KEY = "ServiceImplClass";
220 
221     /** 
222      * Web service implementation type -  @see #EJB_IMPL or @see #SERVLET_IMPL
223      */
224     public static final String   SERVICE_IMPL_TYPE_KEY = "ServiceImplType";
225 
226     /** WSDL file */
227     public static final String   WSDL_FILE_KEY = "WSDLFile";
228 
229     /** webservices.xml file */
230     public static final String   WEB_SERVICES_FILE_KEY =
231                                                 "WebServicesFile";
232 
233     /** WSDL location file */
234     public static final String   WSDL_FILE_LOCATION_KEY = "WSDLFileLocation";
235 
236     /** Mapping file */
237     public static final String   MAPPING_FILE_KEY ="MappingFile";
238 
239     /** Mapping file location */
240     public static final String   MAPPING_FILE_LOCATION_KEY ="MappingFileLocation";
241 
242     /** application.xml file */
243     public static final String   APPLICATION_XML_KEY =
244                                 "ApplicationXML";
245 
246     /** web.xml file */
247     public static final String   WEB_XML_KEY =
248                                 "WebXML";
249 
250     /** ejb.xml file */
251     public static final String   EJB_XML_KEY =
252                                 "EJBXML";
253 
254     /** sun-web.xml file */
255     public static final String   SUN_WEB_XML_KEY =
256                                 "SunWebXML";
257 
258     /** ejb.xml file */
259     public static final String   SUN_EJB_XML_KEY =
260                                 "SunEJBXML";
261 
262 
263     /** EJB implementation type name */
264     public static final String   EJB_IMPL ="EJB";
265 
266     /** Servlet implementation type name */
267     public static final String   SERVLET_IMPL ="SERVLET";
268 
269     /** This interface's class name */
270     public final static String    CLASS_NAME    =
271                 "com.sun.appserv.management.ext.wsmgmt.WebServiceEndpointInfo";
272 
273     /** Throuput statistic's name */
274     public final static String    THROUGHPUT_STATISTIC    =
275                 "throughput_statistic";
276 
277     /** Decides if this web service end point is secured or not.  */
278     public static final String   IS_SECURE_KEY = "IsSecure";
279 
280 }
281
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags