org.apache.axis.wsdl.toJava

Class Emitter

public class Emitter extends Parser

This class produces java files for stubs, skeletons, and types from a WSDL document.

Author: Russell Butek (butek@us.ibm.com) Tom Jordahl (tjordahl@macromedia.com) Rich Scheuerle (scheu@us.ibm.com) Steve Graham (sggraham@us.ibm.com)

Field Summary
protected BaseTypeMapping	baseTypeMapping Field baseTypeMapping
static String	DEFAULT_NSTOPKG_FILE Field DEFAULT_NSTOPKG_FILE
protected HashMap	namespaceMap Field namespaceMap
protected Namespaces	namespaces Field namespaces
protected List	nsExcludes Field nsIncludes - defines a list of namespaces to specifically exclude from generated source code.
protected List	nsIncludes Field nsIncludes - defines a list of namespaces to specifically include in the generated source code.
protected String	NStoPkgFilename Field NStoPkgFilename
protected List	properties Field properties - defines a set of general purpose properties that can be used by custom JavaGeneratorFactories.
protected String	typeMappingVersion Field typeMappingVersion

Constructor Summary
	Emitter() Default constructor.

Method Summary
void	debug(boolean value) Turn on/off debug messages.
void	deploySkeleton(boolean value) Turn on/off server skeleton deploy
protected boolean	doesExist(String className) Check if the className exists.
void	emit(String uri) Call this method if you have a uri for the WSDL document
void	emit(String context, Document doc) Call this method if your WSDL document has already been parsed as an XML DOM document.
void	generateAll(boolean all)
void	generateImports(boolean generateImports) Turn on/off generation of elements from imported files.
void	generateServerSide(boolean value) Turn on/off server-side binding generation
void	generateTestCase(boolean value) Turn on/off test case creation
boolean	getDebug() Return the status of the debug switch.
TypeMapping	getDefaultTypeMapping() Returns the default `TypeMapping` used by the service
boolean	getDeploySkeleton() Indicate if we should be deploying skeleton or implementation
List	getGeneratedClassNames() This method returns a list of all generated class names.
GeneratedFileInfo	getGeneratedFileInfo() Returns an object which contains of information on all generated files including the class name, filename and a type string.
List	getGeneratedFileNames() This method returns a list of all generated file names.
boolean	getGenerateServerSide() Indicate if we should be emitting server side code and deploy/undeploy
boolean	getHelperGeneration() Indicate if we should be generating Helper classes
String	getImplementationClassName() Get an implementation classname to use instead of the default.
String	getJavaName(QName qName) Convert the specified QName into a full Java Name.
protected String	getJavaNameHook(QName qname)
String	getJavaVariableName(QName typeQName, QName xmlName, boolean isElement)
protected String	getJavaVariableNameHook(QName typeQName, QName xmlName, boolean isElement)
List	getNamespaceExcludes() Returns the list of excludes to specifically exclude from the generated source.
List	getNamespaceIncludes() Returns the list of namespaces specifically excluded from the generated code.
HashMap	getNamespaceMap() Get the map of namespace -> Java package names
Namespaces	getNamespaces() Method getNamespaces
String	getOutputDir() Get the output directory to use for emitted source files
String	getPackage(String namespace) Get the Package name for the specified namespace
String	getPackage(QName qName) Get the Package name for the specified QName
String	getPackageName() Get global package name to use instead of mapping namespaces
List	getProperties() Gets the list of extension properties for custom JavaGeneratorFactories.
HashMap	getQName2ClassMap() Get the type qname to java class map
Scope	getScope() Get the scope for the deploy.xml file.
ServiceDesc	getServiceDesc() Retruns the SericeDesc object
String	getTypeMappingVersion() Get the typemapping version
boolean	getVerbose() Return the status of the verbose switch
GeneratorFactory	getWriterFactory() Get the GeneratorFactory.
boolean	isAllowInvalidURL()
boolean	isAllWanted() Method isAllWanted
boolean	isBuildFileWanted() get the build file genaeration state
boolean	isDeploy() Returns the deploy mode flag
boolean	isHelperWanted() Indicate if we should be generating Helper classes
boolean	isServerSide() Indicate if we should be emitting server side code and deploy/undeploy
boolean	isSkeletonWanted() Indicate if we should be deploying skeleton or implementation
boolean	isTestCaseWanted() Method isTestCaseWanted
boolean	isTypeCollisionProtection() Get the type collision protection setting
void	run(String wsdlURL) Emit appropriate Java files for a WSDL at a given URL.
void	run(String context, Document doc) Call this method if your WSDL document has already been parsed as an XML DOM document.
protected void	sanityCheck(SymbolTable symbolTable) Method sanityCheck
void	setAllowInvalidURL(boolean allowInvalidURL)
void	setAllWanted(boolean all) By default, code is generated only for referenced elements.
void	setBuildFileWanted(boolean value) turn the build file genaration ON
void	setDefaultTypeMapping(TypeMapping defaultTM) Sets the default `TypeMapping` used by the service
void	setDeploy(boolean isDeploy) Sets the deploy mode flag
void	setFactory(String factory) Sets the `WriterFactory Class` to use
void	setHelperGeneration(boolean value) Turn on/off Helper class generation
void	setHelperWanted(boolean value) Turn on/off Helper class generation
void	setImplementationClassName(String implementationClassName) Set an implementation classname to use instead of the default.
void	setNamespaceExcludes(List nsExcludes) Sets the list of namespaces to specifically exclude from the generated source.
void	setNamespaceIncludes(List nsIncludes) Sets the list of namespaces to specifically include in the generated code.
void	setNamespaceMap(HashMap map) Set a map of namespace -> Java package names
void	setNStoPkg(String NStoPkgFilename) Set the NStoPkg mappings filename.
void	setOutputDir(String outputDir) Set the output directory to use in emitted source files
void	setPackageName(String packageName) Set a global package name to use instead of mapping namespaces
void	setProperties(List properties) Sets the list of extension properties for custom JavaGeneratorFactories.
void	setQName2ClassMap(HashMap map) Set the type qname to java class map
void	setScope(Scope scope) Set the scope for the deploy.xml file.
void	setServerSide(boolean value) Turn on/off server skeleton creation
void	setServiceDesc(ServiceDesc serviceDesc) Sets the ServicdDesc object
void	setSkeletonWanted(boolean value) Turn on/off server skeleton deploy
void	setTestCaseWanted(boolean value) Turn on/off test case creation
void	setTypeCollisionProtection(boolean value) Enable/disable type collision protection
void	setTypeMappingVersion(String typeMappingVersion) Method setTypeMappingVersion
void	setWrapArrays(boolean wrapArrays)
void	verbose(boolean value) Turn on/off verbose messages

