org.aselect.system.communication.server
Interface IProtocolRequest

All Known Implementing Classes:
ServletRequestWrapper, TCPProtocolRequest

public interface IProtocolRequest

Defines an interface to the request part of a protocol.

Description:
This interface contains methods to access data and control information of the request.

Concurrency issues:
-

Author:
Alfa & Ariss

Method Summary
 java.io.InputStream getInputStream()
          get the request its data.
 java.lang.String getMessage()
          Returns an String which contains the request its data.
 java.lang.String getProperty(java.lang.String sName)
          Get a property of the underlying protocol.
 java.lang.String getProtocolName()
          Returns the full name of the protocol used.
 java.lang.String getTarget()
          Returns the full URL to which the request was issued.
 

Method Detail

getProtocolName

java.lang.String getProtocolName()
Returns the full name of the protocol used. e.g. �SOAP 1.2 over HTTP�.

Returns:
the full name of the protocol

getTarget

java.lang.String getTarget()
Returns the full URL to which the request was issued.

Returns:
the full URL of the target of the request.

getMessage

java.lang.String getMessage()
Returns an String which contains the request its data.

Returns:
The request data as String.

getProperty

java.lang.String getProperty(java.lang.String sName)
Get a property of the underlying protocol.

Description:
Returns the property value with the given name. For e.g. HTTP these properties are headers like "content-type".

Concurrency issues:
-

Preconditions:
sName must contain a valid parameter name.

Postconditions:
-

Parameters:
sName - The property name.
Returns:
The propery value.

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException
get the request its data.

Description:
Returns an InputStream, which contains the request its data.

Concurrency issues:
The returned InputStream should not be shared.

Preconditions:
-

Postconditions:
-

Returns:
InputStream from which the incomming message can be retrieved.
Throws:
java.io.IOException - if InputStream can't be retrieved from the protocol.


Copyright © 2008 SURFnet BV. All Rights Reserved.