包 | mx.rpc.soap |
类 | public class AbstractWebService |
继承 | AbstractWebService AbstractService Proxy Object |
子类 | WebService |
属性 | 定义方 | ||
---|---|---|---|
channelSet : ChannelSet 提供对服务使用的 ChannelSet 的访问。 | AbstractService | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
description : String 当前活动端口的服务描述。 | AbstractWebService | ||
destination : String 服务的目标。 | AbstractWebService | ||
endpointURI : String WebService 的位置。 | AbstractWebService | ||
headers : Array [只读 (read-only)] 返回为 WebService 注册的 SOAPHeaders 数组。 | AbstractWebService | ||
httpHeaders : Object 发送到 SOAP 端点的自定义 HTTP 标头。 | AbstractWebService | ||
makeObjectsBindable : Boolean 当该置为 true 时,返回的匿名对象将强制成为可绑定的对象。 | AbstractWebService | ||
operations : Object 如果使用 MXML 标签创建服务,则操作数组通常仅由 MXML 编译器设置。 | AbstractService | ||
port : String 指定此 WebService 应使用的 WSDL 文档中的端口. | AbstractWebService | ||
prototype : Object [静态]
对类或函数对象的原型对象的引用。 | Object | ||
ready : Boolean [只读 (read-only)] 指定 WebService 是否准备好发送请求。 | AbstractWebService | ||
requestTimeout : int 提供对已发送消息的请求超时(以秒为单位)的访问。 | AbstractService | ||
rootURL : String WebService 在计算相对 URL 时应使用的 URL。 | AbstractWebService | ||
service : String 指定此 WebService 应使用的 WSDL 文档中的服务。 | AbstractWebService | ||
useProxy : Boolean 指定是否使用 Flex 代理服务。 | AbstractWebService | ||
xmlSpecialCharsFilter : Function 用于在对任何简单内容编码之前转义 XML 特殊字符的自定义函数。 | AbstractWebService |
方法 | 定义方 | ||
---|---|---|---|
创建一个新的 WebService。 | AbstractWebService | ||
添加将应用于此 Web 服务所有操作的标头。 | AbstractWebService | ||
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void 添加将应用于此 WebService 所有操作的标头。 | AbstractWebService | ||
清除应用于所有操作的标头。 | AbstractWebService | ||
断开此服务的网络连接并删除任何未处理的请求 responder。 | AbstractService | ||
如果根据 QName、localName 和 URI 找到匹配项,则返回标头。 | AbstractWebService | ||
返回给定名称的操作。 | AbstractService | ||
指示对象是否已经定义了指定的属性。 | Object | ||
指示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
将用户从目标中注销。 | AbstractService | ||
指示指定的属性是否存在、是否可枚举。 | Object | ||
从所有操作中删除具有给定 QName 的标头。 | AbstractWebService | ||
当在服务器端使用 Data Services 时,为服务访问的目标设置凭据。 | AbstractService | ||
设置循环操作动态属性的可用性。 | Object | ||
在访问 webservice 时对用户进行身份验证的用户名和密码。 | AbstractWebService | ||
返回指定对象的字符串表示形式。 | Object | ||
返回指定对象的原始值。 | Object |
常量 | 定义方 | ||
---|---|---|---|
DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [静态] 通过代理调用 WebService 时,对 HTTP 连接要使用的默认目标。 | AbstractWebService | ||
DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [静态] 通过代理调用 WebService 时,对 HTTPS 连接要使用的默认目标。 | AbstractWebService |
description | 属性 |
description:String
[读写] 当前活动端口的服务描述。
public function get description():String
public function set description(value:String):void
destination | 属性 |
destination:String
[读写] 服务的目标。该值应与 services-config.xml 文件中的目标条目匹配。
public function get destination():String
public function set destination(value:String):void
endpointURI | 属性 |
endpointURI:String
[读写] WebService 的位置。通常,WSDL 文档指定服务的位置,但可设置此属性来覆盖该位置。
public function get endpointURI():String
public function set endpointURI(value:String):void
headers | 属性 |
headers:Array
[只读 (read-only)] 返回为 WebService 注册的 SOAPHeaders 数组。
public function get headers():Array
httpHeaders | 属性 |
httpHeaders:Object
[读写] 发送到 SOAP 端点的自定义 HTTP 标头。如果需要以相同名称发送多个标头,应将值指定为一个数组。
public function get httpHeaders():Object
public function set httpHeaders(value:Object):void
makeObjectsBindable | 属性 |
makeObjectsBindable:Boolean
[读写] 当该置为 true 时,返回的匿名对象将强制成为可绑定的对象。
public function get makeObjectsBindable():Boolean
public function set makeObjectsBindable(value:Boolean):void
port | 属性 |
port:String
[读写] 指定此 WebService 应使用的 WSDL 文档中的端口.
public function get port():String
public function set port(value:String):void
ready | 属性 |
rootURL | 属性 |
rootURL:String
[读写]
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
[读写] 指定此 WebService 应使用的 WSDL 文档中的服务。
public function get service():String
public function set service(value:String):void
useProxy | 属性 |
useProxy:Boolean
[读写]
指定是否使用 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
[读写] 用于在对任何简单内容编码之前转义 XML 特殊字符的自定义函数。除非专门在操作级上进行了覆盖,否则对 Web 服务上的所有操作有效。如果未提供,则默认为由 IXMLEncoder 的特定实现设置的相应内容。
public function get xmlSpecialCharsFilter():Function
public function set xmlSpecialCharsFilter(value:Function):void
AbstractWebService | () | 构造函数 |
public function AbstractWebService(destination:String = null, rootURL:String = null)
创建一个新的 WebService。目标(如果已指定)应与 services-config.xml 中的条目匹配。如果未指定,WebService 使用 DefaultHTTP 目标。如果打算使用相对 URL 查找此 WebService 的 WSDL 文档,则 rootURL
是必需的。
destination:String (default = null )
| |
rootURL:String (default = null )
|
addHeader | () | 方法 |
public function addHeader(header:Object):void
添加将应用于此 Web 服务所有操作的标头。标头可以以预编码形式提供,可以作为 XML 实例,也可以作为 SOAPHeader 实例(将编码留给内部 SOAP 编码器处理)。
参数
header:Object — 要添加到所有操作的 SOAP 标头。 |
addSimpleHeader | () | 方法 |
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
添加将应用于此 WebService 所有操作的标头。
参数
qnameLocal:String — 标头 QName 的 localname。 | |
qnameNamespace:String — 标头 QName 的命名空间。 | |
headerName:String — 标头的名称。 | |
headerValue:String — 标头的值。 |
clearHeaders | () | 方法 |
public function clearHeaders():void
清除应用于所有操作的标头。
getHeader | () | 方法 |
public function getHeader(qname:QName, headerName:String = null):SOAPHeader
如果根据 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
从所有操作中删除具有给定 QName 的标头。
参数
qname:QName — SOAPHeader 的 QName。 | |
headerName:String (default = null ) — (可选)SOAPHeader 内容中标头的名称。 |
setRemoteCredentials | () | 方法 |
override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
在访问 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"
通过代理调用 WebService 时,对 HTTP 连接要使用的默认目标。如果不提供目标,并将 useProxy
属性设置为 true
,则将使用默认目标将请求路由至 WebSerive 端点。
注意,如果使用默认目标,则必须在客户端上指定 WSDL 和 endpointURI。如果使用非默认的代理目标,则可以在目标配置中指定 WSDL 和 endpointURI。
DEFAULT_DESTINATION_HTTPS | 常量 |
public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"
通过代理调用 WebService 时,对 HTTPS 连接要使用的默认目标。如果不提供目标,并将 useProxy
属性设置为 true
,则将使用默认目标将请求路由至 WebSerive 端点。
注意,如果使用默认目标,则必须在客户端上指定 WSDL 和 endpointURI。如果使用非默认的代理目标,则可以在目标配置中指定 WSDL 和 endpointURI。