KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jonas > ws > WebServicesService


1 /**
2  * JOnAS: Java(TM) Open Application Server
3  * Copyright (C) 1999 Bull S.A.
4  * Contact: jonas-team@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA
20  *
21  * Initial Developer : Delplanque Xavier & Sauthier Guillaume
22  * --------------------------------------------------------------------------
23  * $Id: WebServicesService.java,v 1.14 2005/06/10 14:19:15 sauthieg Exp $
24  * --------------------------------------------------------------------------
25 */
26
27 package org.objectweb.jonas.ws;
28
29 import javax.naming.Context JavaDoc;
30
31 import org.objectweb.jonas.service.Service;
32
33
34 /**
35  * WebServices Service interface.
36  *
37  * @author Guillaume Sauthier
38  */
39 public interface WebServicesService extends Service {
40
41     /**
42      * classloader Context param
43      */
44     String JavaDoc CLASSLOADER_CTX_PARAM = "classloader";
45
46     /**
47      * parentObjectName Context Param
48      */
49     String JavaDoc PARENT_OBJECTNAME_CTX_PARAM = "parentObjectName";
50
51     /**
52      * isInEar Context Param
53      */
54     String JavaDoc ISINEAR_CTX_PARAM = "isInEar";
55
56     /**
57      * warURL Context Param
58      */
59     String JavaDoc WARURL_CTX_PARAM = "warURL";
60
61     /**
62      * explore the context classloader to find Web service deployment
63      * descriptor (for endpoints) and service-ref element within standard
64      * deployment descriptor (for clients). It registers each endpoints in WS
65      * engine publishing relative WSDLs, and it instanciates and binds in the
66      * registry each clients classes.
67      *
68      * @param ctx the context containing the configuration to deploy the
69      * wars.<BR> This context contains the following parameters :<BR> -
70      * jarUrls the list of the urls of the jars to deploy.<BR> -
71      * warUrls the list of the urls of the wars to deploy.<BR> -
72      * parentClassLoader the parent classLoader of the wars.<BR> -
73      * earClassLoader the ear classLoader of the j2ee app.<BR> - altDDs
74      * the optional URI of deployment descriptor.<BR>
75      *
76      * @throws WSServiceException if an error occurs during the deployment.
77      */
78     void deployWebServices(Context JavaDoc ctx) throws WSServiceException;
79
80     /**
81      * Remove the WebServices descriptors associated to the given ClassLoader.
82      *
83      * @param cl the key ClassLoader
84      */
85     void removeCache(ClassLoader JavaDoc cl);
86
87     /**
88      * Complete the WebServices Deployment (add informations in web environment)
89      * @param ctx Context containing the key ClassLoader
90      * @throws WSServiceException When Endpoints URLs binding fails
91      */
92     void completeWSDeployment(Context JavaDoc ctx) throws WSServiceException;
93
94     /**
95      * Undeploy the WebServices : unpublish WSDL + unregister MBeans
96      * @param ctx Context containing undeployment informations
97      * @throws WSServiceException When undeployment fails
98      */
99     void undeployWebServices(Context JavaDoc ctx) throws WSServiceException;
100 }
101
Popular Tags