Emitter (JAXRPC API) - JBoss 4.0.1 sp1 jaxrpc API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.axis.wsdl.fromJava
Class Emitter

java.lang.Object
  org.apache.axis.wsdl.fromJava.Emitter

public class Emitter
extends Object

This class emits WSDL from Java classes. It is used by the ?WSDL Axis browser function and Java2WSDL commandline utility. See Java2WSDL and Java2WSDLFactory for more information.

Author:: Glen Daniels (gdaniels@macromedia.com), Rich Scheuerle (scheu@us.ibm.com)

Field Summary

static int MODE_ALL


static int MODE_DOC_WRAPPED
          DEPRECATED - Indicates style=wrapped use=literal

static int MODE_DOCUMENT
          DEPRECATED - Indicates style=document use=literal

static int MODE_IMPLEMENTATION


static int MODE_INTERFACE


static int MODE_RPC
          DEPRECATED - Indicates style=rpc use=encoded

protected static TypeMapping standardTypes


protected Types types


Constructor Summary

Emitter()
          Construct Emitter.

Method Summary

protected javax.wsdl.Definition createDefinition()
          Build a Definition from the input wsdl file or create a new Definition

protected javax.xml.namespace.QName createMessageName(javax.wsdl.Definition def, String methodName)


protected Types createTypes(javax.wsdl.Definition def)
          Build a Types object and load the input wsdl types

Document emit(int mode)
          Generates a WSDL document for a given Class.

void emit(String filename)
          Generates a complete WSDL document for a given Class

void emit(String filename, int mode)
          Generates a WSDL document for a given Class.

void emit(String filename1, String filename2)
          Generates WSDL documents for a given Class

String emitToString(int mode)
          Generates a String containing the WSDL for a given Class.

Vector getAllowedMethods()
          Returns a vector of methods to export

String getBindingName()
          Returns the String representation of the binding name

Class getCls()
          Returns the Class to export

TypeMapping getDefaultTypeMapping()
          Returns the default TypeMapping used by the service

String getDescription()
          Returns the service description

Vector getDisallowedMethods()
          Return list of methods that should not be exported

Class[] getExtraClasses()
          Return the list of extra classes that the emitter will produce WSDL for.

Class getImplCls()
          Returns the implementation Class if set

String getImplNamespace()
          Returns the implementation namespace

javax.wsdl.Definition getImplWSDL()
          Get implementation WSDL Definition for the current configuration parameters

String getImportUrl()
          Returns the String representation of the interface import location URL

String getInputSchema()


String getInputWSDL()
          Get the name of the input WSDL

String getIntfNamespace()
          Returns the interface namespace

javax.wsdl.Definition getIntfWSDL()
          Get a interface WSDL Definition for the current configuration parameters

String getLocationUrl()
          Returns the String representation of the service endpoint URL

int getMode()
          Deprecated. (use getStyle and getUse)

Map getNamespaceMap()
          get the packagename to namespace map

String getPortTypeName()
          Returns the String representation of the portType name

protected javax.xml.namespace.QName getRequestQName(OperationDesc oper)


protected javax.xml.namespace.QName getResponseQName(OperationDesc oper)


ServiceDesc getServiceDesc()


String getServiceElementName()
          Returns the String representation of the service element name

String getServicePortName()
          Returns the String representation of the service port name

String getSoapAction()
          Returns the soapAction option value

ArrayList getStopClasses()
          Return the list of classes which stop inhertance searches

Style getStyle()
          getStyle

String getTargetService()
          Returns the target service name

TypeMapping getTypeMapping()
          Returns the TypeMapping used by the service

Use getUse()
          getUse

boolean getUseInheritedMethods()
          Indicates if the emitter will search classes for inherited methods

javax.wsdl.Definition getWSDL()
          Get a Full WSDL Definition for the current configuration parameters

protected void init(int mode)
          Invoked prior to building a definition to ensure parms and data are set up.

protected void prettyDocumentToFile(Document doc, String filename)
          Write a prettified document to a file.

void setAllowedMethods(String text)
          Add a list of methods to export

void setAllowedMethods(Vector allowedMethods)
          Add a Vector of methods to export

void setBindingName(String bindingName)
          Set the String representation of the binding name

void setCls(Class cls)
          Sets the Class to export

void setCls(String className)
          Sets the Class to export

void setClsSmart(Class cls, String location)
          Sets the Class to export.

void setDefaultTypeMapping(TypeMapping defaultTM)
          Sets the default TypeMapping used by the service

void setDescription(String description)
          Set the service description

void setDisallowedMethods(String text)
          Add a list of methods NOT to export