Field Detail

baseTypeMapping

protected BaseTypeMapping baseTypeMapping

Field baseTypeMapping

DEFAULT_NSTOPKG_FILE

public static final String DEFAULT_NSTOPKG_FILE

Field DEFAULT_NSTOPKG_FILE

namespaceMap

protected HashMap namespaceMap

Field namespaceMap

namespaces

protected Namespaces namespaces

Field namespaces

nsExcludes

protected List nsExcludes

Field nsIncludes - defines a list of namespaces to specifically exclude from generated source code. Any entry in this list that is in conflict with the includes list should be ignored and generated.

Field nsIncludes - defines a list of namespaces to specifically include in the generated source code. If non-empty, anything not in this list should be excluded. If empty, everything in this and not specifically excluded should be generated.

NStoPkgFilename

protected String NStoPkgFilename

Field NStoPkgFilename

properties

protected List properties

Field properties - defines a set of general purpose properties that can be used by custom JavaGeneratorFactories.

typeMappingVersion

protected String typeMappingVersion

Field typeMappingVersion

Constructor Detail

Emitter

public Emitter()

Default constructor.

Method Detail

debug

public void debug(boolean value)

Deprecated: Use setDebug(value)

Turn on/off debug messages.

Parameters: value

deploySkeleton

public void deploySkeleton(boolean value)

Deprecated: Use setSkeletonWanted(value)

Turn on/off server skeleton deploy

Parameters: value

doesExist

protected boolean doesExist(String className)

Check if the className exists.

Parameters: className className to check

Returns: true if exists, false if not

emit

public void emit(String uri)

Deprecated: Call run(uri) instead.

Call this method if you have a uri for the WSDL document

Parameters: uri wsdlURI the location of the WSDL file.

