HttpExchange (Java Platform SE 8 )

java.lang.Object
- javax.xml.ws.spi.http.HttpExchange

```
public abstract class HttpExchange
extends Object
```
这个类封装了一个HTTP请求的接收，是在一个交易所产生的响应。它提供从客户端检查请求的方法，以及用于构建和发送响应的方法。
一个HttpExchange必须关闭免费或重用底层资源。未能关闭交换的效果是不确定的。

从以下版本开始：

JAX-WS 2.2

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`REQUEST_CIPHER_SUITE` 标准特性：密码套件价值当收到请求通过HTTPS
`static String`	`REQUEST_KEY_SIZE` 标准属性：点大小的算法，当请求被接收在HTTPS
`static String`	`REQUEST_X509CERTIFICATE` 标准的属性：一个SSL证书，如果有，与请求关联的

构造方法摘要

构造方法

Constructor and Description

HttpExchange()

构造方法
Constructor and Description
`HttpExchange()`

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`abstract void`	`addResponseHeader(String name, String value)` 添加一个具有给定名称和值的响应头。
`abstract void`	`close()` 这必须被调用结束一个交换。
`abstract Object`	`getAttribute(String name)` 返回与此相关的属性 `HttpExchange`。
`abstract Set<String>`	`getAttributeNames()` 给所有的属性名称，这 `HttpExchange`相关。
`abstract String`	`getContextPath()` 返回应用程序中所有端点的上下文路径。
`abstract HttpContext`	`getHttpContext()` 返回该交换 `HttpContext`。
`abstract InetSocketAddress`	`getLocalAddress()` 返回已接收到的未解决的本地地址。
`abstract String`	`getPathInfo()` 返回额外的路径信息，包括Web服务路径，但在查询字符串中的请求，将启动一个“/”字符。
`abstract String`	`getProtocol()` 回报的形式从协议/ majorversion.minorversion请求的协议字符串。
`abstract String`	`getQueryString()` 返回查询的字符串，包含在请求URI路径后。
`abstract InetSocketAddress`	`getRemoteAddress()` 返回调用此请求的远程实体的未解决的地址。
`abstract InputStream`	`getRequestBody()` 返回一个可以读取请求正文的流。
`abstract String`	`getRequestHeader(String name)` 返回指定的请求头的值。
`abstract Map<String,List<String>>`	`getRequestHeaders()` 返回包含HTTP头包含在这个请求一个不变的Map。
`abstract String`	`getRequestMethod()` 获取HTTP请求的方法
`abstract String`	`getRequestURI()` 返回HTTP请求的第一行从协议名称来查询字符串的请求的URI的一部分。
`abstract OutputStream`	`getResponseBody()` 返回响应体必须写入的流。
`abstract Map<String,List<String>>`	`getResponseHeaders()` 返回一个可变的Map到HTTP响应头可以存储并将其作为该反应的一部分发送。
`abstract String`	`getScheme()` 例如，返回使用提出这一要求，方案的名称：HTTP或HTTPS。
`abstract Principal`	`getUserPrincipal()` 返回表示这 `HttpExchange`认证用户的 `Principal`。
`abstract boolean`	`isUserInRole(String role)` 指示已验证身份的用户是否包含在指定的逻辑“角色”中。
`abstract void`	`setStatus(int status)` 设置响应的HTTP状态码。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REQUEST_CIPHER_SUITE
```
public static final String REQUEST_CIPHER_SUITE
```
    标准特性：密码套件价值当收到请求
    类型：字符串
    HTTPS
    
    另请参见：
    
    Constant Field Values
  - REQUEST_KEY_SIZE
```
public static final String REQUEST_KEY_SIZE
```
    标准属性：点大小的算法，当请求被接收
    类型：整数
    HTTPS
    
    另请参见：
    
    Constant Field Values
  - REQUEST_X509CERTIFICATE
```
public static final String REQUEST_X509CERTIFICATE
```
    标准的属性：一个SSL证书，如果有，与
    类型：java。安全。cert.x509certificate [ ]这个数组的顺序是升序的信任。链中的第一个证书是由客户端设置的，下一个证书是用来对第一个进行身份验证的，等等。
    相关要求
    
    另请参见：
    
    Constant Field Values