void setDisallowedMethods(Vector disallowedMethods)
          Add a list of methods NOT to export

void setExtraClasses(Class[] extraClasses)
          Provide a list of classes which the emitter will produce WSDL type definitions for.

void setExtraClasses(String text)
          Provide a comma or space seperated list of classes which the emitter will produce WSDL type definitions for.

void setImplCls(Class implCls)
          Sets the implementation Class

void setImplCls(String className)
          Sets the implementation Class

void setImplNamespace(String ns)
          Set the implementation namespace

void setImportUrl(String importUrl)
          Set the String representation of the interface location URL for importing

void setInputSchema(String inputSchema)
          Set the name of the input schema

void setInputWSDL(String inputWSDL)
          Set the name of the input WSDL

void setIntfNamespace(String ns)
          Set the interface namespace

void setLocationUrl(String locationUrl)
          Set the String representation of the service endpoint URL

void setMode(int mode)
          Deprecated. (use setStyle and setUse)

void setNamespaceMap(Map map)
          Set the packagename to namespace map with the given map

void setPortTypeName(String portTypeName)
          Set the String representation of the portType name

void setServiceDesc(ServiceDesc serviceDesc)


void setServiceElementName(String serviceElementName)
          Set the String representation of the service element name

void setServicePortName(String servicePortName)
          Set the String representation of the service port name

void setSoapAction(String value)
          Sets the soapAction option value

void setStopClasses(ArrayList stopClasses)
          Adds a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation

void setStopClasses(String text)
          Add a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation

void setStyle(String value)
          setStyle

void setStyle(Style value)
          setStyle

void setTargetService(String targetService)
          Set the target service name

void setTypeMapping(TypeMapping tm)
          Sets the TypeMapping used by the service

void setUse(String value)
          setUse

void setUse(Use value)
          setUse

void setUseInheritedMethods(boolean useInheritedMethods)
          Turn on or off inherited method WSDL generation.

protected javax.wsdl.Binding writeBinding(javax.wsdl.Definition def, boolean add)
          Create the binding.

protected javax.wsdl.BindingOperation writeBindingOperation(javax.wsdl.Definition def, javax.wsdl.Binding binding, javax.wsdl.Operation oper, OperationDesc desc)
          Create a Binding Operation

protected void writeDefinitions(javax.wsdl.Definition def, String tns)
          Create the definition header information.

protected javax.wsdl.Message writeFaultMessage(javax.wsdl.Definition def, FaultDesc exception)
          Create a Fault Message

protected void writeImport(javax.wsdl.Definition def, String tns, String loc)
          Create and add an import

protected void writeMessages(javax.wsdl.Definition def, javax.wsdl.Operation oper, OperationDesc desc, javax.wsdl.BindingOperation bindingOper)
          Create a Message

protected javax.wsdl.BindingOperation writeOperation(javax.wsdl.Definition def, javax.wsdl.Binding binding, OperationDesc desc)
          Create a Operation

String writePartToMessage(javax.wsdl.Definition def, javax.wsdl.Message msg, boolean request, ParameterDesc param)
          Create a Part

protected void writePortType(javax.wsdl.Definition def, javax.wsdl.Binding binding)
          Create a PortType

protected javax.wsdl.Message writeRequestMessage(javax.wsdl.Definition def, OperationDesc oper)
          Create a Request Message

protected javax.wsdl.Message writeResponseMessage(javax.wsdl.Definition def, OperationDesc desc)
          Create a Response Message

protected void writeService(javax.wsdl.Definition def, javax.wsdl.Binding binding)
          Create the service.

protected javax.wsdl.extensions.ExtensibilityElement writeSOAPBody(javax.xml.namespace.QName operQName)


protected javax.wsdl.extensions.soap.SOAPFault writeSOAPFault(FaultDesc faultDesc)


void writeWrapperPart(javax.wsdl.Definition def, javax.wsdl.Message msg, OperationDesc oper, boolean request)
          Write out the schema definition for a WRAPPED operation request or response.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_ALL

public static final int MODE_ALL

See Also:: Constant Field Values

MODE_INTERFACE

public static final int MODE_INTERFACE

See Also:: Constant Field Values

MODE_IMPLEMENTATION

public static final int MODE_IMPLEMENTATION

See Also:: Constant Field Values

types

protected Types types

MODE_RPC

public static final int MODE_RPC

DEPRECATED - Indicates style=rpc use=encoded

See Also:: Constant Field Values

MODE_DOCUMENT

public static final int MODE_DOCUMENT

DEPRECATED - Indicates style=document use=literal

See Also:: Constant Field Values

