java.lang.Object
com.sun.xml.ws.api.wsdl.writer.WSDLGeneratorExtension
- Direct Known Subclasses:
PolicyWSDLGeneratorExtension
,W3CAddressingMetadataWSDLGeneratorExtension
,W3CAddressingWSDLGeneratorExtension
This is a callback interface used to extend the WSDLGenerator. Implementors
of this interface can add their own WSDL extensions to the generated WSDL.
There are a number of methods that will be invoked allowing the extensions
to be generated on various WSDL elements.
The JAX-WS WSDLGenerator uses TXW to serialize the WSDL out to XML. More information about TXW can be located at http://txw.java.net.
The JAX-WS WSDLGenerator uses TXW to serialize the WSDL out to XML. More information about TXW can be located at http://txw.java.net.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addBindingExtension
(com.sun.xml.txw2.TypedXmlWriter binding) This method is invoked so that extensions to awsdl:binding
element can be generated.void
addBindingOperationExtension
(com.sun.xml.txw2.TypedXmlWriter operation, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation
element can be generated.void
addBindingOperationFaultExtension
(com.sun.xml.txw2.TypedXmlWriter fault, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:fault
element can be generated.void
addBindingOperationInputExtension
(com.sun.xml.txw2.TypedXmlWriter input, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:input
element can be generated.void
addBindingOperationOutputExtension
(com.sun.xml.txw2.TypedXmlWriter output, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:output
element can be generated.void
addDefinitionsExtension
(com.sun.xml.txw2.TypedXmlWriter definitions) This method is invoked so that extensions to awsdl:definitions
element can be generated.void
addFaultMessageExtension
(com.sun.xml.txw2.TypedXmlWriter message, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:fault
element can be generated.void
addInputMessageExtension
(com.sun.xml.txw2.TypedXmlWriter message, JavaMethod method) This method is invoked so that extensions to an inputwsdl:message
element can be generated.void
addOperationExtension
(com.sun.xml.txw2.TypedXmlWriter operation, JavaMethod method) This method is invoked so that extensions to awsdl:portType/wsdl:operation
element can be generated.void
addOperationFaultExtension
(com.sun.xml.txw2.TypedXmlWriter fault, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:fault
element can be generated.void
addOperationInputExtension
(com.sun.xml.txw2.TypedXmlWriter input, JavaMethod method) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:input
element can be generated.void
addOperationOutputExtension
(com.sun.xml.txw2.TypedXmlWriter output, JavaMethod method) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:output
element can be generated.void
addOutputMessageExtension
(com.sun.xml.txw2.TypedXmlWriter message, JavaMethod method) This method is invoked so that extensions to an outputwsdl:message
element can be generated.void
addPortExtension
(com.sun.xml.txw2.TypedXmlWriter port) This method is invoked so that extensions to awsdl:port
element can be generated.void
addPortTypeExtension
(com.sun.xml.txw2.TypedXmlWriter portType) This method is invoked so that extensions to awsdl:portType
element can be generated.void
addServiceExtension
(com.sun.xml.txw2.TypedXmlWriter service) This method is invoked so that extensions to awsdl:service
element can be generated.void
end
(WSDLGenExtnContext ctxt) Called before writing </wsdl:defintions>.void
Deprecated.void
start
(WSDLGenExtnContext ctxt) Called at the very beginning of the process.
-
Constructor Details
-
WSDLGeneratorExtension
protected WSDLGeneratorExtension()Default constructor.
-
-
Method Details
-
start
@Deprecated public void start(@NotNull com.sun.xml.txw2.TypedXmlWriter root, @NotNull SEIModel model, @NotNull WSBinding binding, @NotNull Container container) Deprecated.Called at the very beginning of the process.
This method is invoked so that the root element can be manipulated before any tags have been written. This allows to set e.g. namespace prefixes.
Another purpose of this method is to let extensions know what model we are generating a WSDL for.- Parameters:
root
- This is the root element of the generated WSDL.model
- WSDL is being generated from thisSEIModel
.binding
- The binding for which we generate WSDL. the bindingWSBinding
represents a particular configuration of JAXWS. This can be typically be overriden bycontainer
- The entry point to the external environment. If this extension is used at the runtime to generate WSDL, you get aContainer
that was given toWSEndpoint.create(java.lang.Class<T>, boolean, com.sun.xml.ws.api.server.Invoker, javax.xml.namespace.QName, javax.xml.namespace.QName, com.sun.xml.ws.api.server.Container, com.sun.xml.ws.api.WSBinding, com.sun.xml.ws.api.server.SDDocumentSource, java.util.Collection<? extends com.sun.xml.ws.api.server.SDDocumentSource>, org.xml.sax.EntityResolver, boolean)
. TODO: think about tool side
-
end
Called before writing </wsdl:defintions>. -
start
Called at the very beginning of the process.
This method is invoked so that the root element can be manipulated before any tags have been written. This allows to set e.g. namespace prefixes.
Another purpose of this method is to let extensions know what model we are generating a WSDL for.- Parameters:
ctxt
- Provides the context for the generator extensions
-
addDefinitionsExtension
public void addDefinitionsExtension(com.sun.xml.txw2.TypedXmlWriter definitions) This method is invoked so that extensions to awsdl:definitions
element can be generated.- Parameters:
definitions
- This is thewsdl:defintions
element that the extension can be added to.
-
addServiceExtension
public void addServiceExtension(com.sun.xml.txw2.TypedXmlWriter service) This method is invoked so that extensions to awsdl:service
element can be generated.- Parameters:
service
- This is thewsdl:service
element that the extension can be added to.
-
addPortExtension
public void addPortExtension(com.sun.xml.txw2.TypedXmlWriter port) This method is invoked so that extensions to awsdl:port
element can be generated.- Parameters:
port
- This is the wsdl:port element that the extension can be added to.
-
addPortTypeExtension
public void addPortTypeExtension(com.sun.xml.txw2.TypedXmlWriter portType) This method is invoked so that extensions to awsdl:portType
element can be generated.- Parameters:
portType
- This is the wsdl:portType element that the extension can be added to.
-
addBindingExtension
public void addBindingExtension(com.sun.xml.txw2.TypedXmlWriter binding) This method is invoked so that extensions to awsdl:binding
element can be generated.
TODO: Some other information may need to be passed- Parameters:
binding
- This is the wsdl:binding element that the extension can be added to.
-
addOperationExtension
This method is invoked so that extensions to awsdl:portType/wsdl:operation
element can be generated.- Parameters:
operation
- This is the wsdl:portType/wsdl:operation element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addBindingOperationExtension
public void addBindingOperationExtension(com.sun.xml.txw2.TypedXmlWriter operation, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation
element can be generated.- Parameters:
operation
- This is the wsdl:binding/wsdl:operation element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addInputMessageExtension
This method is invoked so that extensions to an inputwsdl:message
element can be generated.- Parameters:
message
- This is the input wsdl:message element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addOutputMessageExtension
This method is invoked so that extensions to an outputwsdl:message
element can be generated.- Parameters:
message
- This is the output wsdl:message element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addOperationInputExtension
This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:input
element can be generated.- Parameters:
input
- This is the wsdl:portType/wsdl:operation/wsdl:input element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addOperationOutputExtension
This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:output
element can be generated.- Parameters:
output
- This is the wsdl:portType/wsdl:operation/wsdl:output element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addBindingOperationInputExtension
public void addBindingOperationInputExtension(com.sun.xml.txw2.TypedXmlWriter input, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:input
element can be generated.- Parameters:
input
- This is the wsdl:binding/wsdl:operation/wsdl:input element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addBindingOperationOutputExtension
public void addBindingOperationOutputExtension(com.sun.xml.txw2.TypedXmlWriter output, JavaMethod method) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:output
element can be generated.- Parameters:
output
- This is the wsdl:binding/wsdl:operation/wsdl:output element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addBindingOperationFaultExtension
public void addBindingOperationFaultExtension(com.sun.xml.txw2.TypedXmlWriter fault, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:binding/wsdl:operation/wsdl:fault
element can be generated.- Parameters:
fault
- This is the wsdl:binding/wsdl:operation/wsdl:fault or wsdl:portType/wsdl:output/wsdl:operation/wsdl:fault element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operation
-
addFaultMessageExtension
public void addFaultMessageExtension(com.sun.xml.txw2.TypedXmlWriter message, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:fault
element can be generated.- Parameters:
message
- This is the fault wsdl:message element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operationce
-CheckedException
that abstracts wsdl:fault
-
addOperationFaultExtension
public void addOperationFaultExtension(com.sun.xml.txw2.TypedXmlWriter fault, JavaMethod method, CheckedException ce) This method is invoked so that extensions to awsdl:portType/wsdl:operation/wsdl:fault
element can be generated.- Parameters:
fault
- This is the wsdl:portType/wsdl:operation/wsdl:fault element that the extension can be added to.method
-JavaMethod
which captures all the information to generate wsdl:portType/wsdl:operationce
-CheckedException
that abstracts wsdl:fault
-