- Constructor Detail
  - HttpExchange
```
public HttpExchange()
```
- 方法详细信息
  - getRequestHeaders
```
public abstract Map<String,List<String>> getRequestHeaders()
```
    返回包含HTTP头包含在这个请求一个不变的Map。在这个映射中的键将是头文件，而值将是一个字符串列表，包含每个包含的值（无论是对于一个头几次列出，或一个接受一个逗号分隔的值列表的一行）。在这些情况中的任何一种情况下，头名称的值将被呈现在它们被包含在请求中的顺序中。
    在Map上的键是不区分大小写的。
    
    结果
    
    一个可以用来访问请求头的不可变Map
  - getRequestHeader
```
public abstract String getRequestHeader(String name)
```
    返回指定的请求头的值。如果请求不包含指定名称的头，则此方法返回空值。如果有同名的多个头，此方法将返回请求中的第一个头。标题的名称是不区分大小写的。这是一个有头的简便方法（而不是使用 getRequestHeaders()）。
    
    参数
    
    name -请求标头的名称
    
    结果
    
    返回所请求的头的值，如果请求没有该名称的标题，请返回
  - getResponseHeaders
```
public abstract Map<String,List<String>> getResponseHeaders()
```
    返回一个可变的Map到HTTP响应头可以存储并将其作为该反应的一部分发送。Map中的键将是头文件名，而值必须是包含每个值的字符串列表，这些值应包含多次（在它们应该包含的顺序中）。
    在Map上的键是不区分大小写的。
    
    结果
    
    一个可变的Map可用于设置响应头。
  - addResponseHeader
```
public abstract void addResponseHeader(String name,
                                       String value)
```
    添加一个具有给定名称和值的响应头。此方法允许响应头具有多个值。这是一个增加一个响应头的便利方法（而不是使用 getResponseHeaders()）。
    
    参数
    
    name -标头的名称
    
    value -额外的标头值。如果它包含字符串，应该根据RFC 2047编码（http://www.ietf.org/rfc/rfc2047.txt）
    
    另请参见：
    
    getResponseHeaders()
  - getRequestURI
```
public abstract String getRequestURI()
```
    返回HTTP请求的第一行从协议名称来查询字符串的请求的URI的一部分。容器没有解码此字符串。
    
    结果
    
    请求的URI
  - getContextPath
```
public abstract String getContextPath()
```
    返回应用程序中所有端点的上下文路径。这条路是表示请求的上下文部分请求的URI。上下文路径总是在请求URI的第一。路径开始于一个“/”字符，但不结束与“/”字符。如果此方法返回“”，则请求为默认上下文。容器不解码此字符串。
    上下文路径用于计算端点地址。看到HttpContext.getPath()
    
    结果
    
    在应用程序中的所有端点的上下文路径
    
    另请参见：
    
    HttpContext.getPath()
  - getRequestMethod
```
public abstract String getRequestMethod()
```
    获取HTTP请求的方法
    
    结果
    
    请求的方法
  - getHttpContext
```
public abstract HttpContext getHttpContext()
```
    返回该交换 HttpContext。容器与相关的端点的HttpContext的要求
    
    结果
    
    这种交流的HttpContext
  - close
```
public abstract void close()
                    throws IOException
```
    这必须被调用结束一个交换。容器需要处理关闭请求和响应流。这必须被调用，以便容器可以免费或重用底层资源。
    
    异常
    
    IOException -如果任何I/O错误
  - getRequestBody
```
public abstract InputStream getRequestBody()
                                    throws IOException
```
    返回一个可以读取请求正文的流。此方法的多个调用将返回相同的流。
    
    结果
    
    可以读取请求正文的流。
    
    异常
    
    IOException -如果任何I/O请求处理过程中的错误
  - getResponseBody