Throws: Exception

emit

public void emit(String context, Document doc)

Deprecated: Call run(context, doc) instead.

Call this method if your WSDL document has already been parsed as an XML DOM document.

Parameters: context context This is directory context for the Document. If the Document were from file "/x/y/z.wsdl" then the context could be "/x/y" (even "/x/y/z.wsdl" would work). If context is null, then the context becomes the current directory. doc doc This is the XML Document containing the WSDL.

Throws: IOException SAXException WSDLException ParserConfigurationException

generateAll

public void generateAll(boolean all)

Deprecated: Use setAllWanted(all)

Parameters: all

generateImports

public void generateImports(boolean generateImports)

Deprecated: Use setImports(generateImports)

Turn on/off generation of elements from imported files.

Parameters: generateImports

generateServerSide

public void generateServerSide(boolean value)

Deprecated: Use setServerSide(value)

Turn on/off server-side binding generation

Parameters: value

generateTestCase

public void generateTestCase(boolean value)

Deprecated: Use setTestCaseWanted()

Turn on/off test case creation

Parameters: value

getDebug

public boolean getDebug()

Deprecated: Use isDebug()

Return the status of the debug switch.

Returns:

getDefaultTypeMapping

public TypeMapping getDefaultTypeMapping()

Returns the default TypeMapping used by the service

Returns: the default TypeMapping used by the service

getDeploySkeleton

public boolean getDeploySkeleton()

Deprecated: Use isSkeletonWanted()

Indicate if we should be deploying skeleton or implementation

Returns:

getGeneratedClassNames

public List getGeneratedClassNames()

This method returns a list of all generated class names.

Returns:

getGeneratedFileInfo

public GeneratedFileInfo getGeneratedFileInfo()

Returns an object which contains of information on all generated files including the class name, filename and a type string.

Returns: An org.apache.axis.wsdl.toJava.GeneratedFileInfo object

getGeneratedFileNames

public List getGeneratedFileNames()

This method returns a list of all generated file names.

Returns:

getGenerateServerSide

public boolean getGenerateServerSide()

Deprecated: Use isServerSide()

Indicate if we should be emitting server side code and deploy/undeploy

Returns:

getHelperGeneration

public boolean getHelperGeneration()

Deprecated: Use isHelperWanted()

Indicate if we should be generating Helper classes

Returns:

getImplementationClassName

public String getImplementationClassName()

Get an implementation classname to use instead of the default.

Returns:

getJavaName

public String getJavaName(QName qName)

Convert the specified QName into a full Java Name.

Parameters: qName

Returns:

getJavaNameHook

protected String getJavaNameHook(QName qname)

getJavaVariableName

public String getJavaVariableName(QName typeQName, QName xmlName, boolean isElement)

Parameters: typeQName QName for containing xml type xmlName QName for element

Returns:

getJavaVariableNameHook

protected String getJavaVariableNameHook(QName typeQName, QName xmlName, boolean isElement)

getNamespaceExcludes

public List getNamespaceExcludes()

Returns the list of excludes to specifically exclude from the generated source.

getNamespaceIncludes

public List getNamespaceIncludes()

Returns the list of namespaces specifically excluded from the generated code.

getNamespaceMap

public HashMap getNamespaceMap()

Get the map of namespace -> Java package names

Returns:

getNamespaces

public Namespaces getNamespaces()

Method getNamespaces

Returns:

getOutputDir

public String getOutputDir()

Get the output directory to use for emitted source files

Returns:

getPackage

public String getPackage(String namespace)

Get the Package name for the specified namespace

Parameters: namespace

Returns:

getPackage

public String getPackage(QName qName)

Get the Package name for the specified QName

Parameters: qName

Returns:

getPackageName

public String getPackageName()

Get global package name to use instead of mapping namespaces

Returns:

getProperties

public List getProperties()

Gets the list of extension properties for custom JavaGeneratorFactories.

getQName2ClassMap

public HashMap getQName2ClassMap()

Get the type qname to java class map

Returns: the type qname to java class map

getScope

public Scope getScope()

Get the scope for the deploy.xml file.

Returns:

getServiceDesc

public ServiceDesc getServiceDesc()

Retruns the SericeDesc object

Returns:

getTypeMappingVersion

public String getTypeMappingVersion()