MODE_DOC_WRAPPED

public static final int MODE_DOC_WRAPPED

DEPRECATED - Indicates style=wrapped use=literal

See Also:: Constant Field Values

standardTypes

protected static TypeMapping standardTypes

Constructor Detail

Emitter

public Emitter()

Construct Emitter. Set the contextual information using set* methods Invoke emit to emit the code

Method Detail

emit

public void emit(String filename1,
                 String filename2)
          throws IOException,
                 javax.wsdl.WSDLException,
                 SAXException,
                 ParserConfigurationException

Generates WSDL documents for a given Class

Parameters:: filename1 - interface WSDL; filename2 - implementation WSDL
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

emit

public void emit(String filename)
          throws IOException,
                 javax.wsdl.WSDLException,
                 SAXException,
                 ParserConfigurationException

Generates a complete WSDL document for a given Class

Parameters:: filename - WSDL
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

emit

public Document emit(int mode)
              throws IOException,
                     javax.wsdl.WSDLException,
                     SAXException,
                     ParserConfigurationException

Generates a WSDL document for a given Class. The WSDL generated is controlled by the mode parameter mode 0: All mode 1: Interface mode 2: Implementation

Parameters:: mode - generation mode - all, interface, implementation
Returns:: Document
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

emitToString

public String emitToString(int mode)
                    throws IOException,
                           javax.wsdl.WSDLException,
                           SAXException,
                           ParserConfigurationException

Generates a String containing the WSDL for a given Class. The WSDL generated is controlled by the mode parameter mode 0: All mode 1: Interface mode 2: Implementation

Parameters:: mode - generation mode - all, interface, implementation
Returns:: String
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

emit

public void emit(String filename,
                 int mode)
          throws IOException,
                 javax.wsdl.WSDLException,
                 SAXException,
                 ParserConfigurationException

Generates a WSDL document for a given Class. The WSDL generated is controlled by the mode parameter mode 0: All mode 1: Interface mode 2: Implementation

Parameters:: filename - WSDL; mode - generation mode - all, interface, implementation
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

getWSDL

public javax.wsdl.Definition getWSDL()
                              throws IOException,
                                     javax.wsdl.WSDLException,
                                     SAXException,
                                     ParserConfigurationException

Get a Full WSDL Definition for the current configuration parameters

Returns:: WSDL Definition
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

getIntfWSDL

public javax.wsdl.Definition getIntfWSDL()
                                  throws IOException,
                                         javax.wsdl.WSDLException,
                                         SAXException,
                                         ParserConfigurationException

Get a interface WSDL Definition for the current configuration parameters

Returns:: WSDL Definition
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

getImplWSDL

public javax.wsdl.Definition getImplWSDL()
                                  throws IOException,
                                         javax.wsdl.WSDLException,
                                         SAXException,
                                         ParserConfigurationException

Get implementation WSDL Definition for the current configuration parameters

Returns:: WSDL Definition
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

init

protected void init(int mode)

Invoked prior to building a definition to ensure parms and data are set up.

createDefinition

protected javax.wsdl.Definition createDefinition()
                                          throws javax.wsdl.WSDLException,
                                                 SAXException,
                                                 IOException,
                                                 ParserConfigurationException

Build a Definition from the input wsdl file or create a new Definition

Returns:: WSDL Definition
Throws:: javax.wsdl.WSDLException; SAXException; IOException; ParserConfigurationException

createTypes

protected Types createTypes(javax.wsdl.Definition def)
                     throws IOException,
                            javax.wsdl.WSDLException,
                            SAXException,
                            ParserConfigurationException

Build a Types object and load the input wsdl types

Parameters:: def - Corresponding wsdl Definition
Returns:: Types object
Throws:: IOException; javax.wsdl.WSDLException; SAXException; ParserConfigurationException

writeDefinitions

protected void writeDefinitions(javax.wsdl.Definition def,
                                String tns)

Create the definition header information.

Parameters:: def - Definition; tns - target namespace

writeImport

protected void writeImport(javax.wsdl.Definition def,
                           String tns,
                           String loc)

Create and add an import

Parameters:: def - Definition; tns - target namespace; loc - target location

writeBinding

protected javax.wsdl.Binding writeBinding(javax.wsdl.Definition def,
                                          boolean add)

Create the binding.

Parameters:: def - Definition; add - true if binding should be added to the def

writeService

protected void writeService(javax.wsdl.Definition def,
                            javax.wsdl.Binding binding)

Create the service.

Parameters:: def -; binding -

writePortType

protected void writePortType(javax.wsdl.Definition def,
                             javax.wsdl.Binding binding)
                      throws javax.wsdl.WSDLException,
                             AxisFault

