|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.wsf.spi.tools.WSContractProvider
public abstract class WSContractProvider
WSContractProvider is responsible for generating the required portable JAX-WS artifacts for a service endpoint implementation. This includes class files for wrapper types and fault beans. WSDL may be optionally generated as well using this API.
The following example generates class files, source files and WSDL for an endpoint:
WSContractProvider provider = WSContractProvider.newInstance(); provider.setGenerateSource(true); provider.setGenerateWsdl(true); provider.setOutputDirectory(new File("output")); provider.setMessageStream(System.out); provider.provide(TestMe.class);
Thread-Safety:
This class expects to be thread-confined, so it can not be shared between threads.
Field Summary | |
---|---|
static java.lang.String |
PROVIDER_PROPERTY
|
Constructor Summary | |
---|---|
protected |
WSContractProvider()
|
Method Summary | |
---|---|
static WSContractProvider |
newInstance()
Obtain a new instance of a WSContractProvider. |
static WSContractProvider |
newInstance(java.lang.ClassLoader loader)
Obtain a new instance of a WSContractProvider. |
abstract void |
provide(java.lang.Class<?> endpointClass)
Generates artifacts using the current settings. |
abstract void |
provide(java.lang.String endpointClass)
Generates artifacts using the current settings. |
abstract void |
setClassLoader(java.lang.ClassLoader loader)
Sets the ClassLoader used to discover types. |
abstract void |
setGenerateSource(boolean generateSource)
Enables/Disables Java source generation. |
abstract void |
setGenerateWsdl(boolean generateWsdl)
Enables/Disables WSDL generation. |
abstract void |
setMessageStream(java.io.PrintStream messageStream)
Sets the PrintStream to use for status feedback. |
abstract void |
setOutputDirectory(java.io.File directory)
Sets the main output directory. |
abstract void |
setResourceDirectory(java.io.File directory)
Sets the resource directory. |
abstract void |
setSourceDirectory(java.io.File directory)
Sets the source directory. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROVIDER_PROPERTY
Constructor Detail |
---|
protected WSContractProvider()
Method Detail |
---|
public static WSContractProvider newInstance()
public static WSContractProvider newInstance(java.lang.ClassLoader loader)
loader
- the ClassLoader to use
public abstract void setGenerateWsdl(boolean generateWsdl)
generateWsdl
- whether or not to generate WSDLpublic abstract void setGenerateSource(boolean generateSource)
generateSource
- whether or not to generate Java source.public abstract void setOutputDirectory(java.io.File directory)
directory
- the root directory for generated filespublic abstract void setResourceDirectory(java.io.File directory)
directory
- the root directory for generated resource filespublic abstract void setSourceDirectory(java.io.File directory)
directory
- the root directory for generated source codepublic abstract void setClassLoader(java.lang.ClassLoader loader)
loader
- the ClassLoader to usepublic abstract void provide(java.lang.String endpointClass)
endpointClass
- the name of the endpoint implementation bean
java.lang.RuntimeException
- if any error occurs during processing, or the class is not foundpublic abstract void provide(java.lang.Class<?> endpointClass)
endpointClass
- the endpoint implementation bean
java.lang.RuntimeException
- if any error occurs during processingpublic abstract void setMessageStream(java.io.PrintStream messageStream)
Example output:
Generating WSDL: TestMeService.wsdl Writing Source: org/jboss/ws/tools/jaxws/TestMe.java org/jboss/ws/tools/jaxws/TestMeResponse.java Writing Classes: org/jboss/ws/tools/jaxws/TestMe.class org/jboss/ws/tools/jaxws/TestMeResponse.class
messageStream
- the stream to use for status messages:
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |