Package com.sun.xml.ws.api.wsdl.writer

Class WSDLGeneratorExtension

java.lang.Object

com.sun.xml.ws.api.wsdl.writer.WSDLGeneratorExtension

Direct Known Subclasses:

PolicyWSDLGeneratorExtension, W3CAddressingMetadataWSDLGeneratorExtension, W3CAddressingWSDLGeneratorExtension

public abstract class WSDLGeneratorExtension
extends Object

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.

Constructor Summary

Constructors

Constructor	Description
WSDLGeneratorExtension()

Method Summary

Modifier and Type	Method	Description
void	addBindingExtension(TypedXmlWriter binding)	This method is invoked so that extensions to a wsdl:binding element can be generated.
void	addBindingOperationExtension(TypedXmlWriter operation, JavaMethod method)	This method is invoked so that extensions to a wsdl:binding/wsdl:operation element can be generated.
void	addBindingOperationFaultExtension(TypedXmlWriter fault, JavaMethod method, CheckedException ce)	This method is invoked so that extensions to a wsdl:binding/wsdl:operation/wsdl:fault element can be generated.
void	addBindingOperationInputExtension(TypedXmlWriter input, JavaMethod method)	This method is invoked so that extensions to a wsdl:binding/wsdl:operation/wsdl:input element can be generated.
void	addBindingOperationOutputExtension(TypedXmlWriter output, JavaMethod method)	This method is invoked so that extensions to a wsdl:binding/wsdl:operation/wsdl:output element can be generated.
void	addDefinitionsExtension(TypedXmlWriter definitions)	This method is invoked so that extensions to a wsdl:definitions element can be generated.
void	addFaultMessageExtension(TypedXmlWriter message, JavaMethod method, CheckedException ce)	This method is invoked so that extensions to a wsdl:portType/wsdl:operation/wsdl:fault element can be generated.
void	addInputMessageExtension(TypedXmlWriter message, JavaMethod method)	This method is invoked so that extensions to an input wsdl:message element can be generated.
void	addOperationExtension(TypedXmlWriter operation, JavaMethod method)	This method is invoked so that extensions to a wsdl:portType/wsdl:operation element can be generated.
void	addOperationFaultExtension(TypedXmlWriter fault, JavaMethod method, CheckedException ce)	This method is invoked so that extensions to a wsdl:portType/wsdl:operation/wsdl:fault element can be generated.
void	addOperationInputExtension(TypedXmlWriter input, JavaMethod method)	This method is invoked so that extensions to a wsdl:portType/wsdl:operation/wsdl:input element can be generated.
void	addOperationOutputExtension(TypedXmlWriter output, JavaMethod method)	This method is invoked so that extensions to a wsdl:portType/wsdl:operation/wsdl:output element can be generated.
void	addOutputMessageExtension(TypedXmlWriter message, JavaMethod method)	This method is invoked so that extensions to an output wsdl:message element can be generated.
void	addPortExtension(TypedXmlWriter port)	This method is invoked so that extensions to a wsdl:port element can be generated.
void	addPortTypeExtension(TypedXmlWriter portType)	This method is invoked so that extensions to a wsdl:portType element can be generated.
void	addServiceExtension(TypedXmlWriter service)	This method is invoked so that extensions to a wsdl:service element can be generated.
void	end(WSDLGenExtnContext ctxt)	Called before writing </wsdl:defintions>.
void	start(TypedXmlWriter root, SEIModel model, WSBinding binding, Container container)	Deprecated.
void	start(WSDLGenExtnContext ctxt)	Called at the very beginning of the process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSDLGeneratorExtension

public WSDLGeneratorExtension()

Method Detail

start

public void start(@NotNull
                  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 this SEIModel.

binding - The binding for which we generate WSDL. the binding WSBinding represents a particular configuration of JAXWS. This can be typically be overriden by

container - The entry point to the external environment. If this extension is used at the runtime to generate WSDL, you get a Container that was given to WSEndpoint.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

public void end(@NotNull
                WSDLGenExtnContext ctxt)

Called before writing </wsdl:defintions>.

Parameters:

ctxt -

start

public void start(WSDLGenExtnContext ctxt)

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(TypedXmlWriter definitions)

This method is invoked so that extensions to a wsdl:definitions element can be generated.

Parameters:

definitions - This is the wsdl:defintions element that the extension can be added to.

addServiceExtension

public void addServiceExtension(TypedXmlWriter service)

This method is invoked so that extensions to a wsdl:service element can be generated.

Parameters:

service - This is the wsdl:service element that the extension can be added to.

addPortExtension

public void addPortExtension(TypedXmlWriter port)

This method is invoked so that extensions to a wsdl:port element can be generated.

Parameters:

port - This is the wsdl:port element that the extension can be added to.

addPortTypeExtension

public void addPortTypeExtension(TypedXmlWriter portType)

This method is invoked so that extensions to a wsdl:portType element can be generated.

Parameters:

portType - This is the wsdl:portType element that the extension can be added to.

addBindingExtension

public void addBindingExtension(TypedXmlWriter binding)

This method is invoked so that extensions to a wsdl: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

public void addOperationExtension(TypedXmlWriter operation,
                                  JavaMethod method)

This method is invoked so that extensions to a wsdl: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(TypedXmlWriter operation,
                                         JavaMethod method)

This method is invoked so that extensions to a wsdl: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

public void addInputMessageExtension(TypedXmlWriter message,
                                     JavaMethod method)

This method is invoked so that extensions to an input wsdl: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

public void addOutputMessageExtension(TypedXmlWriter message,
                                      JavaMethod method)

This method is invoked so that extensions to an output wsdl: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

public void addOperationInputExtension(TypedXmlWriter input,
                                       JavaMethod method)

This method is invoked so that extensions to a wsdl: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

public void addOperationOutputExtension(TypedXmlWriter output,
                                        JavaMethod method)

This method is invoked so that extensions to a wsdl: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(TypedXmlWriter input,
                                              JavaMethod method)

This method is invoked so that extensions to a wsdl: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(TypedXmlWriter output,
                                               JavaMethod method)

This method is invoked so that extensions to a wsdl: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(TypedXmlWriter fault,
                                              JavaMethod method,
                                              CheckedException ce)

This method is invoked so that extensions to a wsdl: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(TypedXmlWriter message,
                                     JavaMethod method,
                                     CheckedException ce)

This method is invoked so that extensions to a wsdl: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:operation

ce - CheckedException that abstracts wsdl:fault

addOperationFaultExtension

public void addOperationFaultExtension(TypedXmlWriter fault,
                                       JavaMethod method,
                                       CheckedException ce)

This method is invoked so that extensions to a wsdl: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:operation

ce - CheckedException that abstracts wsdl:fault