KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > wsmgmt > repository > spi > WebServiceInfoProvider


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 import java.util.List JavaDoc;
26 import java.util.Map JavaDoc;
27
28 /**
29  * This is the mechanism to provide web service information for a given module.
30  * A WebServiceInfoProvider implementation is a class that extends the
31  * WebServiceInfoProvider abstract class. Some WebServiceInfoProvider can deal
32  * with ejb and web module. Some only deal with web modules.
33  * <br>
34  * A WebServiceInfoProvider implemented is identified by its fully qualified
35  * class name. The default RepositoryProvider is
36  * com.sun.enterprise.tools.common.AppServWebServiceInfoProvider
37  */
38 public interface WebServiceInfoProvider {
39
40     /**
41      * Returns the unique identifier for this WebServiceInfoProvider object.
42      *
43      * @return fully qualified class name of this WebServiceInfoProvider
44      */
45     public String JavaDoc getProviderID();
46
47     /**
48      * Returns the List of WebServiceInfos for the provided EJB module.
49      *
50      * @param moduleInfo Descriptor file (sun-ejb-jar.xml or sun-web-app.xml)
51      * location
52      * @param propMap Additional properties passed
53      *
54      * @return the List of WebServiceInfos
55      * @throws when the descriptor can not be read or file is not of
56      * sun-ejb-jar.xml or sun-web-app.xml type.
57      */
58     public List JavaDoc getWebServiceInfo(String JavaDoc moduleInfo, Map JavaDoc propMap)
59         throws RepositoryException;
60
61     /**
62      * Property name for module type. If this property is not set, the module
63      * type is assumed to web module.
64      */
65     public final static String JavaDoc MOD_TYPE_PROP_NAME = "module.type";
66
67     /** EJB module type */
68     public final static String JavaDoc MOD_TYPE_EJB = "ejb.module.type";
69
70     /** WEB module type */
71     public final static String JavaDoc MOD_TYPE_WEB = "web.module.type";
72
73     /** Application id for this web service end point */
74     public final static String JavaDoc APP_ID_PROP_NAME = "application.id";
75
76     /** bundle name for this web service end point */
77     public final static String JavaDoc BUNDLE_NAME_PROP_NAME = "bundle.name";
78
79     /** WSDL location for this web service end point */
80     public final static String JavaDoc WSDL_PROP_NAME = "wsdl.location";
81
82     /** application.xml for this web service end point */
83     public final static String JavaDoc APPLICATION_XML_PROP_NAME = "application.xml";
84
85     /** webservices.xml for this web service end point */
86     public final static String JavaDoc WS_XML_PROP_NAME = "ws.xml";
87
88     /** webservices.xml location for this web service end point */
89     public final static String JavaDoc WS_XML_LOCATION_PROP_NAME = "ws.xml.location";
90
91     /** mapping file location for this web service end point */
92     public final static String JavaDoc MAPPING_PROP_NAME = "mapping.location";
93
94     /** ejb-jar.xml location for this web service end point */
95     public final static String JavaDoc EJB_JAR_XML_PROP_NAME =
96                                                     "ejb.jar.xml.location";
97
98     /** sun-ejb-jar.xml for this web service end point */
99     public final static String JavaDoc SUN_EJB_JAR_XML_PROP_NAME =
100                                                 "sun.ejb.jar.xml";
101
102     /** sun-ejb-jar.xml location for this web service end point */
103     public final static String JavaDoc SUN_EJB_JAR_XML_LOCATION_PROP_NAME =
104                                                 "sun.ejb.jar.xml.location";
105
106     /** web.xml location for this web service end point */
107     public final static String JavaDoc WEB_XML_PROP_NAME = "web.xml.location";
108
109     /** sun-web.xml location for this web service end point */
110     public final static String JavaDoc SUN_WEB_XML_PROP_NAME =
111                                             "sun.web.xml";
112
113     /** sun-web.xml location for this web service end point */
114     public final static String JavaDoc SUN_WEB_XML_LOCATION_PROP_NAME =
115                                             "sun.web.xml.location";
116
117
118     /** application root location for this web service end point */
119     public final static String JavaDoc APP_ROOT_LOCATION_PROP_NAME="app.root.location";
120
121     /** bundle root location for this web service end point */
122     public final static String JavaDoc BUNDLE_ROOT_LOCATION_PROP_NAME =
123                                                 "bundle.root.location";
124 }
125
Popular Tags