Create a PortType

Parameters:: def -; binding -
Throws:: javax.wsdl.WSDLException; AxisFault

writeMessages

protected void writeMessages(javax.wsdl.Definition def,
                             javax.wsdl.Operation oper,
                             OperationDesc desc,
                             javax.wsdl.BindingOperation bindingOper)
                      throws javax.wsdl.WSDLException,
                             AxisFault

Create a Message

Parameters:: def - Definition, the WSDL definition; oper - Operation, the wsdl operation; desc - OperationDesc, the Operation Description; bindingOper - BindingOperation, corresponding Binding Operation
Throws:: javax.wsdl.WSDLException; AxisFault

writeOperation

protected javax.wsdl.BindingOperation writeOperation(javax.wsdl.Definition def,
                                                     javax.wsdl.Binding binding,
                                                     OperationDesc desc)

Create a Operation

Parameters:: def -; binding -

writeBindingOperation

protected javax.wsdl.BindingOperation writeBindingOperation(javax.wsdl.Definition def,
                                                            javax.wsdl.Binding binding,
                                                            javax.wsdl.Operation oper,
                                                            OperationDesc desc)

Create a Binding Operation

Parameters:: def -; binding -; oper -

writeSOAPBody

protected javax.wsdl.extensions.ExtensibilityElement writeSOAPBody(javax.xml.namespace.QName operQName)

writeSOAPFault

protected javax.wsdl.extensions.soap.SOAPFault writeSOAPFault(FaultDesc faultDesc)

writeRequestMessage

protected javax.wsdl.Message writeRequestMessage(javax.wsdl.Definition def,
                                                 OperationDesc oper)
                                          throws javax.wsdl.WSDLException,
                                                 AxisFault

Create a Request Message

Parameters:: def -
Throws:: javax.wsdl.WSDLException; AxisFault

getRequestQName

protected javax.xml.namespace.QName getRequestQName(OperationDesc oper)

getResponseQName

protected javax.xml.namespace.QName getResponseQName(OperationDesc oper)

writeWrapperPart

public void writeWrapperPart(javax.wsdl.Definition def,
                             javax.wsdl.Message msg,
                             OperationDesc oper,
                             boolean request)
                      throws AxisFault

Write out the schema definition for a WRAPPED operation request or response.

Parameters:: oper -; request -
Throws:: AxisFault

writeResponseMessage

protected javax.wsdl.Message writeResponseMessage(javax.wsdl.Definition def,
                                                  OperationDesc desc)
                                           throws javax.wsdl.WSDLException,
                                                  AxisFault

Create a Response Message

Parameters:: def -
Throws:: javax.wsdl.WSDLException; AxisFault

writeFaultMessage

protected javax.wsdl.Message writeFaultMessage(javax.wsdl.Definition def,
                                               FaultDesc exception)
                                        throws javax.wsdl.WSDLException,
                                               AxisFault

Create a Fault Message

Parameters:: def -; exception - (an ExceptionRep object)
Throws:: javax.wsdl.WSDLException; AxisFault

writePartToMessage

public String writePartToMessage(javax.wsdl.Definition def,
                                 javax.wsdl.Message msg,
                                 boolean request,
                                 ParameterDesc param)
                          throws javax.wsdl.WSDLException,
                                 AxisFault

Create a Part

Parameters:: def -; msg -; request - message is for a request; param - ParamRep object
Returns:: The parameter name added or null
Throws:: javax.wsdl.WSDLException; AxisFault

createMessageName

protected javax.xml.namespace.QName createMessageName(javax.wsdl.Definition def,
                                                      String methodName)

prettyDocumentToFile

protected void prettyDocumentToFile(Document doc,
                                    String filename)
                             throws IOException

Write a prettified document to a file.

Parameters:: doc - the Document to write; filename - the name of the file to be written
Throws:: IOException - various file i/o exceptions

getCls

public Class getCls()

Returns the Class to export

Returns:: the Class to export

setCls

public void setCls(Class cls)

Sets the Class to export

Parameters:: cls - the Class to export

setClsSmart

public void setClsSmart(Class cls,
                        String location)

Sets the Class to export.

Parameters:: cls - the Class to export

setCls

public void setCls(String className)
            throws ClassNotFoundException

Sets the Class to export

Parameters:: className - the name of the Class to export
Throws:: ClassNotFoundException

getImplCls

public Class getImplCls()

Returns the implementation Class if set

Returns:: the implementation Class or null

setImplCls

public void setImplCls(Class implCls)

Sets the implementation Class

