Package org.springframework.ws.transport.mail

Class MailReceiverConnection

java.lang.Object

org.springframework.ws.transport.AbstractWebServiceConnection

org.springframework.ws.transport.AbstractReceiverConnection

org.springframework.ws.transport.mail.MailReceiverConnection

All Implemented Interfaces:

AutoCloseable, HeadersAwareReceiverWebServiceConnection, WebServiceConnection

public class MailReceiverConnection
extends AbstractReceiverConnection

Implementation of WebServiceConnection that is used for server-side Mail access. Exposes a Message request and response message.

Since:

1.5.0

Author:

Arjen Poutsma, Greg Turnquist

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MailReceiverConnection(jakarta.mail.Message requestMessage, jakarta.mail.Session session)	Constructs a new Mail connection with the given parameters.

Method Summary

Modifier and Type	Method	Description
void	addResponseHeader(String name, String value)	Adds a response header with the given name and value.
String	getErrorMessage()	Returns the error message.
Iterator<String>	getRequestHeaderNames()	Returns an iteration over all the header names this request contains.
Iterator<String>	getRequestHeaders(String name)	Returns an iteration over all the string values of the specified header.
protected InputStream	getRequestInputStream()	Returns the input stream to read the response from.
jakarta.mail.Message	getRequestMessage()	Returns the request message for this connection.
jakarta.mail.Message	getResponseMessage()	Returns the response message, if any, for this connection.
protected OutputStream	getResponseOutputStream()	Returns the output stream to write the request to.
URI	getUri()	Returns the URI for this connection.
boolean	hasError()	Indicates whether this connection has an error.
protected void	onSendAfterWrite(WebServiceMessage message)	Called after the given message has been written to the TransportOutputStream.
protected void	onSendBeforeWrite(WebServiceMessage message)	Called before the given message has been written to the TransportOutputStream.

Methods inherited from class org.springframework.ws.transport.AbstractReceiverConnection

createTransportInputStream, createTransportOutputStream, onClose

Methods inherited from class org.springframework.ws.transport.AbstractWebServiceConnection

close, onReceiveAfterRead, onReceiveBeforeRead, receive, send

Methods inherited from class java.lang.Object

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

Constructor Details

MailReceiverConnection

protected MailReceiverConnection(jakarta.mail.Message requestMessage,
 jakarta.mail.Session session)

Constructs a new Mail connection with the given parameters.

Method Details

getRequestMessage

public jakarta.mail.Message getRequestMessage()

Returns the request message for this connection.

getResponseMessage

public jakarta.mail.Message getResponseMessage()

Returns the response message, if any, for this connection.

getUri

public URI getUri()
           throws URISyntaxException

Description copied from interface: WebServiceConnection

Returns the URI for this connection.

Throws:

URISyntaxException

getErrorMessage

public String getErrorMessage()
                       throws IOException

Description copied from interface: WebServiceConnection

Returns the error message.

Returns:

the connection error message, if any; returns null when no error is present

Throws:

IOException

See Also:

• WebServiceConnection.hasError()

hasError

public boolean hasError()
                 throws IOException

Description copied from interface: WebServiceConnection

Indicates whether this connection has an error. Typically, error detection is done by inspecting connection error codes, etc.

Returns:

true if this connection has an error; false otherwise.

Throws:

IOException

getRequestHeaderNames

public Iterator<String> getRequestHeaderNames()
                                       throws IOException

Description copied from interface: HeadersAwareReceiverWebServiceConnection

Returns an iteration over all the header names this request contains. Returns an empty Iterator if there are no headers.

Throws:

IOException

getRequestHeaders

public Iterator<String> getRequestHeaders(String name)
                                   throws IOException

Description copied from interface: HeadersAwareReceiverWebServiceConnection

Returns an iteration over all the string values of the specified header. Returns an empty Iterator if there are no headers of the specified name.

Throws:

IOException

getRequestInputStream

protected InputStream getRequestInputStream()
                                     throws IOException

Description copied from class: AbstractReceiverConnection

Returns the input stream to read the response from.

Specified by:

getRequestInputStream in class AbstractReceiverConnection

Throws:

IOException

addResponseHeader

public void addResponseHeader(String name,
 String value)
                       throws IOException

Description copied from interface: HeadersAwareReceiverWebServiceConnection

Adds a response header with the given name and value. This method can be called multiple times, to allow for headers with multiple values.

Parameters:

name - the name of the header

value - the value of the header

Throws:

IOException

getResponseOutputStream

protected OutputStream getResponseOutputStream()
                                        throws IOException

Description copied from class: AbstractReceiverConnection

Returns the output stream to write the request to.

Specified by:

getResponseOutputStream in class AbstractReceiverConnection

Throws:

IOException

onSendBeforeWrite

protected void onSendBeforeWrite(WebServiceMessage message)
                          throws IOException

Description copied from class: AbstractWebServiceConnection

Called before the given message has been written to the TransportOutputStream. Called from AbstractWebServiceConnection.send(WebServiceMessage).

Default implementation does nothing.

Overrides:

onSendBeforeWrite in class AbstractWebServiceConnection

Parameters:

message - the message

Throws:

IOException - when an I/O exception occurs

onSendAfterWrite

protected void onSendAfterWrite(WebServiceMessage message)
                         throws IOException

Description copied from class: AbstractWebServiceConnection

Called after the given message has been written to the TransportOutputStream. Called from AbstractWebServiceConnection.send(WebServiceMessage).

Default implementation does nothing.

Overrides:

onSendAfterWrite in class AbstractWebServiceConnection

Parameters:

message - the message

Throws:

IOException - when an I/O exception occurs