HttpServletResponseAdapter (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.opensaml.ws.transport.http.HttpServletResponseAdapter

すべての実装されたインタフェース:

HTTPOutTransport, HTTPTransport, OutTransport, Transport
```
public class HttpServletResponseAdapter
extends Object
implements HTTPOutTransport
```
Adapts an HttpServletResponse to an HTTPOutTransport.

ネストされたクラスの概要
- インタフェースから継承されたネストされたクラス/インタフェース org.opensaml.ws.transport.http.HTTPTransport
  HTTPTransport.HTTP_VERSION

コンストラクタの概要

コンストラクタ
コンストラクタと説明

HttpServletResponseAdapter(javax.servlet.http.HttpServletResponse response, boolean isSecure)
Constructor.

コンストラクタ
コンストラクタと説明
`HttpServletResponseAdapter(javax.servlet.http.HttpServletResponse response, boolean isSecure)` Constructor.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`addParameter(String name, String value)` Sets the given parameter with the given value.
`Object`	`getAttribute(String name)` Gets a transport-specific attribute.
`String`	`getCharacterEncoding()` Gets the character encoding of the transport.
`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.
`Credential`	`getLocalCredential()` Gets the local credential used to authenticate to the peer.
`OutputStream`	`getOutgoingStream()` Gets the outgoing data stream to the peer.
`String`	`getParameterValue(String name)` Gets the first value of the named parameter.
`List<String>`	`getParameterValues(String name)` Gets the values of the named parameter.
`Credential`	`getPeerCredential()` Gets the credential offered by the peer to authenticate itself.
`int`	`getStatusCode()` Gets the status code of the request.
`HTTPTransport.HTTP_VERSION`	`getVersion()` Gets the HTTP version used to receive the message.
`javax.servlet.http.HttpServletResponse`	`getWrappedResponse()` Gets the adapted response.
`boolean`	`isAuthenticated()` Gets whether the peer is authenticated.
`boolean`	`isConfidential()` Gets whether the transport represents a confidential connection (e.g. an SSL connection).
`boolean`	`isIntegrityProtected()` Gets whether the transport represents a connection that protects the integrity of transported content.
`void`	`sendRedirect(String location)` Sends an HTTP 3XX redirect message back to the client.
`void`	`setAttribute(String name, Object value)` Sets a transport-specific attribute.
`void`	`setAuthenticated(boolean isAuthenticated)` Sets whether the peer is authenticated.
`void`	`setCharacterEncoding(String encoding)` Sets the character encoding of the transport.
`void`	`setConfidential(boolean isConfidential)` Sets whether the transport represents a confidential connection.
`void`	`setHeader(String name, String value)` Sets the given header with the given value.
`void`	`setIntegrityProtected(boolean isIntegrityProtected)` Sets whether the transport represents a connection that protects the integrity of transported content.
`void`	`setStatusCode(int code)` Sets the status code for this transport.
`void`	`setVersion(HTTPTransport.HTTP_VERSION version)` Sets the HTTP version to use for outgoing messages.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - HttpServletResponseAdapter
```
public HttpServletResponseAdapter(javax.servlet.http.HttpServletResponse response,
                          boolean isSecure)
```
    Constructor.
    
    パラメータ:
    response - servlet response to adapt
    isSecure - whether the outbound connection is protected by SSL/TLS
- メソッドの詳細
  - getAttribute
```
public Object getAttribute(String name)
```
    Gets a transport-specific attribute. This method is not supported for this transport implementation and always returns null.
    
    定義:
    
    getAttribute インタフェース内 Transport
    
    パラメータ:
    name - name of the attribute
    
    戻り値:
    attribute value
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Gets the character encoding of the transport.
    
    定義:
    
    getCharacterEncoding インタフェース内 Transport
    
    戻り値:
    character encoding of the transport
  - getHeaderValue
```
public String getHeaderValue(String name)
```
    Gets the first value of the header with the given name. This method is not supported for this transport implementation.
    
    定義:
    
    getHeaderValue インタフェース内 HTTPTransport
    
    パラメータ:
    name - header name
    
    戻り値:
    first value of the header with the given name, or null
  - getHTTPMethod
```
public String getHTTPMethod()
```
    Gets the HTTP method (POST, GET, etc) used. This method is not supported for this transport implementation.
    
    定義:
    
    getHTTPMethod インタフェース内 HTTPTransport
    
    戻り値:
    HTTP method used
  - getLocalCredential
```
public Credential getLocalCredential()
```
    Gets the local credential used to authenticate to the peer.
    
    定義:
    
    getLocalCredential インタフェース内 Transport
    
    戻り値:
    local credential used to authenticate to the peer
  - getOutgoingStream
```
public OutputStream getOutgoingStream()
```
    Gets the outgoing data stream to the peer.
    
    定義:
    
    getOutgoingStream インタフェース内 OutTransport
    
    戻り値:
    outgoing data stream to the peer
  - getParameterValue
```
public 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. This method is not supported for this transport implementation.
    
    定義:
    
    getParameterValue インタフェース内 HTTPTransport
    
    パラメータ:
    name - parameter name
    
    戻り値:
    parameter value
  - getParameterValues
```
public 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.
    
    定義:
    
    getParameterValues インタフェース内 HTTPTransport
    
    パラメータ:
    name - parameter name
    
    戻り値:
    parameter values
  - getPeerCredential
```
public Credential getPeerCredential()
```
    Gets the credential offered by the peer to authenticate itself.
    
    定義:
    
    getPeerCredential インタフェース内 Transport
    
    戻り値:
    credential offered by the peer to authenticate itself
  - getStatusCode
```
public int getStatusCode()
```
    Gets the status code of the request. This method is not supported for this transport implementation.
    
    定義:
    
    getStatusCode インタフェース内 HTTPTransport
    
    戻り値:
    status code of the request
  - getVersion
```
public HTTPTransport.HTTP_VERSION getVersion()
```
    Gets the HTTP version used to receive the message. This method is not supported for this transport implementation.
    
    定義:
    
    getVersion インタフェース内 HTTPTransport
    
    戻り値:
    HTTP version used to receive the message
  - getWrappedResponse
```
public javax.servlet.http.HttpServletResponse getWrappedResponse()
```
    Gets the adapted response.
    
    戻り値:
    adapted response
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Gets whether the peer is authenticated.
    
    定義:
    
    isAuthenticated インタフェース内 Transport
    
    戻り値:
    whether the peer is authenticated
  - isConfidential
```
public boolean isConfidential()
```
    Gets whether the transport represents a confidential connection (e.g. an SSL connection). This method is not supported for this transport implementation and always returns false.
    
    定義:
    
    isConfidential インタフェース内 Transport
    
    戻り値:
    whether the transport represents a confidential connection
  - sendRedirect
```
public void sendRedirect(String location)
```
    Sends an HTTP 3XX redirect message back to the client.
    
    定義:
    
    sendRedirect インタフェース内 HTTPOutTransport
    
    パラメータ:
    location - location to redirect the client to
  - setAttribute
```
public void setAttribute(String name,
                Object value)
```
    Sets a transport-specific attribute. This method is not supported for this transport implementation.
    
    定義:
    
    setAttribute インタフェース内 OutTransport
    
    パラメータ:
    name - attribute name
    value - attribute value
  - setAuthenticated
```
public void setAuthenticated(boolean isAuthenticated)
```
    Sets whether the peer is authenticated.
    
    定義:
    
    setAuthenticated インタフェース内 Transport
    
    パラメータ:
    isAuthenticated - whether the peer is authenticated
  - setCharacterEncoding
```
public void setCharacterEncoding(String encoding)
```
    Sets the character encoding of the transport.
    
    定義:
    
    setCharacterEncoding インタフェース内 OutTransport
    
    パラメータ:
    encoding - character encoding of the transport
  - setConfidential
```
public void setConfidential(boolean isConfidential)
```
    Sets whether the transport represents a confidential connection. This method is not supported for this transport implementation.
    
    定義:
    
    setConfidential インタフェース内 Transport
    
    パラメータ:
    isConfidential - whether the transport represents a confidential connection
  - setHeader
```
public void setHeader(String name,
             String value)
```
    Sets the given header with the given value.
    
    定義:
    
    setHeader インタフェース内 HTTPOutTransport
    
    パラメータ:
    name - header name
    value - header value
  - addParameter
```
public void addParameter(String name,
                String value)
```
    Sets the given parameter with the given value. This method is not supported for this transport implementation.
    
    定義:
    
    addParameter インタフェース内 HTTPOutTransport
    
    パラメータ:
    name - parameter name
    value - parameter value
  - setStatusCode
```
public void setStatusCode(int code)
```
    Sets the status code for this transport.
    
    定義:
    
    setStatusCode インタフェース内 HTTPOutTransport
    
    パラメータ:
    code - status code for this transport
  - setVersion
```
public void setVersion(HTTPTransport.HTTP_VERSION version)
```
    Sets the HTTP version to use for outgoing messages. This method is not supported for this transport implementation.
    
    定義:
    
    setVersion インタフェース内 HTTPOutTransport
    
    パラメータ:
    version - HTTP version to use for outgoing messages
  - isIntegrityProtected
```
public boolean isIntegrityProtected()
```
    Gets whether the transport represents a connection that protects the integrity of transported content.
    
    定義:
    
    isIntegrityProtected インタフェース内 Transport
    
    戻り値:
    whether the transport represents a connection that protects the integrity of transported content
  - setIntegrityProtected
```
public void setIntegrityProtected(boolean isIntegrityProtected)
```
    Sets whether the transport represents a connection that protects the integrity of transported content.
    
    定義:
    
    setIntegrityProtected インタフェース内 Transport
    
    パラメータ:
    isIntegrityProtected - whether the transport represents a connection that protects the integrity of transported content

クラス HttpServletResponseAdapter

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース org.opensaml.ws.transport.http.HTTPTransport

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

HttpServletResponseAdapter

メソッドの詳細

getAttribute

getCharacterEncoding

getHeaderValue

getHTTPMethod

getLocalCredential

getOutgoingStream

getParameterValue

getParameterValues

getPeerCredential

getStatusCode

getVersion

getWrappedResponse

isAuthenticated

isConfidential

sendRedirect

setAttribute

setAuthenticated

setCharacterEncoding

setConfidential

setHeader

addParameter

setStatusCode

setVersion

isIntegrityProtected

setIntegrityProtected