org.jboss.wise.core.client.builder

Interface WSDynamicClientBuilder

All Known Implementing Classes:

CXFDynamicClientBuilder, ReflectionBasedWSDynamicClientBuilder

@ThreadSafe
public interface WSDynamicClientBuilder

WSDynamicClientBuilder is an interface to define builder for various kind of implementation of WiseDynamicClient Indirect build permit to easy inject different implementation of WSDynamicClient.

Author:

stefano.maestri@javalinux.it

Method Summary

Modifier and Type	Method and Description
WSDynamicClientBuilder	bindingFiles(List<File> bindings) set the list of JAXB bindings files used by wsconsume
WSDynamicClient	build() Build the WSDynamicClient with all parameters set on this class
WSDynamicClientBuilder	catalogFile(File catelog) set the catelog file
WSDynamicClientBuilder	excludeNonSOAPPorts(boolean exclude) if it set to true non-SOAP wsdl ports will be excluded
List<File>	getBindingFiles()
File	getCatalogFile()
String	getClientSpecificTmpDir()
int	getMaxThreadPoolSize()
PrintStream	getMessageStream()
String	getNormalizedWsdlUrl()
String	getPassword()
String	getSecurityConfigFileURL()
String	getSecurityConfigName()
String	getTargetPackage()
String	getTmpDir()
String	getUserName()
String	getWsdlURL()
boolean	isExcludeNonSOAPPorts()
boolean	isKeepSource()
boolean	isVerbose()
WSDynamicClientBuilder	keepSource(boolean bool) if it it set to true source code generated for client classes will be kept in tmpDir(String)
WSDynamicClientBuilder	maxThreadPoolSize(int maxThreadPoolSize) Set the max size of thread pool used to invoke in parallel WSMethod on the build WSDynamicClient.
WSDynamicClientBuilder	messageStream(PrintStream messageStream) Sets the PrintStream to use for status feedback.
WSDynamicClientBuilder	password(String password) set the password used in Basic Auth both for downloading wsdl and calling service
WSDynamicClientBuilder	securityConfigName(String name) It is the config name sed by JbossWS to enable WS-SE.
WSDynamicClientBuilder	securityConfigUrl(String url) It is the URL of config file used by JbossWS to enable WS-SE.
WSDynamicClientBuilder	targetPackage(String targetPackage) force the package name used for generated client classes.
WSDynamicClientBuilder	tmpDir(String tmpDir) set the temp direcoory location used to generate temporary client classes.
WSDynamicClientBuilder	userName(String userName) set the userName used in Basic Auth both for downloading wsdl and calling service
WSDynamicClientBuilder	verbose(boolean bool) if it set to true wsconsume operation of class generation and compilation will be verbose and its messages will be put on messageStream(PrintStream)
WSDynamicClientBuilder	wsdlURL(String wsdlURL) Set the wsdlURL to generate WS client

Method Detail

build

WSDynamicClient build()
               throws IllegalStateException,
                      ConnectException,
                      WiseRuntimeException

Build the WSDynamicClient with all parameters set on this class

Returns:

WSDynamicClient

Throws:

IllegalStateException

ConnectException

WiseRuntimeException

wsdlURL

WSDynamicClientBuilder wsdlURL(String wsdlURL)

Set the wsdlURL to generate WS client

Parameters:

wsdlURL -

Returns:

WSDynamicClient

userName

WSDynamicClientBuilder userName(String userName)

set the userName used in Basic Auth both for downloading wsdl and calling service

Parameters:

userName -

Returns:

WSDynamicClient

password

WSDynamicClientBuilder password(String password)

set the password used in Basic Auth both for downloading wsdl and calling service

Parameters:

password -

Returns:

WSDynamicClient

tmpDir

WSDynamicClientBuilder tmpDir(String tmpDir)

set the temp direcoory location used to generate temporary client classes. Wise will generate there subdirecoty fo each instance of WSDynamicClient and take care of all cleanup when WSDynamicClient.close() is called

Parameters:

tmpDir -

Returns:

WSDynamicClient

targetPackage

WSDynamicClientBuilder targetPackage(String targetPackage)

force the package name used for generated client classes. If it is't set wsconsume rules will e used: namespaces and/or bindingfiles

Parameters:

targetPackage -

Returns:

WSDynamicClient

bindingFiles

WSDynamicClientBuilder bindingFiles(List<File> bindings)

set the list of JAXB bindings files used by wsconsume

Parameters:

bindings -

Returns:

WSDynamicClient

catalogFile

WSDynamicClientBuilder catalogFile(File catelog)

set the catelog file

Parameters:

catelog -

Returns:

WSDynamicClient

securityConfigUrl

WSDynamicClientBuilder securityConfigUrl(String url)

It is the URL of config file used by JbossWS to enable WS-SE. For more information about this file refer to our samples and/or to JBossWS documentation

Parameters:

url -

Returns:

WSDynamicClient

securityConfigName

WSDynamicClientBuilder securityConfigName(String name)

It is the config name sed by JbossWS to enable WS-SE. For more information about this file refer to our samples and/or to JBossWS documentation

Parameters:

name -

Returns:

WSDynamicClient

keepSource

WSDynamicClientBuilder keepSource(boolean bool)

if it it set to true source code generated for client classes will be kept in tmpDir(String)

Parameters:

bool -

Returns:

WSDynamicClient

verbose

WSDynamicClientBuilder verbose(boolean bool)

if it set to true wsconsume operation of class generation and compilation will be verbose and its messages will be put on messageStream(PrintStream)

Parameters:

bool -

Returns:

WSDynamicClient

excludeNonSOAPPorts

WSDynamicClientBuilder excludeNonSOAPPorts(boolean exclude)

if it set to true non-SOAP wsdl ports will be excluded

Parameters:

bool -

Returns:

WSDynamicClient

messageStream

WSDynamicClientBuilder messageStream(PrintStream messageStream)

Sets the PrintStream to use for status feedback. The simplest example would be to use System.out.

Parameters:

messageStream -

Returns:

WSDynamicClient

maxThreadPoolSize

WSDynamicClientBuilder maxThreadPoolSize(int maxThreadPoolSize)

Set the max size of thread pool used to invoke in parallel WSMethod on the build WSDynamicClient. default value is 100.

Parameters:

maxThreadPoolSize -

Returns:

WSDynamicClient

getWsdlURL

String getWsdlURL()

getUserName

String getUserName()

getPassword

String getPassword()

getTmpDir

String getTmpDir()

getTargetPackage

String getTargetPackage()

getBindingFiles

List<File> getBindingFiles()

getCatalogFile

File getCatalogFile()

getSecurityConfigFileURL

String getSecurityConfigFileURL()

getSecurityConfigName

String getSecurityConfigName()

isKeepSource

boolean isKeepSource()

isVerbose

boolean isVerbose()

isExcludeNonSOAPPorts

boolean isExcludeNonSOAPPorts()

getMessageStream

PrintStream getMessageStream()

getNormalizedWsdlUrl

String getNormalizedWsdlUrl()

getClientSpecificTmpDir

String getClientSpecificTmpDir()

getMaxThreadPoolSize

int getMaxThreadPoolSize()