Parameters:: implCls - the Class to export

setImplCls

public void setImplCls(String className)

Sets the implementation Class

Parameters:: className - the name of the implementation Class

getIntfNamespace

public String getIntfNamespace()

Returns the interface namespace

Returns:: interface target namespace

setIntfNamespace

public void setIntfNamespace(String ns)

Set the interface namespace

Parameters:: ns - interface target namespace

getImplNamespace

public String getImplNamespace()

Returns the implementation namespace

Returns:: implementation target namespace

setImplNamespace

public void setImplNamespace(String ns)

Set the implementation namespace

Parameters:: ns - implementation target namespace

getAllowedMethods

public Vector getAllowedMethods()

Returns a vector of methods to export

Returns:: a space separated list of methods to export

setAllowedMethods

public void setAllowedMethods(String text)

Add a list of methods to export

setAllowedMethods

public void setAllowedMethods(Vector allowedMethods)

Add a Vector of methods to export

Parameters:: allowedMethods - a vector of methods to export

getUseInheritedMethods

public boolean getUseInheritedMethods()

Indicates if the emitter will search classes for inherited methods

setUseInheritedMethods

public void setUseInheritedMethods(boolean useInheritedMethods)

Turn on or off inherited method WSDL generation.

setDisallowedMethods

public void setDisallowedMethods(Vector disallowedMethods)

Add a list of methods NOT to export

Parameters:: disallowedMethods - vector of method name strings

setDisallowedMethods

public void setDisallowedMethods(String text)

Add a list of methods NOT to export

Parameters:: text - space separated list of method names

getDisallowedMethods

public Vector getDisallowedMethods()

Return list of methods that should not be exported

setStopClasses

public void setStopClasses(ArrayList stopClasses)

Adds a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation

Parameters:: stopClasses - vector of class name strings

setStopClasses

public void setStopClasses(String text)

Add a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation

Parameters:: text - space separated list of class names

getStopClasses

public ArrayList getStopClasses()

Return the list of classes which stop inhertance searches

getNamespaceMap

public Map getNamespaceMap()

get the packagename to namespace map

Returns:: Map

setNamespaceMap

public void setNamespaceMap(Map map)

Set the packagename to namespace map with the given map

Parameters:: map - packagename/namespace Map

getInputWSDL

public String getInputWSDL()

Get the name of the input WSDL

Returns:: name of the input wsdl or null

setInputWSDL

public void setInputWSDL(String inputWSDL)

Set the name of the input WSDL

Parameters:: inputWSDL - the name of the input WSDL

getInputSchema

public String getInputSchema()

Returns:: the name of the input schema, or null

setInputSchema

public void setInputSchema(String inputSchema)

Set the name of the input schema

Parameters:: inputSchema - the name of the input schema

getLocationUrl

public String getLocationUrl()

Returns the String representation of the service endpoint URL

Returns:: String representation of the service endpoint URL

setLocationUrl

public void setLocationUrl(String locationUrl)

Set the String representation of the service endpoint URL

Parameters:: locationUrl - the String representation of the service endpoint URL

getImportUrl

public String getImportUrl()

Returns the String representation of the interface import location URL

Returns:: String representation of the interface import location URL

setImportUrl

public void setImportUrl(String importUrl)

Set the String representation of the interface location URL for importing

Parameters:: importUrl - the String representation of the interface location URL for importing

getServicePortName

public String getServicePortName()

Returns the String representation of the service port name

Returns:: String representation of the service port name

setServicePortName

public void setServicePortName(String servicePortName)

Set the String representation of the service port name

Parameters:: servicePortName - the String representation of the service port name

getServiceElementName

public String getServiceElementName()

Returns the String representation of the service element name

Returns:: String representation of the service element name

setServiceElementName

public void setServiceElementName(String serviceElementName)

Set the String representation of the service element name

Parameters:: serviceElementName - the String representation of the service element name

getPortTypeName

public String getPortTypeName()

Returns the String representation of the portType name

Returns:: String representation of the portType name

setPortTypeName

public void setPortTypeName(String portTypeName)

Set the String representation of the portType name

Parameters:: portTypeName - the String representation of the portType name

getBindingName

public String getBindingName()

Returns the String representation of the binding name

Returns:: String representation of the binding name

setBindingName

public void setBindingName(String bindingName)

Set the String representation of the binding name

Parameters:: bindingName - the String representation of the binding name

getTargetService

public String getTargetService()

Returns the target service name

Returns:: the target service name

setTargetService

public void setTargetService(String targetService)

Set the target service name

Parameters:: targetService - the target service name

getDescription

public String getDescription()

Returns the service description

Returns:: service description String

setDescription

public void setDescription(String description)

Set the service description

Parameters:: description - service description String

getSoapAction

public String getSoapAction()

Returns the soapAction option value

Returns:: the String DEFAULT, NONE or OPERATION

setSoapAction

public void setSoapAction(String value)

Sets the soapAction option value

Parameters:: value - must be DEFAULT, NONE, or OPERATION

getTypeMapping

public TypeMapping getTypeMapping()

Returns the TypeMapping used by the service

Returns:: the TypeMapping used by the service

setTypeMapping

public void setTypeMapping(TypeMapping tm)

Sets the TypeMapping used by the service

Parameters:: tm - the TypeMapping used by the service

getDefaultTypeMapping

public TypeMapping getDefaultTypeMapping()

Returns the default TypeMapping used by the service

Returns:: the default TypeMapping used by the service

setDefaultTypeMapping

public void setDefaultTypeMapping(TypeMapping defaultTM)

Sets the default TypeMapping used by the service

Parameters:: defaultTM - the default TypeMapping used by the service

getStyle

public Style getStyle()

getStyle

Returns:: Style setting (Style.RPC, Style.DOCUMENT, Style.WRAPPED, etc.)

setStyle

public void setStyle(String value)

setStyle

Parameters:: value - String representing a style ("document", "rpc", "wrapped") Note that the case of the string is not important. "document" and "DOCUMENT" are both treated as document style. If the value is not a know style, the default setting is used. See org.apache.axis.enum.Style for a description of the interaction between Style/Use
NOTE: If style is specified as "wrapped", use is set to literal.

setStyle

public void setStyle(Style value)

setStyle

Parameters:: value - Style setting

getUse

public Use getUse()

getUse

Returns:: Use setting (Use.ENCODED, Use.LITERAL)

setUse

public void setUse(String value)

setUse

Parameters:: value - String representing a use ("literal", "encoded") Note that the case of the string is not important. "literal" and "LITERAL" are both treated as literal use. If the value is not a know use, the default setting is used. See org.apache.axis.enum.Style for a description of the interaction between Style/Use

setUse

public void setUse(Use value)

setUse

Parameters:: value - Use setting

setMode

public void setMode(int mode)

Deprecated. (use setStyle and setUse)

setMode (sets style and use)

getMode

public int getMode()

Deprecated. (use getStyle and getUse)

getMode (gets the mode based on the style setting)

Returns:: returns the mode (-1 if invalid)

getServiceDesc

public ServiceDesc getServiceDesc()

setServiceDesc

public void setServiceDesc(ServiceDesc serviceDesc)

getExtraClasses

public Class[] getExtraClasses()

Return the list of extra classes that the emitter will produce WSDL for.

setExtraClasses

public void setExtraClasses(Class[] extraClasses)

Provide a list of classes which the emitter will produce WSDL type definitions for.

setExtraClasses

public void setExtraClasses(String text)
                     throws ClassNotFoundException

Provide a comma or space seperated list of classes which the emitter will produce WSDL type definitions for. The classes will be added to the current list.

Throws:: ClassNotFoundException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`static int`	`MODE_ALL`
`static int`	`MODE_DOC_WRAPPED` DEPRECATED - Indicates style=wrapped use=literal
`static int`	`MODE_DOCUMENT` DEPRECATED - Indicates style=document use=literal
`static int`	`MODE_IMPLEMENTATION`
`static int`	`MODE_INTERFACE`
`static int`	`MODE_RPC` DEPRECATED - Indicates style=rpc use=encoded
`protected static TypeMapping`	`standardTypes`
`protected Types`	`types`

