nl.nn.adapterframework.http

Class WebServiceNtlmSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.http.WebServiceNtlmSender

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class WebServiceNtlmSender
extends SenderWithParametersBase
implements HasPhysicalDestination

Sender that sends a message via a WebService based on NTLM authentication.

Author:

Peter Leeuwenburgh

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.impl.client.DefaultHttpClient	httpClient

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
WebServiceNtlmSender()

Method Summary

Modifier and Type	Method and Description
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
String	getAuthDomain()
String	getContentType()
int	getMaxConnections()
String	getPhysicalDestinationName()
String	getProxyHost()
int	getProxyPort()
String	getSoapAction()
int	getTimeout()
String	getUrl()
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setAuthAlias(String string) alias used to obtain credentials for authentication to host
void	setAuthDomain(String string)
void	setContentType(String string) content-type of the request
void	setMaxConnections(int i) the maximum number of concurrent connections
void	setPassword(String string) password used to authenticate with the host
void	setProxyHost(String string)
void	setProxyPort(int i)
void	setSoapAction(String string) the soapactionuri to be set in the requestheader
void	setTimeout(int i) timeout in ms of obtaining a connection/result.
void	setUrl(String string) url or base of url to be used
void	setUsername(String string) username used in authentication to host
void	setUserName(String username) Deprecated.

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

createBean, getLogPrefix, getName, isSynchronous, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

httpClient

protected org.apache.http.impl.client.DefaultHttpClient httpClient

Constructor Detail

WebServiceNtlmSender

public WebServiceNtlmSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

open

public void open()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Overrides:

open in class SenderBase

close

public void close()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderBase

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException,
                                TimeoutException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setContentType

public void setContentType(String string)

content-type of the request

Default value

text/html; charset=utf-8

getContentType

public String getContentType()

getUrl

public String getUrl()

setUrl

public void setUrl(String string)

url or base of url to be used

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int i)

timeout in ms of obtaining a connection/result. 0 means no timeout

Default value

10000

getMaxConnections

public int getMaxConnections()

setMaxConnections

public void setMaxConnections(int i)

the maximum number of concurrent connections

Default value

10

setAuthAlias

public void setAuthAlias(String string)

alias used to obtain credentials for authentication to host

setUsername

public void setUsername(String string)

username used in authentication to host

setUserName

@Deprecated
 @ConfigurationWarning(value="Please use attribute username instead")
public void setUserName(String username)

Deprecated.

setPassword

public void setPassword(String string)

password used to authenticate with the host

Default value

getAuthDomain

public String getAuthDomain()

setAuthDomain

public void setAuthDomain(String string)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String string)

Default value

getProxyPort

public int getProxyPort()

setProxyPort

public void setProxyPort(int i)

Default value

80

getSoapAction

public String getSoapAction()

setSoapAction

public void setSoapAction(String string)

the soapactionuri to be set in the requestheader