annotate WebServiceExtensionsV1.1/WebServiceToolWorkflow_REST_SOAP/lib/SAWADLParser/src/javax/wadls/xml/WADLWriter.java @ 0:049760c677de default tip

Galaxy WSExtensions added successfully
author uga-galaxy-group
date Tue, 05 Jul 2011 19:34:18 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
1 /*
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
2 * (c) Copyright IBM Corp 2001, 2005
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
3 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
4
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
5 package javax.wadls.xml;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
6
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
7 import java.io.*;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
8 import java.net.URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
9
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
10 import org.w3c.dom.*;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
11
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
12 import javax.wadls.*;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
13
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
14 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
15 * This interface describes a collection of methods
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
16 * that allow a WSDL model to be written to a writer
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
17 * in an XML format that follows the WSDL schema.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
18 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
19 * @author Matthew J. Duftler
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
20 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
21 public interface WADLWriter
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
22 {
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
23 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
24 * Sets the specified feature to the specified value.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
25 * <p>
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
26 * There are no minimum features that must be supported.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
27 * <p>
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
28 * All feature names must be fully-qualified, Java package style. All
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
29 * names starting with javax.wsdls. are reserved for features defined
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
30 * by the JWSDL specification. It is recommended that implementation-
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
31 * specific features be fully-qualified to match the package name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
32 * of that implementation. For example: com.abc.featureName
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
33 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
34 * @param name the name of the feature to be set.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
35 * @param value the value to set the feature to.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
36 * @throws IllegalArgumentException if the feature name is not recognized.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
37 * @see #getFeature(String)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
38 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
39 public void setFeature(String name, boolean value)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
40 throws IllegalArgumentException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
41
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
42 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
43 * Gets the value of the specified feature.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
44 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
45 * @param name the name of the feature to get the value of.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
46 * @throws IllegalArgumentException if the feature name is not recognized.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
47 * @see #setFeature(String, boolean)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
48 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
49 public boolean getFeature(String name) throws IllegalArgumentException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
50
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
51 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
52 * Return a document generated from the specified WSDL model.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
53 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
54 public Document getDocument(Application wadlApp) throws WADLSException, URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
55
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
56 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
57 * Write the specified WSDL definition to the specified Writer.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
58 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
59 * @param wsdlDef the WSDL definition to be written.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
60 * @param sink the Writer to write the xml to.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
61 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
62 public void writeWADL(Application wadlApp, Writer sink)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
63 throws WADLSException, URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
64
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
65 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
66 * Write the specified WSDL definition to the specified OutputStream.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
67 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
68 * @param wsdlDef the WSDL definition to be written.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
69 * @param sink the OutputStream to write the xml to.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
70 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
71 public void writeWADL(Application wadlApp, OutputStream sink)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
72 throws WADLSException, URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
73 }