Method Summary
`protected javax.wsdl.Definition`	`createDefinition()` Build a Definition from the input wsdl file or create a new Definition
`protected javax.xml.namespace.QName`	`createMessageName(javax.wsdl.Definition def, String methodName)`
`protected Types`	`createTypes(javax.wsdl.Definition def)` Build a Types object and load the input wsdl types
`Document`	`emit(int mode)` Generates a WSDL document for a given `Class`.
`void`	`emit(String filename)` Generates a complete WSDL document for a given `Class`
`void`	`emit(String filename, int mode)` Generates a WSDL document for a given `Class`.
`void`	`emit(String filename1, String filename2)` Generates WSDL documents for a given `Class`
`String`	`emitToString(int mode)` Generates a String containing the WSDL for a given `Class`.
`Vector`	`getAllowedMethods()` Returns a vector of methods to export
`String`	`getBindingName()` Returns the String representation of the binding name
`Class`	`getCls()` Returns the `Class` to export
`TypeMapping`	`getDefaultTypeMapping()` Returns the default `TypeMapping` used by the service
`String`	`getDescription()` Returns the service description
`Vector`	`getDisallowedMethods()` Return list of methods that should not be exported
`Class[]`	`getExtraClasses()` Return the list of extra classes that the emitter will produce WSDL for.
`Class`	`getImplCls()` Returns the implementation `Class` if set
`String`	`getImplNamespace()` Returns the implementation namespace
`javax.wsdl.Definition`	`getImplWSDL()` Get implementation WSDL `Definition` for the current configuration parameters
`String`	`getImportUrl()` Returns the String representation of the interface import location URL
`String`	`getInputSchema()`
`String`	`getInputWSDL()` Get the name of the input WSDL
`String`	`getIntfNamespace()` Returns the interface namespace
`javax.wsdl.Definition`	`getIntfWSDL()` Get a interface WSDL `Definition` for the current configuration parameters
`String`	`getLocationUrl()` Returns the String representation of the service endpoint URL
`int`	`getMode()` Deprecated. (use getStyle and getUse)
`Map`	`getNamespaceMap()` get the packagename to namespace map
`String`	`getPortTypeName()` Returns the String representation of the portType name
`protected javax.xml.namespace.QName`	`getRequestQName(OperationDesc oper)`
`protected javax.xml.namespace.QName`	`getResponseQName(OperationDesc oper)`
`ServiceDesc`	`getServiceDesc()`
`String`	`getServiceElementName()` Returns the String representation of the service element name
`String`	`getServicePortName()` Returns the String representation of the service port name
`String`	`getSoapAction()` Returns the soapAction option value
`ArrayList`	`getStopClasses()` Return the list of classes which stop inhertance searches
`Style`	`getStyle()` getStyle
`String`	`getTargetService()` Returns the target service name
`TypeMapping`	`getTypeMapping()` Returns the `TypeMapping` used by the service
`Use`	`getUse()` getUse
`boolean`	`getUseInheritedMethods()` Indicates if the emitter will search classes for inherited methods
`javax.wsdl.Definition`	`getWSDL()` Get a Full WSDL `Definition` for the current configuration parameters
`protected void`	`init(int mode)` Invoked prior to building a definition to ensure parms and data are set up.
`protected void`	`prettyDocumentToFile(Document doc, String filename)` Write a prettified document to a file.
`void`	`setAllowedMethods(String text)` Add a list of methods to export
`void`	`setAllowedMethods(Vector allowedMethods)` Add a Vector of methods to export
`void`	`setBindingName(String bindingName)` Set the String representation of the binding name
`void`	`setCls(Class cls)` Sets the `Class` to export
`void`	`setCls(String className)` Sets the `Class` to export
`void`	`setClsSmart(Class cls, String location)` Sets the `Class` to export.
`void`	`setDefaultTypeMapping(TypeMapping defaultTM)` Sets the default `TypeMapping` used by the service
`void`	`setDescription(String description)` Set the service description
`void`	`setDisallowedMethods(String text)` Add a list of methods NOT to export
`void`	`setDisallowedMethods(Vector disallowedMethods)` Add a list of methods NOT to export
`void`	`setExtraClasses(Class[] extraClasses)` Provide a list of classes which the emitter will produce WSDL type definitions for.
`void`	`setExtraClasses(String text)` Provide a comma or space seperated list of classes which the emitter will produce WSDL type definitions for.
`void`	`setImplCls(Class implCls)` Sets the implementation `Class`
`void`	`setImplCls(String className)` Sets the implementation `Class`
`void`	`setImplNamespace(String ns)` Set the implementation namespace
`void`	`setImportUrl(String importUrl)` Set the String representation of the interface location URL for importing
`void`	`setInputSchema(String inputSchema)` Set the name of the input schema
`void`	`setInputWSDL(String inputWSDL)` Set the name of the input WSDL
`void`	`setIntfNamespace(String ns)` Set the interface namespace
`void`	`setLocationUrl(String locationUrl)` Set the String representation of the service endpoint URL
`void`	`setMode(int mode)` Deprecated. (use setStyle and setUse)
`void`	`setNamespaceMap(Map map)` Set the packagename to namespace map with the given map
`void`	`setPortTypeName(String portTypeName)` Set the String representation of the portType name
`void`	`setServiceDesc(ServiceDesc serviceDesc)`
`void`	`setServiceElementName(String serviceElementName)` Set the String representation of the service element name
`void`	`setServicePortName(String servicePortName)` Set the String representation of the service port name
`void`	`setSoapAction(String value)` Sets the soapAction option value
`void`	`setStopClasses(ArrayList stopClasses)` Adds a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation
`void`	`setStopClasses(String text)` Add a list of classes (fully qualified) that will stop the traversal of the inheritance tree if encounter in method or complex type generation
`void`	`setStyle(String value)` setStyle
`void`	`setStyle(Style value)` setStyle
`void`	`setTargetService(String targetService)` Set the target service name
`void`	`setTypeMapping(TypeMapping tm)` Sets the `TypeMapping` used by the service
`void`	`setUse(String value)` setUse
`void`	`setUse(Use value)` setUse
`void`	`setUseInheritedMethods(boolean useInheritedMethods)` Turn on or off inherited method WSDL generation.
`protected javax.wsdl.Binding`	`writeBinding(javax.wsdl.Definition def, boolean add)` Create the binding.
`protected javax.wsdl.BindingOperation`	`writeBindingOperation(javax.wsdl.Definition def, javax.wsdl.Binding binding, javax.wsdl.Operation oper, OperationDesc desc)` Create a Binding Operation
`protected void`	`writeDefinitions(javax.wsdl.Definition def, String tns)` Create the definition header information.
`protected javax.wsdl.Message`	`writeFaultMessage(javax.wsdl.Definition def, FaultDesc exception)` Create a Fault Message
`protected void`	`writeImport(javax.wsdl.Definition def, String tns, String loc)` Create and add an import
`protected void`	`writeMessages(javax.wsdl.Definition def, javax.wsdl.Operation oper, OperationDesc desc, javax.wsdl.BindingOperation bindingOper)` Create a Message
`protected javax.wsdl.BindingOperation`	`writeOperation(javax.wsdl.Definition def, javax.wsdl.Binding binding, OperationDesc desc)` Create a Operation
`String`	`writePartToMessage(javax.wsdl.Definition def, javax.wsdl.Message msg, boolean request, ParameterDesc param)` Create a Part
`protected void`	`writePortType(javax.wsdl.Definition def, javax.wsdl.Binding binding)` Create a PortType
`protected javax.wsdl.Message`	`writeRequestMessage(javax.wsdl.Definition def, OperationDesc oper)` Create a Request Message
`protected javax.wsdl.Message`	`writeResponseMessage(javax.wsdl.Definition def, OperationDesc desc)` Create a Response Message
`protected void`	`writeService(javax.wsdl.Definition def, javax.wsdl.Binding binding)` Create the service.
`protected javax.wsdl.extensions.ExtensibilityElement`	`writeSOAPBody(javax.xml.namespace.QName operQName)`
`protected javax.wsdl.extensions.soap.SOAPFault`	`writeSOAPFault(FaultDesc faultDesc)`
`void`	`writeWrapperPart(javax.wsdl.Definition def, javax.wsdl.Message msg, OperationDesc oper, boolean request)` Write out the schema definition for a WRAPPED operation request or response.

