Spec-Zone .ru спецификации, руководства, описания, API

javax.xml.ws.spi.http
Класс HttpExchange

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

public abstract class HttpExchange
расширяет java.lang. Объект

Этот class инкапсулирует полученный запрос HTTP и ответ, который будет сгенерирован в одном обмене. Это обеспечивает методы для того, чтобы они исследовали запрос от клиента, и для создания и отправки ответа.

A HttpExchange должен быть закрыт, чтобы освободить или снова использовать базовые ресурсы. Эффект того, чтобы быть не в состоянии закрыть обмен неопределен.

С тех пор:

JAX-WS 2.2

Автор:

Jitendra Kotamraju

Полевая Сводка

static java.lang.String	REQUEST_CIPHER_SUITE Стандартное свойство: комплект шифра оценивает, когда запрос получается по HTTPS
static java.lang.String	REQUEST_KEY_SIZE Стандартное свойство: диаметр долота алгоритма, когда запрос получается по HTTPS
static java.lang.String	REQUEST_X509CERTIFICATE Стандартное свойство: сертификат SSL, если таковые вообще имеются, связался с запросом

Сводка конструктора

HttpExchange()

Сводка метода

abstract void	addResponseHeader(java.lang.String name, java.lang.String value) Добавляет заголовок ответа с именем и значением.
abstract void	close() Это нужно вызвать, чтобы закончить обмен.
abstract java.lang.Object	getAttribute(java.lang.String name) Возвращает атрибут, который связывается с этим HttpExchange.
abstract java.util.Set<java.lang.String>	getAttributeNames() Дает все названия атрибута, которые связываются с этим HttpExchange.
abstract java.lang.String	getContextPath() Возвращает путь контекста всех конечных точек в приложении.
abstract HttpContext	getHttpContext() Возвраты a HttpContext для этого обмена.
abstract java.net.InetSocketAddress	getLocalAddress() Возвращает неразрешенный локальный адрес, на котором был получен запрос.
abstract java.lang.String	getPathInfo() Возвращает дополнительную информацию о пути, которая следует за путем веб-сервиса, но предшествует строке запроса в URI запроса и запустится с "/" символ.
abstract java.lang.String	getProtocol() Возвращает строку протокола из запроса в форме protocol/majorVersion.minorVersion.
abstract java.lang.String	getQueryString() Возвращает строку запроса, которая содержится в URI запроса после пути.
abstract java.net.InetSocketAddress	getRemoteAddress() Возвращает неразрешенный адрес удаленного объекта, вызывающего этот запрос.
abstract java.io.InputStream	getRequestBody() Возвращает поток, из которого может быть считано тело запроса.
abstract java.lang.String	getRequestHeader(java.lang.String name) Возвращает значение указанного заголовка запроса.
abstract java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestHeaders() Возвращает неизменную Карту, содержащую HTTP-заголовки, которые были включены с этим запросом.
abstract java.lang.String	getRequestMethod() Получите метод запроса HTTP
abstract java.lang.String	getRequestURI() Возвращает часть URI запроса с имени протокола до строки запроса в первой строке запроса HTTP.
abstract java.io.OutputStream	getResponseBody() Возвращает поток, которому должно быть записано тело ответа.
abstract java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders() Возвращает изменчивую Карту, в которую могут быть сохранены заголовки ответа HTTP и который будет передан как часть этого ответа.
abstract java.lang.String	getScheme() Возвращает имя схемы, используемой, чтобы обратиться с этой просьбой, например: http, или https.
abstract java.security.Principal	getUserPrincipal() Возвраты Principal это представляет аутентифицируемого пользователя для этого HttpExchange.
abstract boolean	isUserInRole(java.lang.String role) Указывает, включается ли аутентифицируемый пользователь в указанную логическую "роль".
abstract void	setStatus(int status) Устанавливает код состояния HTTP для ответа.

Методы, наследованные от class java.lang. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Полевая Деталь

REQUEST_CIPHER_SUITE

public static final java.lang.String REQUEST_CIPHER_SUITE

Стандартное свойство: комплект шифра оценивает, когда запрос получается по HTTPS

Введите: Строка

См. Также:

Постоянные Значения полей

REQUEST_KEY_SIZE

public static final java.lang.String REQUEST_KEY_SIZE

Стандартное свойство: диаметр долота алгоритма, когда запрос получается по HTTPS

Введите: Целое число

