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

javax.xml.rpc
Вызов интерфейса

public interface Call

javax.xml.rpc.Call интерфейс оказывает поддержку для динамического вызова конечной точки службы. javax.xml.rpc.Service соедините интерфейсом с действиями как с фабрикой для создания Call экземпляры.

Однажды a Call экземпляр создается, различный метод set и методы метода get могут использоваться, чтобы сконфигурировать это Call экземпляр.

Версия:

1.0

Автор:

Рэхул Шарма

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

static java.lang.String	ENCODINGSTYLE_URI_PROPERTY Стандартное свойство для того, чтобы закодировать Стиль: Кодирование стиля, определенного как URI пространства имен.
static java.lang.String	OPERATION_STYLE_PROPERTY Стандартное свойство для стиля работы.
static java.lang.String	PASSWORD_PROPERTY Стандартное свойство: Пароль для аутентификации
static java.lang.String	SESSION_MAINTAIN_PROPERTY Стандартное свойство: Это булево свойство используется клиентом службы, чтобы указать, хочет ли оно участвовать в сеансе с конечной точкой службы.
static java.lang.String	SOAPACTION_URI_PROPERTY Стандартное свойство для SOAPAction.
static java.lang.String	SOAPACTION_USE_PROPERTY Стандартное свойство для SOAPAction.
static java.lang.String	USERNAME_PROPERTY Стандартное свойство: Имя пользователя для аутентификации

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

void	addParameter(java.lang.String paramName, javax.xml.namespace.QName xmlType, java.lang.Class javaType, ParameterMode parameterMode) Добавляют тип параметра и режим для определенной работы.
void	addParameter(java.lang.String paramName, javax.xml.namespace.QName xmlType, ParameterMode parameterMode) Добавляют тип параметра и режим для определенной работы.
javax.xml.namespace.QName	getOperationName() Заставляет имя работы быть вызванным, используя это Call экземпляр.
java.util.Map	getOutputParams() Возвраты a Map из {имя, значение} для выходных параметров последней вызванной работы.
java.util.List	getOutputValues() Возвраты a List значения для выходных параметров последней вызванной работы.
javax.xml.namespace.QName	getParameterTypeByName(java.lang.String paramName) Получает тип XML параметра по имени
javax.xml.namespace.QName	getPortTypeName() Получает полностью определенное имя типа порта.
java.lang.Object	getProperty(java.lang.String name) Получает значение именованного свойства.
java.util.Iterator	getPropertyNames() Получает имена конфигурируемых свойств, поддерживаемых этим Call объект.
javax.xml.namespace.QName	getReturnType() Получает тип возврата для определенной работы
java.lang.String	getTargetEndpointAddress() Получает адрес целевой конечной точки службы.
java.lang.Object	invoke(java.lang.Object[] inputParams) Вызывает определенную работу, используя синхронный режим взаимодействия ответа запроса.
java.lang.Object	invoke(javax.xml.namespace.QName operationName, java.lang.Object[] inputParams) Вызывает определенную работу, используя синхронный режим взаимодействия ответа запроса.
void	invokeOneWay(java.lang.Object[] inputParams) Вызывает удаленный метод, используя односторонний режим взаимодействия.
boolean	isParameterAndReturnSpecRequired(javax.xml.namespace.QName operationName) Указывает ли addParameter и setReturnType методы должны быть вызваны, чтобы определить параметр и спецификацию типа возврата для определенной работы.
void	removeAllParameters() Удаляет все указанные параметры из этого Call экземпляр.
void	removeProperty(java.lang.String name) Удаляет именованное свойство.
void	setOperationName(javax.xml.namespace.QName operationName) Определяет имя работы, которая будет вызвана, используя это Call экземпляр.
void	setPortTypeName(javax.xml.namespace.QName portType) Устанавливает полностью определенное имя типа порта.
void	setProperty(java.lang.String name, java.lang.Object value) Устанавливает значение для именованного свойства.
void	setReturnType(javax.xml.namespace.QName xmlType) Устанавливает тип возврата для определенной работы.
void	setReturnType(javax.xml.namespace.QName xmlType, java.lang.Class javaType) Устанавливает тип возврата для определенной работы.
void	setTargetEndpointAddress(java.lang.String address) Устанавливает адрес целевой конечной точки службы.

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