Emitter (JAXRPC API) - JBoss 4.0.1 sp1 jaxrpc API Documentation 英文版文档

org.apache.axis.wsdl.fromJava Class Emitter

MODE_ALL

MODE_INTERFACE

MODE_IMPLEMENTATION

types

MODE_RPC

MODE_DOCUMENT

MODE_DOC_WRAPPED

standardTypes

Emitter

emit

emit

emit

emitToString

emit

getWSDL

getIntfWSDL

getImplWSDL

init

createDefinition

createTypes

writeDefinitions

writeImport

writeBinding

writeService

writePortType

writeMessages

writeOperation

writeBindingOperation

writeSOAPBody

writeSOAPFault

writeRequestMessage

getRequestQName

getResponseQName

writeWrapperPart

writeResponseMessage

writeFaultMessage

writePartToMessage

createMessageName

prettyDocumentToFile

getCls

setCls

setClsSmart

setCls

getImplCls

setImplCls

setImplCls

getIntfNamespace

setIntfNamespace

getImplNamespace

setImplNamespace

getAllowedMethods

setAllowedMethods

setAllowedMethods

getUseInheritedMethods

setUseInheritedMethods

setDisallowedMethods

setDisallowedMethods

getDisallowedMethods

setStopClasses

setStopClasses

getStopClasses

getNamespaceMap

setNamespaceMap

getInputWSDL

setInputWSDL

getInputSchema

setInputSchema

getLocationUrl

setLocationUrl

getImportUrl

setImportUrl

getServicePortName

setServicePortName

getServiceElementName

setServiceElementName

getPortTypeName

setPortTypeName

getBindingName

org.apache.axis.wsdl.fromJava
Class Emitter