См. Также:

Постоянные Значения полей

REQUEST_X509CERTIFICATE

public static final java.lang.String REQUEST_X509CERTIFICATE

Стандартное свойство: сертификат SSL, если таковые вообще имеются, связался с запросом

Введите: java.security.cert. X509Certificate [] порядок этого массива определяется как являющийся в порядке возрастания из доверия. Первый сертификат в цепочке является тем, установленным клиентом, следующим является то, используемое, чтобы аутентифицировать первое и так далее.

См. Также:

Постоянные Значения полей

Деталь конструктора

HttpExchange

public HttpExchange()

Деталь метода

getRequestHeaders

public abstract java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestHeaders()

Возвращает неизменную Карту, содержащую HTTP-заголовки, которые были включены с этим запросом. Ключи в этой Карте будут именами заголовка, в то время как значениями будет Список Строк, содержащих каждое значение, которое было включено (или для заголовка, который был перечислен несколько раз, или тот, который принимает разграниченный запятой список значений на одной строке). В любом из этих случаев значения для имени заголовка будут представлены в порядке, что они были включены в запрос.

Ключи в Карте являются нечувствительными к регистру.

Возвраты:

неизменная Карта, которая может привыкнуть к заголовкам запроса доступа

getRequestHeader

public abstract java.lang.String getRequestHeader(java.lang.String name)

Возвращает значение указанного заголовка запроса. Если запрос не включал заголовок указанного имени, этого нуля возвратов метода. Если есть многократные заголовки с тем же самым именем, этот метод возвращает первый заголовок в запросе. Имя заголовка является нечувствительным к регистру. Это - convienence метод, чтобы получить заголовок (вместо того, чтобы использовать getRequestHeaders()).

Параметры:

name - имя заголовка запроса

Возвраты:

возвращает значение требуемого заголовка, или нуль, если у запроса нет заголовка того имени

getResponseHeaders

public abstract java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaders()

Возвращает изменчивую Карту, в которую могут быть сохранены заголовки ответа HTTP и который будет передан как часть этого ответа. Ключи в Карте будут именами заголовка, в то время как значениями должен быть Список Строк, содержащих каждое значение, которое должно быть включено многократно (в порядке, что они должны быть включены).

Ключи в Карте являются нечувствительными к регистру.

Возвраты:

изменчивая Карта, которая может использоваться, чтобы установить заголовки ответа.

addResponseHeader

public abstract void addResponseHeader(java.lang.String name,
                                       java.lang.String value)

Добавляет заголовок ответа с именем и значением. Этот метод позволяет заголовку ответа иметь многократные значения. Это - метод удобства, чтобы добавить заголовок ответа (вместо того, чтобы использовать getResponseHeaders()).

Параметры:

name - имя заголовка

value - дополнительное значение заголовка. Если это содержит строку октета, это должно быть закодировано согласно RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)

См. Также:

getResponseHeaders()

getRequestURI

public abstract java.lang.String getRequestURI()

Возвращает часть URI запроса с имени протокола до строки запроса в первой строке запроса HTTP. Контейнер не декодирует эту строку.

Возвраты:

URI запроса

getContextPath

public abstract java.lang.String getContextPath()

Возвращает путь контекста всех конечных точек в приложении. Этот путь является частью URI запроса, который указывает на контекст запроса. Путь контекста всегда на первом месте в URI запроса. Путь запускается с "/" символ, но не заканчивается "/" символ. Если этот метод возвращается"", запрос для контекста значения по умолчанию. Контейнер не декодирует эту строку.

Путь контекста используется в вычислениях адреса конечной точки. См. HttpContext#getPath

Возвраты:

путь контекста всех конечных точек в приложении

См. Также:

HttpContext#getPath

getRequestMethod

public abstract java.lang.String getRequestMethod()

Получите метод запроса HTTP

Возвраты:

метод запроса

getHttpContext

public abstract HttpContext getHttpContext()

Возвраты a HttpContext для этого обмена. Контейнер соответствует запрос с HttpContext связанной Конечной точки

Возвраты:

HttpContext для этого обмена

близко

public abstract void close()
                    throws java.io.IOException

Это нужно вызвать, чтобы закончить обмен. Контейнер заботится о заключительном запросе и ответных потоках. Это нужно вызвать так, чтобы контейнер мог освободить или повторное использование базовые ресурсы.

Броски:

java.io.IOException - если любая i/o ошибка

