AbstractWebService

Пакет	mx.rpc.soap
Класс	public class AbstractWebService
Наследование	AbstractWebService AbstractService Proxy
Подклассы	WebService

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

AbstractWebService представляет собой абстрактный базовый класс для реализаций, которые обеспечивают доступ RPC к web-службам на основе SOAP. Этот класс не загружает WSDL-описания во время выполнения.

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		channelSet : ChannelSet Предоставляет доступ к ChannelSet, используемому данной службой.	AbstractService
		convertParametersHandler : Function Дополнительная функция, предназначенная, главным образом, для разработчиков инфраструктуры, которые должны установить функцию для вызова с параметрами, передаваемыми в каждый вызов операции web-службы.	AbstractWebService
		convertResultHandler : Function Дополнительная функция, предназначенная, прежде всего, для разработчиков инфраструктуры, которые должны установить функцию для обработки результатов операции перед уведомлением обработчиков результатов.	AbstractWebService
		description : String Описание службы для активного в настоящее время порта.	AbstractWebService
		destination : String [переопределить] Адрес назначения службы.	AbstractWebService
		endpointURI : String Местоположение WebService.	AbstractWebService
		headers : Array [только для чтения] Возвращает массив SOAPHeaders, зарегистрированный для WebService.	AbstractWebService
		httpHeaders : Object Пользовательские заголовки HTTP, передаваемые в конечную точку SOAP.	AbstractWebService
		makeObjectsBindable : Boolean Если значение равно true, возвращенные анонимные объекты принудительно передаются объектам со свойством bindable.	AbstractWebService
		managers : Array Свойство managers используется для хранения списка менеджеров данных, которые изменяют поведение этой службы.	AbstractService
		operations : Object Массив операций обычно устанавливается только компилятором MXML при создании службы посредством тега MXML.	AbstractService
		port : String Указывает порт в документе WSDL, который должен использовать этот WebService.	AbstractWebService
		ready : Boolean [только для чтения] Определяет готовность WebService к созданию запросов.	AbstractWebService
		requestTimeout : int Предоставляет доступ к тайм-ауту запроса в секундах для переданных сообщений.	AbstractService
		rootURL : String URL для использования WebService при вычислении относительных URL.	AbstractWebService
		service : String Указывает службу в документе WSDL для использования в данной службе WebService.	AbstractWebService
		useProxy : Boolean Указывает, требуется ли использовать службу прокси Flex.	AbstractWebService
		xmlSpecialCharsFilter : Function Пользовательская функция, которая используется для экранирования специальных символов XML перед кодированием любого простого содержимого.	AbstractWebService

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		AbstractWebService(destination:String = null, rootURL:String = null) Создает новый экземпляр WebService.	AbstractWebService
		addHeader(header:Object):void Добавляет заголовок, применимый ко всем операциям этой web-службы.	AbstractWebService
		addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void Добавляет заголовок, применимый ко всем операциям WebService.	AbstractWebService
		clearHeaders():void Очищает заголовки, применимые ко всем операциям.	AbstractWebService
		disconnect():void Разъединяет сетевое подключение службы и удаляет любые ответчики для запросов в очереди.	AbstractService
		getHeader(qname:QName, headerName:String = null):SOAPHeader Возвращает заголовок, если найденное соответствие основано на значениях QName, localName и URI.	AbstractWebService
		getOperation(name:String):AbstractOperation Возвращает операцию для данного имени.	AbstractService
		initialize():void Вызов для инициализации службы.	AbstractService
		logout():void Регистрирует пользователя за пределами адреса назначения.	AbstractService
		removeHeader(qname:QName, headerName:String = null):void Удаляет заголовок с данным QName из всех операций.	AbstractWebService
		setCredentials(username:String, password:String, charset:String = null):void Устанавливает учетные данные для адреса назначения, к которому обращалась служба при использовании Data Services на стороне сервера.	AbstractService
		setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void [переопределить] Имя пользователя и пароль для аутентификации пользователя при получении доступа к web-службе.	AbstractWebService

События

Дополнительные сведения о событиях

Скрыть унаследованные события

Показать унаследованные события

	Сводка	Определено
fault	Событие ошибки передается при ошибке вызова службы и отсутствии обработки этого вызова операцией.	AbstractService
invoke	Событие вызова передается при вызове операции службы при отсутствии ошибки до попытки канала передать сообщение.	AbstractService
result	Событие результата передается при успешном возврате вызова службы и отсутствии обработки этого вызова операцией.	AbstractService

