KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > websvc > spi > webservices > WebServicesSupportImpl


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.modules.websvc.spi.webservices;
21
22 import java.util.List JavaDoc;
23 import org.netbeans.api.java.classpath.ClassPath;
24
25 import org.openide.filesystems.FileObject;
26 import org.netbeans.spi.project.support.ant.AntProjectHelper;
27 import org.netbeans.api.project.Project;
28 import org.netbeans.modules.j2ee.dd.api.webservices.ServiceImplBean;
29 import org.netbeans.spi.project.support.ant.ReferenceHelper;
30
31 /**
32  *
33  * @author Peter Williams
34  */
35 public interface WebServicesSupportImpl {
36
37     /*
38      * Add web service related entries to the project.properties and project.xml files
39      */
40     public void addServiceImpl(String JavaDoc serviceName, FileObject configFile, boolean fromWSDL, String JavaDoc[] wscompileFeatures);
41     
42     /*
43      * Add web service related entries to the project.properties and project.xml files
44      */
45     public void addServiceImpl(String JavaDoc serviceName, FileObject configFile, boolean fromWSDL);
46     
47     /**
48      * Add web service entries to the module's deployment descriptor
49      */
50     public void addServiceEntriesToDD(String JavaDoc serviceName, String JavaDoc serviceEndpointInterface, String JavaDoc serviceEndpoint);
51     
52     /**
53      * Get the FileObject of the webservices.xml file.
54      */
55     public FileObject getWebservicesDD();
56     
57     /**
58      * Returns the directory that contains webservices.xml in the project
59      */
60     public FileObject getWsDDFolder();
61     
62     /**
63      * Returns the name of the directory that contains the webservices.xml in
64      * the archive
65      */
66     public String JavaDoc getArchiveDDFolderName();
67     
68     /**
69      * Returns the name of the implementation bean class
70      * given the servlet-link or ejb-link name
71      */
72     public String JavaDoc getImplementationBean(String JavaDoc linkName);
73     
74     /**
75      * Given the servlet-link or ejb-link, remove the servlet or
76      * ejb entry in the module's deployment descriptor.
77      */
78     public void removeServiceEntry(String JavaDoc linkName);
79     
80     /**
81      * Remove the web service entries from the project properties
82      * project.xml files
83      */
84     public void removeProjectEntries(String JavaDoc serviceName);
85     
86     /**
87      * Get the AntProjectHelper from the project
88      */
89     public AntProjectHelper getAntProjectHelper();
90     
91     /**
92      * Generate the implementation bean class and return the class name
93      */
94     public String JavaDoc generateImplementationBean(String JavaDoc wsName, FileObject pkg, Project project, String JavaDoc delegateData)throws java.io.IOException JavaDoc;
95     
96     /**
97      * Add the servlet link or ejb link in the webservices.xml entry
98      */
99     public void addServiceImplLinkEntry(ServiceImplBean serviceImplBean, String JavaDoc wsName);
100     
101     /**
102      * Get the ReferenceHelper from the project
103      */
104     public ReferenceHelper getReferenceHelper();
105     
106     /**
107      * Get the list of services and their wscompile settings.
108      */
109     public List JavaDoc/*WsCompileEditorSupport.ServiceSettings*/ getServices();
110     
111     /**
112      * Add infrastructure methods and fields (if any) that should be present
113      * in the implementation bean class
114      */
115     public void addInfrastructure(String JavaDoc implBeanClass, FileObject pkg);
116     
117     /**
118      * Determine if the web service was created from WSDL
119      */
120     public boolean isFromWSDL(String JavaDoc serviceName);
121     
122     /**
123      * Provide classpath where annotations define webservices
124      */
125     public ClassPath getClassPath();
126     
127 }
128
Popular Tags