getRequestBody

public abstract java.io.InputStream getRequestBody()
                                            throws java.io.IOException

Возвращает поток, из которого может быть считано тело запроса. Множественные вызовы этого метода возвратят тот же самый поток.

Возвраты:

поток, из которого может быть считано тело запроса.

Броски:

java.io.IOException - если любая i/o ошибка во время обработки запросов

getResponseBody

public abstract java.io.OutputStream getResponseBody()
                                              throws java.io.IOException

Возвращает поток, которому должно быть записано тело ответа. setStatus(int)) должен быть вызван до вызова этого метода. Множественные вызовы этого метода (для того же самого обмена) возвратят тот же самый поток.

Возвраты:

поток, которому пишется тело ответа

Броски:

java.io.IOException - если любая i/o ошибка во время обработки ответа

setStatus

public abstract void setStatus(int status)

Устанавливает код состояния HTTP для ответа.

Этот метод нужно вызвать до вызова getResponseBody().

Параметры:

status - код ответа, чтобы передаться

См. Также:

getResponseBody()

getRemoteAddress

public abstract java.net.InetSocketAddress getRemoteAddress()

Возвращает неразрешенный адрес удаленного объекта, вызывающего этот запрос.

Возвраты:

InetSocketAddress вызывающей стороны

getLocalAddress

public abstract java.net.InetSocketAddress getLocalAddress()

Возвращает неразрешенный локальный адрес, на котором был получен запрос.

Возвраты:

InetSocketAddress локального интерфейса

getProtocol

public abstract java.lang.String getProtocol()

Возвращает строку протокола из запроса в форме protocol/majorVersion.minorVersion. Например, "HTTP/1.1"

Возвраты:

строка протокола от запроса

getScheme

public abstract java.lang.String getScheme()

Возвращает имя схемы, используемой, чтобы обратиться с этой просьбой, например: http, или https.

Возвраты:

имя схемы, используемой, чтобы обратиться с этой просьбой

getPathInfo

public abstract java.lang.String getPathInfo()

Возвращает дополнительную информацию о пути, которая следует за путем веб-сервиса, но предшествует строке запроса в URI запроса и запустится с "/" символ.

Это может использоваться для MessageContext#PATH_INFO

Возвраты:

декодируемая дополнительная информация о пути веб-сервиса. Это - путь, который прибывает после пути веб-сервиса, но перед строкой запроса в URI запроса null, если нет никакого дополнительного пути в URI запроса

getQueryString

public abstract java.lang.String getQueryString()

Возвращает строку запроса, которая содержится в URI запроса после пути.

Это может использоваться для MessageContext#QUERY_STRING

Возвраты:

недекодируемая строка запроса URI запроса, или null, если у URI запроса нет того

getAttribute

public abstract java.lang.Object getAttribute(java.lang.String name)

Возвращает атрибут, который связывается с этим HttpExchange. Обработчики JAX-WS и конечные точки могут тогда получить доступ к атрибуту через MessageContext.

Контейнеры сервлета должны представить MessageContext#SERVLET_CONTEXT, MessageContext#SERVLET_REQUEST, и MessageContext#SERVLET_RESPONSE как атрибуты.

Если запрос был получен контейнером, используя HTTPS, следующая информация должна быть представлена как атрибуты. Эти атрибуты REQUEST_CIPHER_SUITE, и REQUEST_KEY_SIZE. Если есть сертификат SSL, связанный с запросом, он должен быть представлен, используя REQUEST_X509CERTIFICATE

Параметры:

name - название атрибута

Возвраты:

значение атрибута, или null, если атрибут не существует

getAttributeNames

public abstract java.util.Set<java.lang.String> getAttributeNames()

Дает все названия атрибута, которые связываются с этим HttpExchange.

Возвраты:

набор всех названий атрибута

См. Также:

getAttribute(String)

getUserPrincipal

public abstract java.security.Principal getUserPrincipal()

Возвраты Principal это представляет аутентифицируемого пользователя для этого HttpExchange.

Возвраты:

Принципал для аутентифицируемого пользователя, или null, если не аутентифицируемый

isUserInRole

public abstract boolean isUserInRole(java.lang.String role)

Указывает, включается ли аутентифицируемый пользователь в указанную логическую "роль".

Параметры:

role - определяет имя роли

Возвраты:

true, если пользователь, обращающийся с этой просьбой, принадлежит данной роли