```
public abstract OutputStream getResponseBody()
                                      throws IOException
```
    返回响应体必须写入的流。 setStatus(int)）必须在调用此方法之前调用。此方法的多个调用（对于同一个交换）将返回相同的流。
    
    结果
    
    响应正文所写的流
    
    异常
    
    IOException -如果任何I/O错误时的反应处理
  - setStatus
```
public abstract void setStatus(int status)
```
    设置响应的HTTP状态码。
    这个方法必须调用getResponseBody()之前调用。
    
    参数
    
    status -响应代码发送
    
    另请参见：
    
    getResponseBody()
  - getRemoteAddress
```
public abstract InetSocketAddress getRemoteAddress()
```
    返回调用此请求的远程实体的未解决的地址。
    
    结果
    
    调用者的inetsocketaddress
  - getLocalAddress
```
public abstract InetSocketAddress getLocalAddress()
```
    返回已接收到的未解决的本地地址。
    
    结果
    
    的本地接口的inetsocketaddress
  - getProtocol
```
public abstract String getProtocol()
```
    回报的形式从协议/ majorversion.minorversion请求的协议字符串。例如，“HTTP 1.1”
    
    结果
    
    从请求的协议字符串
  - getScheme
```
public abstract String getScheme()
```
    例如，返回使用提出这一要求，方案的名称：HTTP或HTTPS。
    
    结果
    
    用于使此请求的计划的名称
  - getPathInfo
```
public abstract String getPathInfo()
```
    返回额外的路径信息，包括Web服务路径，但在查询字符串中的请求，将启动一个“/”字符。
    这可以用来MessageContext.PATH_INFO
    
    结果
    
    网络服务的额外路径信息。它的路径是Web服务路径后，但在 null请求URI查询字符串中是否有任何额外的请求URI路径
  - getQueryString
```
public abstract String getQueryString()
```
    返回查询的字符串，包含在请求URI路径后。
    这可以用来MessageContext.QUERY_STRING
    
    结果
    
    未解码请求URI查询字符串，或 null如果请求URI没有
  - getAttribute
```
public abstract Object getAttribute(String name)
```
    返回与此相关的属性 HttpExchange。JAX-WS处理程序和端点可以通过 MessageContext访问属性。
    servlet容器必须暴露MessageContext.SERVLET_CONTEXT，MessageContext.SERVLET_REQUEST，和MessageContext.SERVLET_RESPONSE属性。
    
    如果请求已经通过使用HTTPS容器接收，以下信息必须公开为属性。这些属性是REQUEST_CIPHER_SUITE，和REQUEST_KEY_SIZE。如果有一个与请求关联的SSL证书，则必须使用REQUEST_X509CERTIFICATE暴露
    
    参数
    
    name属性名称
    
    结果
    
    属性值，或 null如果属性不存在
  - getAttributeNames
```
public abstract Set<String> getAttributeNames()
```
    给所有的属性名称，这 HttpExchange相关。
    
    结果
    
    集合所有属性名称
    
    另请参见：
    
    getAttribute(String)
  - getUserPrincipal
```
public abstract Principal getUserPrincipal()
```
    返回 Principal表示经过身份验证的用户，这 HttpExchange。
    
    结果
    
    主要用于身份验证的用户，或 null如果没有认证
  - isUserInRole
```
public abstract boolean isUserInRole(String role)
```
    指示已验证身份的用户是否包含在指定的逻辑“角色”中。
    
    参数
    
    role -指定角色的名字
    
    结果
    
    true发出这一请求的用户是否属于特定的角色

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class HttpExchange

Field Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Field Detail

REQUEST_CIPHER_SUITE

REQUEST_KEY_SIZE

REQUEST_X509CERTIFICATE

Constructor Detail

HttpExchange

方法详细信息

getRequestHeaders

getRequestHeader

getResponseHeaders

addResponseHeader

getRequestURI

getContextPath

getRequestMethod

getHttpContext

close

getRequestBody

getResponseBody

setStatus

getRemoteAddress

getLocalAddress

getProtocol

getScheme

getPathInfo

getQueryString

getAttribute

getAttributeNames

getUserPrincipal

isUserInRole