USERNAME_PROPERTY

static final java.lang.String USERNAME_PROPERTY

Стандартное свойство: Имя пользователя для аутентификации

Введите: java.lang.String

См. Также:

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

PASSWORD_PROPERTY

static final java.lang.String PASSWORD_PROPERTY

Стандартное свойство: Пароль для аутентификации

Введите: java.lang.String

См. Также:

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

OPERATION_STYLE_PROPERTY

static final java.lang.String OPERATION_STYLE_PROPERTY

Стандартное свойство для стиля работы. Это свойство устанавливается в "rpc", если стиль работы является rpc; "документ", если стиль работы является документом.

Введите: java.lang.String

См. Также:

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

SOAPACTION_USE_PROPERTY

static final java.lang.String SOAPACTION_USE_PROPERTY

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

Введите: java.lang.Boolean

См. Также:

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

SOAPACTION_URI_PROPERTY

static final java.lang.String SOAPACTION_URI_PROPERTY

Стандартное свойство для SOAPAction. Указывает на URI SOAPAction если javax.xml.rpc.soap.http.soapaction.use свойство устанавливается в true.

Введите: java.lang.String

См. Также:

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

ENCODINGSTYLE_URI_PROPERTY

static final java.lang.String ENCODINGSTYLE_URI_PROPERTY

Стандартное свойство для того, чтобы закодировать Стиль: Кодирование стиля, определенного как URI пространства имен. Значением по умолчанию является SOAP 1.1 кодирования http://schemas.xmlsoap.org/soap/encoding/

Введите: java.lang.String

См. Также:

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

SESSION_MAINTAIN_PROPERTY

static final java.lang.String SESSION_MAINTAIN_PROPERTY

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

Введите: java.lang.Boolean

См. Также:

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

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

isParameterAndReturnSpecRequired

boolean isParameterAndReturnSpecRequired(javax.xml.namespace.QName operationName)

Указывает ли addParameter и setReturnType методы должны быть вызваны, чтобы определить параметр и спецификацию типа возврата для определенной работы.

Параметры:

operationName - Полностью определенное имя работы

Возвраты:

Возвращает true, если реализация Вызова class требует, чтобы addParameter и setReturnType были вызваны в клиентском коде для указанной работы. Этот метод возвращает false иначе.

Броски:

java.lang.IllegalArgumentException - Если недопустимое имя работы определяется

addParameter

void addParameter(java.lang.String paramName,
                  javax.xml.namespace.QName xmlType,
                  ParameterMode parameterMode)

Добавляют тип параметра и режим для определенной работы. Отметьте, что клиентский код, возможно, не вызывает никого addParameter и setReturnType методы прежде, чем вызвать invoke метод. В этом случае реализация Вызова class определяет типы параметра при использовании отражения о параметрах, используя описание WSDL и сконфигурированный реестр отображения типа.

Параметры:

paramName - Имя параметра

xmlType - Тип XML параметра

parameterMode - Режим параметра - ли ParameterMode.IN, ParameterMode.OUT, или ParameterMode.INOUT,

Броски:

javax.xml.rpc.JAXRPCException: - Это исключение может быть выдано если метод isParameterAndReturnSpecRequired возвраты false для этой работы.

java.lang.IllegalArgumentException - Если какой-либо недопустимый тип названия параметра или XML определяется

См. Также:

isParameterAndReturnSpecRequired(javax.xml.namespace.QName)

addParameter

void addParameter(java.lang.String paramName,
                  javax.xml.namespace.QName xmlType,
                  java.lang.Class javaType,
                  ParameterMode parameterMode)

Добавляют тип параметра и режим для определенной работы. Этот метод используется, чтобы определить тип Java или для или для Параметры, являющиеся одновременно входным и выходным.

Параметры:

paramName - Имя параметра

xmlType - Тип XML параметра

javaType - Java class параметра

parameterMode - Режим параметра - ли ParameterMode. В, или INOUT