Общедоступные константы

	Константа		Определено
		DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [статические] Заданный по умолчанию адрес назначения для использования подключений HTTP при вызове web-службы через прокси.	AbstractWebService
		DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [статические] Заданный по умолчанию адрес назначения для использования подключений HTTPS при вызове web-службы через прокси.	AbstractWebService

Сведения о свойстве

convertParametersHandler

свойство

public var convertParametersHandler:Function

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Дополнительная функция, предназначенная, главным образом, для разработчиков инфраструктуры, которые должны установить функцию для вызова с параметрами, передаваемыми в каждый вызов операции web-службы. Функция получает массив параметров и возвращает потенциально измененный массив. Определение функции должно иметь следующий вид: function myParametersFunction(parameters:Array):Array.

convertResultHandler

свойство

public var convertResultHandler:Function

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Дополнительная функция, предназначенная, прежде всего, для разработчиков инфраструктуры, которые должны установить функцию для обработки результатов операции перед уведомлением обработчиков результатов. Определение функции должно иметь следующий вид: function myConvertResultsFunction(result: operation:AbstractOperation):. Результат передается только после преобразования makeObjectsBindable, но до создания события результата.

description

свойство

description:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Описание службы для активного в настоящее время порта.

Реализация
public function get description():String
public function set description(value:String):void

destination

свойство

destination:String[переопределить]

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Адрес назначения службы. Это значение должно соответствовать значению адреса в файле services-config.xml.

Реализация
override public function get destination():String
override public function set destination(value:String):void

endpointURI

свойство

endpointURI:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Местоположение WebService. Как правило, WSDL-документ указывает местоположение служб, но это свойство можно настроить это свойство для отмены определенного местоположения.

Реализация
public function get endpointURI():String
public function set endpointURI(value:String):void

headers

свойство

