org.aselect.system.communication.server
Interface IOutputMessage

All Known Subinterfaces:
IMessageCreatorInterface
All Known Implementing Classes:
RawMessageCreator, SOAP11MessageCreator, SOAP12MessageCreator

public interface IOutputMessage

Defines a interface to a output message which can be used with A-Select.

Description:
Defines an interface to a message that can be used with A-Select. An output message can be created step-by-step and finally sent.

OutputMessage can be used as a interface to the internal messages of the IMessageCreatorInterface. This interface is provided to access the communication in a transparent manner.

The OuputMessage interface only specifies methods for setting information in the output message.

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 boolean send()
          Sends this message.
 boolean setParam(java.lang.String sName, java.lang.String sValue)
          Sets a parameter in the message.
 boolean setParam(java.lang.String sName, java.lang.String[] saValues)
          Sets a array parameter in the message.
 

Method Detail

setParam

boolean setParam(java.lang.String sName,
                 java.lang.String sValue)
                 throws ASelectCommunicationException
Sets a parameter in the message.

Description:
Creates a new paremeter in the output. If the parameter does not yet exsist it is created.

Concurrency issues:
-

Preconditions:

Postconditions:
The ouput message contains the new parameter.

Parameters:
sName - The name of the parameter
sValue - The value of the parameter
Returns:
true - if parameter succesfully set otherwise false.
Throws:
ASelectCommunicationException - If communication fails.

setParam

boolean setParam(java.lang.String sName,
                 java.lang.String[] saValues)
                 throws ASelectCommunicationException
Sets a array parameter in the message.

Description:
Set an array parameter with the given name and values.

Concurrency issues:
-

Preconditions:


Postconditions:
The ouput message contains the new array parameter.

Parameters:
sName - The name of the parameter
saValues - The values of the parameter
Returns:
true - if parameter succesfully set otherwise false.
Throws:
ASelectCommunicationException - If communication fails.

send

boolean send()
             throws ASelectCommunicationException
Sends this message.

Description:
Sends the output message.

Concurrency issues:
A message can only send once.

Preconditions:
The message should at least be initialized.

Postconditions:
The message is send.

Returns:
true if send successfully, otherwise false.
Throws:
ASelectCommunicationException - If communication fails.


Copyright © 2008 SURFnet BV. All Rights Reserved.