AbstractWebService

包	mx.rpc.soap
类	public class AbstractWebService
继承	AbstractWebService AbstractService Proxy
子类	WebService

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

AbstractWebService 是提供对基于 SOAP 的 Web 服务的 RPC 访问的实现的抽象基类。此类在运行时不加载 WSDL 说明。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		channelSet : ChannelSet 提供对服务使用的 ChannelSet 的访问。	AbstractService
		convertParametersHandler : Function 一个可选函数，主要供具有以下需要的框架开发人员使用：安装用传递给每个 webservice 操作调用的参数进行调用的函数。	AbstractWebService
		convertResultHandler : Function 一个可选函数，主要供具有以下需要的框架开发人员使用：安装一个挂钩，以便在通知结果处理程序之前处理操作的结果。	AbstractWebService
		description : String 当前活动端口的服务描述。	AbstractWebService
		destination : String [覆盖] 服务的目标。	AbstractWebService
		endpointURI : String WebService 的位置。	AbstractWebService
		headers : Array [只读] 返回为 WebService 注册的 SOAPHeaders 数组。	AbstractWebService
		httpHeaders : Object 发送到 SOAP 端点的自定义 HTTP 标头。	AbstractWebService
		makeObjectsBindable : Boolean 当该置为 true 时，返回的匿名对象将强制成为可绑定的对象。	AbstractWebService
		managers : Array managers 属性存储修改此服务行为的数据管理器的列表。	AbstractService
		operations : Object 如果使用 MXML 标签创建服务，则操作数组通常仅由 MXML 编译器设置。	AbstractService
		port : String 指定此 WebService 应使用的 WSDL 文档中的端口。	AbstractWebService
		ready : Boolean [只读] 指定 WebService 是否准备好发送请求。	AbstractWebService
		requestTimeout : int 提供对已发送消息的请求超时（以秒为单位）的访问。	AbstractService
		rootURL : String WebService 在计算相对 URL 时应使用的 URL。	AbstractWebService
		service : String 指定此 WebService 应使用的 WSDL 文档中的服务。	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 断开此服务的网络连接并删除任何未处理的请求 responder。	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 [覆盖] 在访问 webservice 时对用户进行身份验证的用户名和密码。	AbstractWebService

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
fault	当服务调用失败并且操作自身不处理时，将调度 fault 事件。	AbstractService
invoke	当调用服务操作时，只要在通道尝试发送消息前没有引发错误，将调度 invoke 事件。	AbstractService
result	当服务调用成功返回并且操作自身不处理时，将调度 result 事件。	AbstractService

公共常量

	常量		由以下参数定义
		DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [静态] 通过代理调用 WebService 时，对 HTTP 连接要使用的默认目标。	AbstractWebService
		DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [静态] 通过代理调用 WebService 时，对 HTTPS 连接要使用的默认目标。	AbstractWebService

属性详细信息

convertParametersHandler

属性

public var convertParametersHandler:Function

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

一个可选函数，主要供具有以下需要的框架开发人员使用：安装用传递给每个 webservice 操作调用的参数进行调用的函数。该函数接受一个参数数组，并返回可能改变的数组。该函数定义应该如下所示： 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

返回为 WebService 注册的 SOAPHeaders 数组。

实现
public function get headers():Array

httpHeaders

属性

httpHeaders:Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

发送到 SOAP 端点的自定义 HTTP 标头。如果需要以相同名称发送多个标头，应将值指定为一个数组。

实现
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 时，返回的匿名对象将强制成为可绑定的对象。

实现
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

指定此 WebService 应使用的 WSDL 文档中的端口。

实现
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

WebService 在计算相对 URL 时应使用的 URL。此属性仅在使用代理时使用。当 useProxy 属性设置为 to false 时，将根据运行此应用程序的 SWF 的位置自动计算相对 URL。如果未明确设置，将把 rootURL 自动设置为 mx.messaging.config.LoaderConfig.url 的 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

指定此 WebService 应使用的 WSDL 文档中的服务。

实现
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，则必须确保 Flash Player 可以到达目标 URL。如果 useProxy 属性设置为 false，则也不可以使用 services-config.xml 文件中定义的目标。

默认值为 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 目标。如果打算使用相对 URL 查找此 WebService 的 WSDL 文档，则 rootURL 是必需的。

参数

	`destination:String` (default = `null`) — 目标。该值应与 services-config.xml 文件中的目标名称匹配。

	`rootURL:String` (default = `null`) — WebService 在计算相对 URL 时应使用的 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 的 localname。

	`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` — SOAPHeader 的 QName。

	`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` — SOAPHeader 的 QName。

	`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

在访问 webservice 时对用户进行身份验证的用户名和密码。这些将作为 HTTP 身份验证标头的一部分从代理传递到端点。如果 useProxy 为 false，将忽略此属性。

参数

	`remoteUsername:String` — 要传递给远程端点的用户名。

	`remotePassword:String` — 要传递给远程端点的密码。

	`charset:String` (default = `null`) — 对远程凭据进行编码时使用的字符集编码。默认值为 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

通过代理调用 WebService 时，对 HTTP 连接要使用的默认目标。如果不提供目标，并将 useProxy 属性设置为 true，则将使用默认目标将请求路由至 WebSerive 端点。

注意，如果使用默认目标，则必须在客户端上指定 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

通过代理调用 WebService 时，对 HTTPS 连接要使用的默认目标。如果不提供目标，并将 useProxy 属性设置为 true，则将使用默认目标将请求路由至 WebSerive 端点。

注意，如果使用默认目标，则必须在客户端上指定 WSDL 和 endpointURI。如果使用非默认的代理目标，则可以在目标配置中指定 WSDL 和 endpointURI。

法律声明 | 在线隐私策略

AbstractWebService - AS3 Flex

包x

语言元素

附录

包 mx.rpc.soap

convertParametersHandler

convertResultHandler

description

destination

endpointURI

headers

httpHeaders

makeObjectsBindable

port

ready

rootURL

service

useProxy

xmlSpecialCharsFilter