mx.rpc.soap.AbstractWebService - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.rpc.soap
Class	public class AbstractWebService
Inheritance	AbstractWebService AbstractService Proxy Object
Subclasses	WebService

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

AbstractWebService is an abstract base class for implementations that provide RPC access to SOAP-based web services. This class does not load WSDL descriptions at runtime.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		channelSet : ChannelSet Provides access to the ChannelSet used by the service.	AbstractService
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		convertParametersHandler : Function An optional function, primarily intended for framework developers who need to install a function to get called with the parameters passed to each webservice operation invocation.	AbstractWebService
		convertResultHandler : Function An optional function, primarily intended for framework developers who need to install a hook to process the results of an operation before notifying the result handlers.	AbstractWebService
		description : String The description of the service for the currently active port.	AbstractWebService
		destination : String [override] The destination of the service.	AbstractWebService
		endpointURI : String The location of the WebService.	AbstractWebService
		headers : Array [read-only] Returns the array of SOAPHeaders registered for the WebService.	AbstractWebService
		httpHeaders : Object Custom HTTP headers to be sent to the SOAP endpoint.	AbstractWebService
		makeObjectsBindable : Boolean When this value is true, anonymous objects returned are forced to bindable objects.	AbstractWebService
		managers : Array The managers property stores a list of data managers which modify the behavior of this service.	AbstractService
		operations : Object The Operations array is usually only set by the MXML compiler if you create a service using an MXML tag.	AbstractService
		port : String Specifies the port within the WSDL document that this WebService should use.	AbstractWebService
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		ready : Boolean [read-only] Specifies whether the WebService is ready to make requests.	AbstractWebService
		requestTimeout : int Provides access to the request timeout in seconds for sent messages.	AbstractService
		rootURL : String The URL that the WebService should use when computing relative URLs.	AbstractWebService
		service : String Specifies the service within the WSDL document that this WebService should use.	AbstractWebService
		useProxy : Boolean Specifies whether to use the Flex proxy service.	AbstractWebService
		xmlSpecialCharsFilter : Function Custom function to be used to escape XML special characters before encoding any simple content.	AbstractWebService

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AbstractWebService(destination:String = null, rootURL:String = null) Creates a new WebService.	AbstractWebService
		addHeader(header:Object):void Adds a header that will be applied to all operations of this web service.	AbstractWebService
		addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void Add a header that will be applied to all operations of this WebService.	AbstractWebService
		clearHeaders():void Clears the headers that applied to all operations.	AbstractWebService
		disconnect():void Disconnects the service's network connection and removes any pending request responders.	AbstractService
		getHeader(qname:QName, headerName:String = null):SOAPHeader Returns a header if a match is found based on QName, localName, and URI.	AbstractWebService
		getOperation(name:String):AbstractOperation Returns an Operation of the given name.	AbstractService
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void Called to initialize the service.	AbstractService
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		logout():void Logs the user out of the destination.	AbstractService
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeHeader(qname:QName, headerName:String = null):void Removes the header with the given QName from all operations.	AbstractWebService
		setCredentials(username:String, password:String, charset:String = null):void Sets the credentials for the destination accessed by the service when using Data Services on the server side.	AbstractService
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void [override] The username and password to authenticate a user when accessing the webservice.	AbstractWebService
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
fault	The fault event is dispatched when a service call fails and isn't handled by the Operation itself.	AbstractService
invoke	The invoke event is dispatched when a service Operation is invoked so long as an Error is not thrown before the Channel attempts to send the message.	AbstractService
result	The result event is dispatched when a service call successfully returns and isn't handled by the Operation itself.	AbstractService

Public Constants

	Constant		Defined By
		DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [static] The default destination to use for HTTP connections when invoking a webservice through a proxy.	AbstractWebService
		DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [static] The default destination to use for HTTPS connections when invoking a webservice through a proxy.	AbstractWebService

Property Detail

convertParametersHandler

property

public var convertParametersHandler:Function

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An optional function, primarily intended for framework developers who need to install a function to get called with the parameters passed to each webservice operation invocation. The function takes an array of parameters and returns the potentially altered array. The function definition should look like: function myParametersFunction(parameters:Array):Array

convertResultHandler

property

public var convertResultHandler:Function

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An optional function, primarily intended for framework developers who need to install a hook to process the results of an operation before notifying the result handlers. The function definition should look like: function myConvertResultsFunction(result: operation:AbstractOperation): It is passed the result just after the makeObjectsBindable conversion has been done but before the result event is created.

description

property

description:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The description of the service for the currently active port.

Implementation
public function get description():String
public function set description(value:String):void

destination

property

destination:String[override]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The destination of the service. This value should match a destination entry in the services-config.xml file.

Implementation
override public function get destination():String
override public function set destination(value:String):void

endpointURI

property

endpointURI:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The location of the WebService. Normally, the WSDL document specifies the location of the services, but you can set this property to override that location.

Implementation
public function get endpointURI():String
public function set endpointURI(value:String):void

headers

property

