org.opensaml.ws
Interface HTTPMessageSource

All Superinterfaces:
MessageSource

public interface HTTPMessageSource
extends MessageSource

A source of messages delivered by HTTP. This message source is synchronous.


Nested Class Summary
static class HTTPMessageSource.HTTP_VERSION
          HTTP version identifier.
 
Method Summary
 java.util.List<javax.servlet.http.Cookie> getCookies()
          Gets the cookies received with the message.
 java.util.List<java.lang.String> getHeaderNames()
          Gets the list of HTTP header names.
 java.lang.String getHeaderValue(java.lang.String name)
          Gets the first value of the header with the given name.
 java.util.List<java.lang.String> getHeaderValues(java.lang.String name)
          Gets all the values of the header with the given name.
 int getStatusCode()
          Gets the status code of the request.
 URLBuilder getURLInformation()
          Gets information about the URL from which the message was received.
 HTTPMessageSource.HTTP_VERSION getVersion()
          Gets the HTTP version used to receive the message.
 
Methods inherited from interface org.opensaml.ws.MessageSource
getContentCharacterEncoding, getContentLength, getContentType, getMessageAsStream, getMessageAsString, getMessageAsString, isPeerAuthenticated
 

Method Detail

getVersion

HTTPMessageSource.HTTP_VERSION getVersion()
Gets the HTTP version used to receive the message.

Returns:
HTTP version used to receive the message

getStatusCode

int getStatusCode()
Gets the status code of the request.

Returns:
status code of the request

getHeaderNames

java.util.List<java.lang.String> getHeaderNames()
Gets the list of HTTP header names.

Returns:
HTTP header names

getHeaderValue

java.lang.String getHeaderValue(java.lang.String name)
Gets the first value of the header with the given name.

Parameters:
name - header name
Returns:
first value of the header with the given name, or null

getHeaderValues

java.util.List<java.lang.String> getHeaderValues(java.lang.String name)
Gets all the values of the header with the given name.

Parameters:
name - header name
Returns:
header values or null

getURLInformation

URLBuilder getURLInformation()
Gets information about the URL from which the message was received.

Returns:
information about the URL from which the message was received

getCookies

java.util.List<javax.servlet.http.Cookie> getCookies()
Gets the cookies received with the message.

Returns:
cookies received with the message