Броски:

JAXRPCException -

• Это исключение может быть выдано, если этот метод вызывается когда метод isParameterAndReturnSpecRequired возвраты false.
• Если определенный тип XML и отображение типа Java не допустимы. Например, TypeMappingRegistry не имеет никаких сериализаторов для этого отображения.

java.lang.IllegalArgumentException - Если какой-либо недопустимый тип названия параметра или XML определяется

java.lang.UnsupportedOperationException - Если этот метод не поддерживается

См. Также:

isParameterAndReturnSpecRequired(javax.xml.namespace.QName)

getParameterTypeByName

javax.xml.namespace.QName getParameterTypeByName(java.lang.String paramName)

Получает тип XML параметра по имени

Параметры:

paramName - Имя параметра

Возвраты:

XML возвратов вводят для указанного параметра

setReturnType

void setReturnType(javax.xml.namespace.QName xmlType)

Устанавливает тип возврата для определенной работы. Вызов setReturnType(null) удаляет тип возврата для этого объекта Вызова.

Параметры:

xmlType - Тип данных XML возвращаемого значения

Броски:

JAXRPCException - Это исключение может быть выдано когда метод isParameterAndReturnSpecRequired возвраты false.

java.lang.IllegalArgumentException - Если недопустимый тип XML определяется

setReturnType

void setReturnType(javax.xml.namespace.QName xmlType,
                   java.lang.Class javaType)

Устанавливает тип возврата для определенной работы.

Параметры:

xmlType - Тип данных XML возвращаемого значения

javaType - Класс Java возвращаемого значения

Броски:

JAXRPCException -

• Это исключение может быть выдано, если этот метод вызывается когда метод isParameterAndReturnSpecRequired возвраты false.
• Если тип XML и тип Java не могут быть отображены, используя стандартное отображение типа или реестр TypeMapping

java.lang.UnsupportedOperationException - Если этот метод не поддерживается

java.lang.IllegalArgumentException - Если недопустимый тип XML определяется

getReturnType

javax.xml.namespace.QName getReturnType()

Получает тип возврата для определенной работы

Возвраты:

Возвращает тип XML для возвращаемого значения

removeAllParameters

void removeAllParameters()

Удаляет все указанные параметры из этого Call экземпляр. Отметьте, что этот метод удаляет только параметры а не тип возврата. setReturnType(null) используется, чтобы удалить тип возврата.

Броски:

JAXRPCException - Это исключение может быть выдано, Если этот метод вызывают когда метод isParameterAndReturnSpecRequired возвраты false для работы этого Вызова.

getOperationName

javax.xml.namespace.QName getOperationName()

Заставляет имя работы быть вызванным, используя это Call экземпляр.

Возвраты:

Полностью определенное имя работы

setOperationName

void setOperationName(javax.xml.namespace.QName operationName)

Определяет имя работы, которая будет вызвана, используя это Call экземпляр.

Параметры:

operationName - QName работы, которая будет вызвана, используя экземпляр Вызова

getPortTypeName

javax.xml.namespace.QName getPortTypeName()

Получает полностью определенное имя типа порта.

Возвраты:

Полностью определенное имя типа порта

setPortTypeName

void setPortTypeName(javax.xml.namespace.QName portType)

Устанавливает полностью определенное имя типа порта.

Параметры:

portType - Полностью определенное имя типа порта

setTargetEndpointAddress

void setTargetEndpointAddress(java.lang.String address)

Устанавливает адрес целевой конечной точки службы. Этот адрес должен соответствовать транспорту, определенному в привязке для этого Call экземпляр.

Параметры:

address - Адрес целевой конечной точки службы; определенный как URI

getTargetEndpointAddress

java.lang.String getTargetEndpointAddress()

Получает адрес целевой конечной точки службы.

Возвраты:

Адрес целевой конечной точки службы как URI

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Устанавливает значение для именованного свойства. Спецификация JAX-RPC определяет стандартный набор свойств, которые можно передать к Call.setProperty метод.

Параметры:

name - Имя свойства

value - Значение свойства

Броски:

