org.opensaml.ws.transport.http

Interface HTTPTransport

All Superinterfaces:

Transport

All Known Subinterfaces:

HTTPInTransport, HTTPOutTransport

All Known Implementing Classes:

HttpServletRequestAdapter, HttpServletResponseAdapter

public interface HTTPTransport
extends Transport

An HTTP-based transport.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HTTPTransport.HTTP_VERSION HTTP version identifier.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHeaderValue(String name) Gets the first value of the header with the given name.
String	getHTTPMethod() Gets the HTTP method (POST, GET, etc) used.
String	getParameterValue(String name) Gets the first value of the named parameter.
List<String>	getParameterValues(String name) Gets the values of the named parameter.
int	getStatusCode() Gets the status code of the request.
HTTPTransport.HTTP_VERSION	getVersion() Gets the HTTP version used to receive the message.

Methods inherited from interface org.opensaml.ws.transport.Transport

getAttribute, getCharacterEncoding, getLocalCredential, getPeerCredential, isAuthenticated, isConfidential, isIntegrityProtected, setAuthenticated, setConfidential, setIntegrityProtected

Method Detail

getHeaderValue

String getHeaderValue(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

getHTTPMethod

String getHTTPMethod()

Gets the HTTP method (POST, GET, etc) used.

Returns:

HTTP method used

getStatusCode

int getStatusCode()

Gets the status code of the request.

Returns:

status code of the request

getParameterValue

String getParameterValue(String name)

Gets the first value of the named parameter. If the request is GET, this is a decoded URL parameter. If the request is POST-based, it is a parameter from the POST body.

Parameters:

name - parameter name

Returns:

parameter value

getParameterValues

List<String> getParameterValues(String name)

Gets the values of the named parameter. If the request is GET, this is a decoded URL parameter. If the request is POST-based, it is a parameter from the POST body.

Parameters:

name - parameter name

Returns:

parameter values

getVersion

HTTPTransport.HTTP_VERSION getVersion()

Gets the HTTP version used to receive the message.

Returns:

HTTP version used to receive the message