headers:Array [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the array of SOAPHeaders registered for the WebService.

Implementation
public function get headers():Array

httpHeaders

property

httpHeaders:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Custom HTTP headers to be sent to the SOAP endpoint. If multiple headers need to be sent with the same name the value should be specified as an Array.

Implementation
public function get httpHeaders():Object
public function set httpHeaders(value:Object):void

makeObjectsBindable

property

makeObjectsBindable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

When this value is true, anonymous objects returned are forced to bindable objects.

Implementation
public function get makeObjectsBindable():Boolean
public function set makeObjectsBindable(value:Boolean):void

port

property

port:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies the port within the WSDL document that this WebService should use.

Implementation
public function get port():String
public function set port(value:String):void

ready

property

ready:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies whether the WebService is ready to make requests.

Implementation
public function get ready():Boolean

rootURL

property

rootURL:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The URL that the WebService should use when computing relative URLs. This property is only used when going through the proxy. When the useProxy property is set to false the relative URL is computed automatically based on the location of the SWF running this application. If not set explicitly rootURL is automatically set to the URL of mx.messaging.config.LoaderConfig.url.

Implementation
public function get rootURL():String
public function set rootURL(value:String):void

service

property

service:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies the service within the WSDL document that this WebService should use.

Implementation
public function get service():String
public function set service(value:String):void

useProxy

property

useProxy:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Specifies whether to use the Flex proxy service. The default value is false. If you do not specify true to proxy requests though the Flex server, you must ensure that Flash Player can reach the target URL. You also cannot use destinations defined in the services-config.xml file if the useProxy property is set to false.

The default value is false.

Implementation
public function get useProxy():Boolean
public function set useProxy(value:Boolean):void

xmlSpecialCharsFilter

property

xmlSpecialCharsFilter:Function

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Custom function to be used to escape XML special characters before encoding any simple content. Valid for all operations on the web service unless specifically overwritten on the operation level. If none is provided, the default function is whatever is set by the particular implementation of IXMLEncoder.

Implementation
public function get xmlSpecialCharsFilter():Function
public function set xmlSpecialCharsFilter(value:Function):void

Constructor Detail

AbstractWebService

()

Constructor

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a new WebService. The destination, if specified, should match an entry in services-config.xml. If unspecified, the WebService uses the DefaultHTTP destination. The rootURL is required if you intend to use a relative URL find the WSDL document for this WebService.

Parameters

	`destination:String` (default = `null`) — The destination. It should match a destination name in the services-config.xml file.

	`rootURL:String` (default = `null`) — The URL that the WebService should use when computing relative URLs.

Method Detail

addHeader

()

method

public function addHeader(header:Object):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Adds a header that will be applied to all operations of this web service. The header can be provided in a pre-encoded form as an XML instance, or as a SOAPHeader instance which leaves the encoding up to the internal SOAP encoder.

Parameters

header:Object — The SOAP header to add to all operations.

addSimpleHeader

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Add a header that will be applied to all operations of this WebService.

Parameters

	`qnameLocal:String` — The localname for the header QName.

	`qnameNamespace:String` — The namespace for the header QName.

	`headerName:String` — The name of the header.

	`headerValue:String` — The value of the header.

clearHeaders

()

method

public function clearHeaders():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Clears the headers that applied to all operations.

getHeader

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a header if a match is found based on QName, localName, and URI.

Parameters

	`qname:QName` — QName of the SOAPHeader.

	`headerName:String` (default = `null`) — (Optional) Name of a header in the SOAPHeader content.

Returns

SOAPHeader — Returns a header if a match is found based on QName, localName, and URI.

removeHeader

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Removes the header with the given QName from all operations.

Parameters

	`qname:QName` — QName of the SOAPHeader.

	`headerName:String` (default = `null`) — (Optional) Name of a header in the SOAPHeader content.

setRemoteCredentials

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The username and password to authenticate a user when accessing the webservice. These will be passed as part of the HTTP Authorization header from the proxy to the endpoint. If useProxy is false this property will be ignored.

Parameters

	`remoteUsername:String` — The username to pass to the remote endpoint.

	`remotePassword:String` — The password to pass to the remote endpoint.

	`charset:String` (default = `null`) — The character set encoding to use while encoding the remote credentials. The default is null, which implies the legacy charset of ISO-Latin-1. The only other supported charset is "UTF-8".

Constant Detail

DEFAULT_DESTINATION_HTTP

Constant

public static const DEFAULT_DESTINATION_HTTP:String = "DefaultHTTP"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The default destination to use for HTTP connections when invoking a webservice through a proxy. If you don't provide a destination and you set the useProxy property to true, the default destinations will be used to route the requests to the webservice endpoint.

Note that if the default destinations are used, you must specify the WSDL and endpointURI on the client. If you use a non-default proxy destination, you can have the WSDL and endpointURI specified in the destination configuration.

DEFAULT_DESTINATION_HTTPS

Constant

public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The default destination to use for HTTPS connections when invoking a webservice through a proxy. If you don't provide a destination and you set the useProxy property to true, the default destinations will be used to route the requests to the webservice endpoint.