JAXRPCException -

• Если дополнительное стандартное имя свойства определяется, однако это Call реализация class не поддерживает конфигурацию этого свойства.
• Если недопустимое (или неподдерживаемый) имя свойства определяется или если значение несогласованного типа свойства передают.
• Если есть ошибка в конфигурации допустимого свойства.

getProperty

java.lang.Object getProperty(java.lang.String name)

Получает значение именованного свойства.

Параметры:

name - Имя свойства

Возвраты:

Значение именованного свойства

Броски:

JAXRPCException - если недопустимое или неподдерживаемое имя свойства передают.

removeProperty

void removeProperty(java.lang.String name)

Удаляет именованное свойство.

Параметры:

name - Имя свойства

Броски:

JAXRPCException - если недопустимое или неподдерживаемое имя свойства передают.

getPropertyNames

java.util.Iterator getPropertyNames()

Получает имена конфигурируемых свойств, поддерживаемых этим Call объект.

Возвраты:

Iterator для имен свойства

вызвать

java.lang.Object invoke(java.lang.Object[] inputParams)
                        throws java.rmi.RemoteException

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

Параметры:

inputParams - Объект [] - Параметры для этого вызова. Это включает только ввод params

Возвраты:

Возвращает возвращаемое значение или null

Броски:

java.rmi.RemoteException - если есть ошибка в удаленном вызове метода

SOAPFaultException - Указывает на отказ SOAP

JAXRPCException -

• Если есть ошибка в конфигурации Call объект
• Если inputParams не соответствуйте набор обязательного параметра (как определено через addParameter вызовы или в соответствующем WSDL)
• Если параметры и тип возврата неправильно определяются

вызвать

java.lang.Object invoke(javax.xml.namespace.QName operationName,
                        java.lang.Object[] inputParams)
                        throws java.rmi.RemoteException

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

Параметры:

operationName - QName работы

inputParams - Объект [] - Параметры для этого вызова. Это включает только ввод params.

Возвраты:

Возвращаемое значение или нуль

Броски:

java.rmi.RemoteException - если есть ошибка в удаленном вызове метода.

SOAPFaultException - Указывает на отказ SOAP

JAXRPCException -

• Если есть ошибка в конфигурации Call объект
• Если inputParams не соответствуют набор обязательного параметра (как определено через addParameter вызовы или в соответствующем WSDL)
• Если параметры и тип возврата неправильно определяются

invokeOneWay

void invokeOneWay(java.lang.Object[] inputParams)

Вызывает удаленный метод, используя односторонний режим взаимодействия. Клиентский поток обычно не блокирует ожидание завершения обработки сервера для этого удаленного вызова метода. Когда протоколом в использовании является SOAP/HTTP, этот метод должен блокировать, пока код ответа HTTP не был получен, или ошибка происходит. Этот метод не должен выдать удаленные исключения. Этот метод может бросить a JAXRPCException во время обработки одностороннего удаленного вызова.

Параметры:

inputParams - Объект [] - Параметры для этого вызова. Это включает только ввод params.

Броски:

JAXRPCException - если есть ошибка в конфигурации Call объект (пример: непустой тип возврата был неправильно определен для одностороннего вызова), или если есть ошибка во время вызова одностороннего удаленного вызова

getOutputParams

java.util.Map getOutputParams()

Возвраты a Map из {имя, значение} для выходных параметров последней вызванной работы. Названия параметра в возвращенной Карте имеют тип java.lang.String.

Возвраты:

Отобразите Выходные параметры для последнего Call.invoke(). Пустой Map возвращается, если нет никаких выходных параметров.

Броски:

JAXRPCException - Если этот метод вызывается для односторонней работы или вызывается перед кем-либо invoke метод вызвали.

getOutputValues

java.util.List getOutputValues()

Возвраты a List значения для выходных параметров последней вызванной работы.

Возвраты:

java.util. Значения списка для выходных параметров. Пустое List возвращается, если нет никаких выходных значений.

Броски:

JAXRPCException - Если этот метод вызывается для односторонней работы или вызывается перед кем-либо invoke метод вызвали.