Get the typemapping version

getVerbose

public boolean getVerbose()

Deprecated: Use isVerbose()

Return the status of the verbose switch

Returns:

getWriterFactory

public GeneratorFactory getWriterFactory()

Deprecated: Call getFactory instead. This doesn't return a WriterFactory, it returns a GeneratorFactory.

Get the GeneratorFactory.

Returns:

isAllowInvalidURL

public boolean isAllowInvalidURL()

Returns: Returns the allowInvalidURL.

isAllWanted

public boolean isAllWanted()

Method isAllWanted

Returns:

isBuildFileWanted

public boolean isBuildFileWanted()

get the build file genaeration state

Returns:

isDeploy

public boolean isDeploy()

Returns the deploy mode flag

Returns:

isHelperWanted

public boolean isHelperWanted()

Indicate if we should be generating Helper classes

Returns:

isServerSide

public boolean isServerSide()

Indicate if we should be emitting server side code and deploy/undeploy

Returns:

isSkeletonWanted

public boolean isSkeletonWanted()

Indicate if we should be deploying skeleton or implementation

Returns:

isTestCaseWanted

public boolean isTestCaseWanted()

Method isTestCaseWanted

Returns:

isTypeCollisionProtection

public boolean isTypeCollisionProtection()

Get the type collision protection setting

Returns:

run

public void run(String wsdlURL)

Emit appropriate Java files for a WSDL at a given URL.

This method will time out after the number of milliseconds specified by our timeoutms member.

Parameters: wsdlURL

Throws: Exception

run

public void run(String context, Document doc)

Call this method if your WSDL document has already been parsed as an XML DOM document.

Throws: IOException SAXException WSDLException ParserConfigurationException

sanityCheck

protected void sanityCheck(SymbolTable symbolTable)

Method sanityCheck

Parameters: symbolTable

setAllowInvalidURL

public void setAllowInvalidURL(boolean allowInvalidURL)

Parameters: allowInvalidURL The allowInvalidURL to set.

setAllWanted

public void setAllWanted(boolean all)

By default, code is generated only for referenced elements. Call bGenerateAll(true) and WSDL2Java will generate code for all elements in the scope regardless of whether they are referenced. Scope means: by default, all WSDL files; if generateImports(false), then only the immediate WSDL file.

Parameters: all

setBuildFileWanted

public void setBuildFileWanted(boolean value)

turn the build file genaration ON

Parameters: value

setDefaultTypeMapping

public void setDefaultTypeMapping(TypeMapping defaultTM)

Sets the default TypeMapping used by the service

Parameters: defaultTM the default TypeMapping used by the service

setDeploy

public void setDeploy(boolean isDeploy)

Sets the deploy mode flag

Parameters: isDeploy deploy mode flag

setFactory

public void setFactory(String factory)

Sets the WriterFactory Class to use

Parameters: factory the name of the factory Class

setHelperGeneration

public void setHelperGeneration(boolean value)

Deprecated: Use setHelperWanted(value)

Turn on/off Helper class generation

Parameters: value

setHelperWanted

public void setHelperWanted(boolean value)

Turn on/off Helper class generation

Parameters: value

setImplementationClassName

public void setImplementationClassName(String implementationClassName)

Set an implementation classname to use instead of the default.

Parameters: implementationClassName

Parameters: map

setNStoPkg

public void setNStoPkg(String NStoPkgFilename)

Set the NStoPkg mappings filename.

Parameters: NStoPkgFilename

setOutputDir

public void setOutputDir(String outputDir)

Set the output directory to use in emitted source files

Parameters: outputDir

setPackageName

public void setPackageName(String packageName)

Set a global package name to use instead of mapping namespaces

Parameters: packageName

setProperties

public void setProperties(List properties)

Sets the list of extension properties for custom JavaGeneratorFactories.

setQName2ClassMap

public void setQName2ClassMap(HashMap map)

Set the type qname to java class map

Parameters: map a type qname to javaclass map (from Java2Wsdl emitter)

setScope

public void setScope(Scope scope)

Set the scope for the deploy.xml file.

Parameters: scope One of 'null', Scope.APPLICATION, Scope.REQUEST, Scope.SESSION. Anything else is equivalent to 'null' null and no explicit scope tag will appear in deploy.xml.