headers:Array [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Возвращает массив SOAPHeaders, зарегистрированный для WebService.

Реализация
public function get headers():Array

httpHeaders

свойство

httpHeaders:Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Пользовательские заголовки HTTP, передаваемые в конечную точку SOAP. Если требуется передать несколько заголовков с одним именем, необходимо указать значение как массив.

Реализация
public function get httpHeaders():Object
public function set httpHeaders(value:Object):void

makeObjectsBindable

свойство

makeObjectsBindable:Boolean

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Если значение равно true, возвращенные анонимные объекты принудительно передаются объектам со свойством bindable.

Реализация
public function get makeObjectsBindable():Boolean
public function set makeObjectsBindable(value:Boolean):void

port

свойство

port:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает порт в документе WSDL, который должен использовать этот WebService.

Реализация
public function get port():String
public function set port(value:String):void

ready

свойство

ready:Boolean [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Определяет готовность WebService к созданию запросов.

Реализация
public function get ready():Boolean

rootURL

свойство

rootURL:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

URL для использования WebService при вычислении относительных URL. Это свойство используется только при передаче через прокси. Если для свойства useProxy установлено значение false, относительный URL вычисляется автоматически на основе местоположения SWF, выполняемого данным приложением. Если значение rootURL не установлено явно, в качестве этого значения автоматически используется URL mx.messaging.config.LoaderConfig.url.

Реализация
public function get rootURL():String
public function set rootURL(value:String):void

service

свойство

service:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает службу в документе WSDL для использования в данной службе WebService.

Реализация
public function get service():String
public function set service(value:String):void

useProxy

свойство

useProxy:Boolean

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает, требуется ли использовать службу прокси Flex. Значение по умолчанию false. Если для запросов прокси через сервер Flex не указано значение true, необходимо обеспечить возможность достижения целевого URL для Flash Player. Также невозможно использовать адреса назначения, определенные в файле services-config.xml, если для свойства useProxy установлено значение false.

Значением по умолчанию является false.

Реализация
public function get useProxy():Boolean
public function set useProxy(value:Boolean):void

xmlSpecialCharsFilter

свойство

xmlSpecialCharsFilter:Function

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Пользовательская функция, которая используется для экранирования специальных символов XML перед кодированием любого простого содержимого. Допустимо для всех операций web-службы, если эта настройка не была специально перезаписана на уровне операции. Если значение не предоставляется, определенная реализация IXMLEncoder устанавливает функцию по умолчанию.

Реализация
public function get xmlSpecialCharsFilter():Function
public function set xmlSpecialCharsFilter(value:Function):void

Сведения о конструкторе

()

Конструктор

public function AbstractWebService(destination:String = null, rootURL:String = null)

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Создает новый экземпляр WebService. Адрес назначения, если он указан, должен соответствовать значению в файле services-config.xml. Если значение не указано, WebService использует адрес назначения DefaultHTTP. rootURL требуется в случае, если для поиска WSDL-документа для WebService предполагается использовать относительный URL.

Параметры

	`destination:String` (default = `null`) — Адрес назначения. Он должен соответствовать имени адреса назначения в файле services-config.xml.

	`rootURL:String` (default = `null`) — URL для использования WebService при вычислении относительных URL.

Сведения о методе

addHeader

()

метод

public function addHeader(header:Object):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Добавляет заголовок, применимый ко всем операциям этой web-службы. Заголовок может предоставляться в предварительно закодированной форме как экземпляр XML или экземпляр SOAPHeader, кодирование для которого выполняется внутренним кодировщиком SOAP.

Параметры

header:Object — Заголовок SOAP для добавления ко всем операциям.

addSimpleHeader

()

метод

public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Добавляет заголовок, применимый ко всем операциям WebService.

Параметры

	`qnameLocal:String` — Локальное имя для заголовка QName.

	`qnameNamespace:String` — Пространство имен для заголовка QName.

	`headerName:String` — Имя заголовка.

	`headerValue:String` — Значение заголовка.

clearHeaders

()

метод

public function clearHeaders():void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Очищает заголовки, применимые ко всем операциям.

getHeader

()

метод

public function getHeader(qname:QName, headerName:String = null):SOAPHeader

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Возвращает заголовок, если найденное соответствие основано на значениях QName, localName и URI.

Параметры

	`qname:QName` — QName для SOAPHeader.

	`headerName:String` (default = `null`) — (Дополнительно) Имя заголовка в содержимом SOAPHeader.

Возвращает

SOAPHeader — Возвращает заголовок, если найденное соответствие основано на значениях QName, localName и URI.

removeHeader

()

метод

public function removeHeader(qname:QName, headerName:String = null):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Удаляет заголовок с данным QName из всех операций.

Параметры

	`qname:QName` — QName для SOAPHeader.

	`headerName:String` (default = `null`) — (Дополнительно) Имя заголовка в содержимом SOAPHeader.

setRemoteCredentials

()

метод

override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Имя пользователя и пароль для аутентификации пользователя при получении доступа к web-службе. Они передаются как часть заголовка HTTP-авторизации от прокси в конечную точку. Если для useProxy установлено значение false, это свойство игнорируется.

Параметры

	`remoteUsername:String` — Имя пользователя для передачи в удаленную конечную точку.

	`remotePassword:String` — Пароль для передачи в удаленную конечную точку.

	`charset:String` (default = `null`) — Кодировка набора символов для использования при кодировании учетных данных в удаленной службе. По умолчанию имеет нулевое значение, при котором используется унаследованный набор символов ISO-Latin-1. Помимо этого поддерживается только набор символов UTF-8.

Сведения о константе

DEFAULT_DESTINATION_HTTP

Константа

public static const DEFAULT_DESTINATION_HTTP:String = "DefaultHTTP"

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Заданный по умолчанию адрес назначения для использования подключений HTTP при вызове web-службы через прокси. Если адрес назначения отсутствует, а свойство useProxy устанавливается на значение true, используются заданные по умолчанию адреса назначения для направления запросов в конечную точку web-службы.

Обратите внимание, если используются заданные по умолчанию адреса назначения, в клиенте необходимо указать WSDL и endpointURI. При использовании адреса назначения прокси не по умолчанию, WSDL и endpointURI указаны в конфигурации адреса назначения.

DEFAULT_DESTINATION_HTTPS

Константа

public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Заданный по умолчанию адрес назначения для использования подключений HTTPS при вызове web-службы через прокси. Если адрес назначения отсутствует, а свойство useProxy устанавливается на значение true, используются заданные по умолчанию адреса назначения для направления запросов в конечную точку web-службы.

Юридическая информация | Политика конфиденциальности онлайн

AbstractWebService - AS3 Flex

Классы x

convertParametersHandler

convertResultHandler

description

destination

endpointURI

headers

httpHeaders

makeObjectsBindable

port

ready

rootURL

service

useProxy

xmlSpecialCharsFilter