001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.websvc.spi.webservices;
043:
044: import java.util.List;
045: import org.netbeans.api.java.classpath.ClassPath;
046:
047: import org.openide.filesystems.FileObject;
048: import org.netbeans.spi.project.support.ant.AntProjectHelper;
049: import org.netbeans.api.project.Project;
050: import org.netbeans.modules.j2ee.dd.api.webservices.ServiceImplBean;
051: import org.netbeans.spi.project.support.ant.ReferenceHelper;
052:
053: /**
054: *
055: * @author Peter Williams
056: */
057: public interface WebServicesSupportImpl {
058:
059: /*
060: * Add web service related entries to the project.properties and project.xml files
061: */
062: public void addServiceImpl(String serviceName,
063: FileObject configFile, boolean fromWSDL,
064: String[] wscompileFeatures);
065:
066: /*
067: * Add web service related entries to the project.properties and project.xml files
068: */
069: public void addServiceImpl(String serviceName,
070: FileObject configFile, boolean fromWSDL);
071:
072: /**
073: * Add web service entries to the module's deployment descriptor
074: */
075: public void addServiceEntriesToDD(String serviceName,
076: String serviceEndpointInterface, String serviceEndpoint);
077:
078: /**
079: * Get the FileObject of the webservices.xml file.
080: */
081: public FileObject getWebservicesDD();
082:
083: /**
084: * Returns the directory that contains webservices.xml in the project
085: */
086: public FileObject getWsDDFolder();
087:
088: /**
089: * Returns the name of the directory that contains the webservices.xml in
090: * the archive
091: */
092: public String getArchiveDDFolderName();
093:
094: /**
095: * Returns the name of the implementation bean class
096: * given the servlet-link or ejb-link name
097: */
098: public String getImplementationBean(String linkName);
099:
100: /**
101: * Given the servlet-link or ejb-link, remove the servlet or
102: * ejb entry in the module's deployment descriptor.
103: */
104: public void removeServiceEntry(String linkName);
105:
106: /**
107: * Remove the web service entries from the project properties
108: * project.xml files
109: */
110: public void removeProjectEntries(String serviceName);
111:
112: /**
113: * Get the AntProjectHelper from the project
114: */
115: public AntProjectHelper getAntProjectHelper();
116:
117: /**
118: * Generate the implementation bean class and return the class name
119: */
120: public String generateImplementationBean(String wsName,
121: FileObject pkg, Project project, String delegateData)
122: throws java.io.IOException;
123:
124: /**
125: * Add the servlet link or ejb link in the webservices.xml entry
126: */
127: public void addServiceImplLinkEntry(
128: ServiceImplBean serviceImplBean, String wsName);
129:
130: /**
131: * Get the ReferenceHelper from the project
132: */
133: public ReferenceHelper getReferenceHelper();
134:
135: /**
136: * Get the list of services and their wscompile settings.
137: */
138: public List/*WsCompileEditorSupport.ServiceSettings*/getServices();
139:
140: /**
141: * Add infrastructure methods and fields (if any) that should be present
142: * in the implementation bean class
143: */
144: public void addInfrastructure(String implBeanClass, FileObject pkg);
145:
146: /**
147: * Determine if the web service was created from WSDL
148: */
149: public boolean isFromWSDL(String serviceName);
150:
151: /**
152: * Provide classpath where annotations define webservices
153: */
154: public ClassPath getClassPath();
155:
156: }
|