org.aselect.system.communication.server
Interface IMessageCreatorInterface

All Superinterfaces:
IInputMessage, IOutputMessage
All Known Implementing Classes:
RawMessageCreator, SOAP11MessageCreator, SOAP12MessageCreator

public interface IMessageCreatorInterface
extends IInputMessage, IOutputMessage

Defines a common interface for a message creator.

Description:
The IMessageCreatorInterface is used to provide a bridge between implementation and interface. This interface can be implemented for several protocols (e.g. SOAP) and can be used in a Communicator.

For every protocol a new Creator must be created which implements this interface. The IMessageCreatorInterface supplies only a method for initialisation

The request is used to create an input message object. The response is used to create an output message with corresponding properties (HTTP Headers) that can be sent back to the requester.

Concurrency issues:
Some implementations of the IMessageCreatorInterface can use none thread safe internal representations.

Author:
Alfa & Ariss

Method Summary
 boolean init(IProtocolRequest oRequest, IProtocolResponse oResponse)
          Initializes the message creator.
 
Methods inherited from interface org.aselect.system.communication.server.IInputMessage
getArray, getParam
 
Methods inherited from interface org.aselect.system.communication.server.IOutputMessage
send, setParam, setParam
 

Method Detail

init

boolean init(IProtocolRequest oRequest,
             IProtocolResponse oResponse)
             throws ASelectCommunicationException
Initializes the message creator.

Description:
Specifies a common method for initializing a IMessageCreatorInterface implementation.

Concurrency issues:
Make sure init() is called once in the process.

Preconditions:
Postconditions:

Parameters:
oRequest - The request to create an input message from.
oResponse - The response to write the output message to.
Returns:
true - if initialization was succesfull.
false - if initialization fails.
Throws:
ASelectCommunicationException - if communication fails.


Copyright © 2008 SURFnet BV. All Rights Reserved.