org.aselect.system.communication.server
Interface IInputMessage

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

public interface IInputMessage

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

Description:
An IInputMessage can be used as an interface to the internal messages of the IMessageCreatorInterface. This interface is provided to access the communication in a transparent manner.

The IInputMessage interface only specifies methods for retrieving information from the message. An input message is normally created from an inputstream.

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 java.lang.String[] getArray(java.lang.String sName)
          Get array Parameter values from this message.
 java.lang.String getParam(java.lang.String sName)
          Get a Parameter value from this message.
 

Method Detail

getParam

java.lang.String getParam(java.lang.String sName)
                          throws ASelectCommunicationException
Get a Parameter value from this message.

Description:
Returns a parameter value from the message. The parameters are name/value pairs; the name of the value must be specified.

Concurrency issues:
-

Preconditions:
sName must contain a valid parameter name.

Postconditions:
-

Parameters:
sName - The name of the parameter to return.
Returns:
The value of the queried parameter.
Throws:
ASelectCommunicationException - If parameter retrieving fails.

getArray

java.lang.String[] getArray(java.lang.String sName)
                            throws ASelectCommunicationException
Get array Parameter values from this message.

Description:
Returns an array of values from the parameter with the given name.

Concurrency issues:
-

Preconditions:
sName must contain a valid parameter name.

Postconditions:
-

Parameters:
sName - The name of the parameter to return.
Returns:
An array of all values belonging to the queried parameter.
Throws:
ASelectCommunicationException - If parameter retrieving fails.


Copyright © 2008 SURFnet BV. All Rights Reserved.