com.asfusion.mate.actions.builders.WebServiceInvoker

Public Properties

	Property		Defined by
		arguments : * The property `arguments` allows you to pass an Object or an Array of objects when calling the function defined in the property `method`.	WebServiceInvoker
		channelSet : ChannelSet Provides access to the ChannelSet used by the service.	ServiceInvoker
		debug : Boolean Whether to show debugging information for its inner-handlerss.	AbstractServiceInvoker
		description : String The description of the service for the currently active port.	WebServiceInvoker
		destination : String The destination of the service.	ServiceInvoker
		endpointURI : String The location of the WebService.	WebServiceInvoker
		faultHandlers : Array A set of inner-handlers to run when the server call returns a fault.	AbstractServiceInvoker
		httpHeaders : Object Custom HTTP headers to be sent to the SOAP endpoint.	WebServiceInvoker
		instance : WebService If this property is null, a new WebService instance is created on the `prepare` method.	WebServiceInvoker
		makeObjectsBindable : Boolean When this value is true, anonymous objects returned are forced to bindable objects.	ServiceInvoker
		method : Object The `method` attribute specifies what function to call on the service instance.	ServiceInvoker
		password : Object Password to supply to `setCredentials` method	ServiceInvoker
		port : String Specifies the port within the WSDL document that this WebService should use	WebServiceInvoker
		properties : Array `Properties` allows you to add properties to the `currentInstance`.	BaseAction
		remotePassword : Object Password to supply to `setCredentials` method	ServiceInvoker
		remoteUsername : Object Username to supply to `setCredentials` method	ServiceInvoker
		requestTimeout : int Provides access to the request timeout in seconds for sent messages.	ServiceInvoker
		resultHandlers : Array A set of inner-handlers to run when the server call returns a result.	AbstractServiceInvoker
		rootURL : String The URL that the WebService object should use when computing relative URLs.	WebServiceInvoker
		service : String Specifies the service within the WSDL document that this WebService should use.	WebServiceInvoker
		useProxy : Boolean Specifies whether to use the Flex proxy service.	WebServiceInvoker
		username : Object Username to supply to `setCredentials` method	ServiceInvoker
		wsdl : String The location of the WSDL document for this WebService.	WebServiceInvoker

	Property	Defined by
		autoUnregistration : Boolean = true When auto unregistration is true, all inner handlers will be unregistered after the first inner handlers fires.	AbstractServiceInvoker
		currentIndex : int = 0 Index used to store groups of inner handlers.	AbstractServiceInvoker
		currentInstance : * = null The `currentInstance` is the Object that this class will use and modify to do its work.	AbstractAction
		document : Object A reference to the document object associated with the IActionList that contains this action item.	AbstractAction
		innerHandlersClass : Class Class that is used as a template to create the inner-handlers	AbstractServiceInvoker
		innerHandlersDispatcher : IEventDispatcher Dispatcher that will trigger the inner-handlers execution by dispatching events (ie: ResultEvent or FaultEvent).	AbstractServiceInvoker
		innerHandlersList : Array Inner handlers list that stores all inner handlers indexed by the currentIndex.	AbstractServiceInvoker
		token : AsyncToken Generated when making asynchronous RPC operations.	ServiceInvoker

	Method	Defined by
		initialized(document:Object, id:String):void Called automatically by the MXML compiler if the AbstractAction is set up by using a tag.	AbstractAction
		trigger(scope:IScope):void This method gets called when the IActionList (ex: EventHandlers) is running.	AbstractAction

	Method	Defined by
		actionListStartHandler(event:ActionListEvent):void Handler that will be fired when the first of the innerHandlers starts executing.	AbstractServiceInvoker
		complete(scope:IScope):void The last method that `trigger` calls.	ServiceInvoker
		createInnerHandlers(scope:IScope, innerType:String, actionList:Array, innerHandlersClass:Class = null):IActionList Creates IActionList and sets the properties: debug, type, listeners, dispatcher and inheritScope in the newly IActionList (inner-handlers).	AbstractServiceInvoker
		prepare(scope:IScope):void The first method that `trigger` calls.	WebServiceInvoker
		run(scope:IScope):void Where all the action occurs.	WebServiceInvoker
		setProperties(scope:IScope):void Where all the properties are set into the `currentInstance`.	BaseAction

Property detail

arguments

property

arguments:* [read-write]

The property arguments allows you to pass an Object or an Array of objects when calling the function defined in the property method. You can use an array to pass multiple arguments or use a simple Object if the signature of the method has only one parameter.

The default value is undefined.

Implementation
public function get arguments():*
public function set arguments(value:*):void

description

property

description:String [read-write]

The description of the service for the currently active port.

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

endpointURI

property

endpointURI:String [read-write]

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

httpHeaders

property

httpHeaders:Object [read-write]

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

instance

property

instance:WebService [read-write]

If this property is null, a new WebService instance is created on the prepare method. Otherwise, this instance will be used. The class that will be used to create the instance if none is provided is mx.rpc.soap.mxml.WebService.

The default value is null.

Implementation
public function get instance():WebService
public function set instance(value:WebService):void

port

property

port:String [read-write]

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

rootURL

property

rootURL:String [read-write]

The URL that the WebService object 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 [read-write]

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 [read-write]

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 the 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.

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

wsdl

property

wsdl:String [read-write]

The location of the WSDL document for this WebService. If you use a relative URL, make sure that the rootURL has been specified or that you created the WebService in MXML.

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

Method detail

prepare

()

method

protected override function prepare(scope:IScope):void

The first method that trigger calls. Usually, this is where the currentInstance is created or set if needed. In this method you can also perform any code that must be done first.

Parameters

scope:IScope

run

()

method

protected override function run(scope:IScope):void

Where all the action occurs. At this moment, the currentInstance is already instantiated and all the properties are already set.

Parameters

scope:IScope

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class WebServiceInvoker	Properties \| Methods

Package	com.asfusion.mate.actions.builders
Class	public class WebServiceInvoker
Inheritance	WebServiceInvoker ServiceInvoker AbstractServiceInvoker BaseAction AbstractAction
Implements	IAction