ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.framework 

IBundleContext  - AS3 ADEP Client Component

Packagecom.adobe.gravity.framework
Interfacepublic interface IBundleContext extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The IBundleContext interface is the main point of access to all bundle framework functionality. The IBundleContext for a particular bundle is passed into the IBundleActivator for that bundle, if the bundle implementes that interface, or it can be accessed using BundleContext.currentContext.



Public Properties
 PropertyDefined By
  bundle : IBundle
[read-only] Retrieve the current bundle.
IBundleContext
  properties : Object
[read-only] The properties (read-only) for the given bundle.
IBundleContext
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
  
Create a filter object from the given filter objects.
IBundleContext
  
Create a filter object from the given filter objects.
IBundleContext
  
Create a filter object that inverts the sense of provided filter (if the provided filter returns true, the returned filter would return false, and vice-versa).
IBundleContext
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
Retrieve all defined bundles.
IBundleContext
  
Get the bundle with the specified id.
IBundleContext
  
Get the service object for the specified service reference.
IBundleContext
  
Get a service reference for a service.
IBundleContext
  
getServiceReferences(clazz:Class, filter:IFilter = null):Array
Get all service references of the given class matching the specified filter.
IBundleContext
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
installBundlesFromURL(bundleManifestLocation:String, allowCodeImport:Boolean = false, autoStart:Boolean = true):com.adobe.gravity.utility.async:IToken
Install all bundles in the specified bundle manifest.
IBundleContext
  
installBundlesFromXML(bundleManifest:XML, allowCodeImport:Boolean = false, autoStart:Boolean = true, baseUrl:String = null):com.adobe.gravity.utility.async:IToken
Install all bundles in the specified bundle manifest.
IBundleContext
  
Register a service object implementing the given classes.
IBundleContext
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
Release a service retrieved by getService.
IBundleContext
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Events
 Event Summary Defined By
  Dispatched when a bundle has been installed.IBundleContext
  Dispatched when a bundle is has been resolved.IBundleContext
  Dispatched when a bundle is about to be resolved.IBundleContext
  Dispatched when a bundle has been started.IBundleContext
  Dispatched when a bundle is about to be started.IBundleContext
  Dispatched when a bundle has been stopped.IBundleContext
  Dispatched when a bundle is about to be stopped.IBundleContext
  Dispatched when a bundle has been uninstalled.IBundleContext
  Dispatched when a bundle is about to be uninstalled.IBundleContext
  Dispatched when a bundle has been updated.IBundleContext
  Dispatched when a bundle is about to be updated.IBundleContext
  Dispatched when the properties of a service have been modified.IBundleContext
  Dispatched when a service has been registered.IBundleContext
  Dispatched when a service is going to be unregistered.IBundleContext
Property Detail

bundle

property
bundle:IBundle  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Retrieve the current bundle.



Implementation
    public function get bundle():IBundle

properties

property 
properties:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The properties (read-only) for the given bundle.



Implementation
    public function get properties():Object
Method Detail

createFilter

()method
public function createFilter(... filters):IFilter

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create a filter object from the given filter objects. The filter will match only when all given filters match. A SyntaxError will be thrown if a filter specified as a String or XML is not a valid filter. TBD: multiple examples are desperately needed here, because this is terribly opaque.

Parameters

... filters — One or more filter objects. A filter is either an implementation of IFilter, a String, XML, or an Object.

Returns
IFilter — An IFilter instance that will perform the specified filtering.

createFilterMatchAny

()method 
public function createFilterMatchAny(... filters):IFilter

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create a filter object from the given filter objects. The filter will match when one or more of the given filters match. A SyntaxError will be thrown if a filter specified as a String or XML is not a valid filter. TBD: multiple examples are desperately needed here, because this is terribly opaque.

Parameters

... filters — One or more filter objects. A filter is either an implementation of IFilter, a String, XML, or an Object.

Returns
IFilter — An IFilter instance that will perform the specified filtering.

createFilterMatchInverse

()method 
public function createFilterMatchInverse(filter:IFilter):IFilter

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Create a filter object that inverts the sense of provided filter (if the provided filter returns true, the returned filter would return false, and vice-versa). TBD: examples are needed here.

Parameters

filter:IFilter — The filter to invert.

Returns
IFilter — An IFilter instance that will match if and only if the provided filter does not match.

getAllBundles

()method 
public function getAllBundles():Array

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Retrieve all defined bundles.

Returns
Array — An Array of IBundle instances.

getBundle

()method 
public function getBundle(id:int):IBundle

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Get the bundle with the specified id.

Parameters

id:int — The identifier for the desired bundle.

Returns
IBundle — The requested bundle.

getService

()method 
public function getService(reference:IServiceReference):com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Get the service object for the specified service reference. This method is asynchronous; you must add a success and fault handlers to the returned IToken to retrieve the requested service or deal with any errors that occurred during service retrieval.

NOTE: A bundle may register a single service object under multiple classes. This means that in some implementations it may be possible to cast a returned service object to one of the other classes or interfaces implemented by that service object if you happen to know what those classes or interfaces are for that particular bundle. This is NOT a supported use-case, and some implementations may explicitly prevent this by injecting a proxy. If multiple interfaces should be visible on a single service object, an aggregating interface that extends all the desired interfaces should be created and the service object should be requested by that aggregating interface.

         public function getSomeService():void
         {
             var context:IBundleContext = BundleContext.currentContext;
             var reference:IServiceReference = context.getServiceReference(IFancyService);
             if (reference == null)
                 throw new NoSuchServiceError();
             var token:IToken = context.getService(reference);
             token.addSuccessHandler(doSomethingWithTheFancyService);
             token.addFailureHandler(doSomethingToIndicateAProblem);
         }
         
         public function doSomethingWithTheFancyService(service:IFancyService):void
         {
             service.doFancyOperation();
         }
         
         public function doSomethingToIndicateAProblem(error:Error):void
         {
         // deal with the error here
         }
         

Parameters

reference:IServiceReference — An IServiceReference for the desired service. The getServiceReference functions can be used to retrieve a service reference.

Returns
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the service retrieval is successful, the service object will be passed into the result handler. In other words, the result handler should take a single object of the service interface type.

getServiceReference

()method 
public function getServiceReference(clazz:Class):IServiceReference

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Get a service reference for a service. If there is more than one service for the specified class, the service with the highest ranking will be returned. If there are multiple services with the highest rank, the service that was registered first will be returned. If there are no services for the specified class, null is returned.

Parameters

clazz:Class — The service class.

Returns
IServiceReference — The service reference for the (first) service implementing the given service class, or null if there is no such service.

getServiceReferences

()method 
public function getServiceReferences(clazz:Class, filter:IFilter = null):Array

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Get all service references of the given class matching the specified filter.

Parameters

clazz:Class — The service class.
 
filter:IFilter (default = null) — A filter to restrict the services returned. The filter may be null, in which case all services implementing the given contract are returned.

Returns
Array — An array of IServiceReference objects for all the services implementing the given service contract and matching the filter.

installBundlesFromURL

()method 
public function installBundlesFromURL(bundleManifestLocation:String, allowCodeImport:Boolean = false, autoStart:Boolean = true):com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Install all bundles in the specified bundle manifest.

Parameters

bundleManifestLocation:String — The location of the bundle manifest.
 
allowCodeImport:Boolean (default = false) — Allow cross-domain loading of any SWF files in the specified manifest.
 
autoStart:Boolean (default = true) — Start the bundles in the manifest.

Returns
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the manifest load was successful, an Array containing a set of IBundle objects for the bundles from the manifest file will be passed into the result handler.

installBundlesFromXML

()method 
public function installBundlesFromXML(bundleManifest:XML, allowCodeImport:Boolean = false, autoStart:Boolean = true, baseUrl:String = null):com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Install all bundles in the specified bundle manifest.

Parameters

bundleManifest:XML — The bundle manifest XML.
 
allowCodeImport:Boolean (default = false) — Allow cross-domain loading of any SWF files in the specified manifest.
 
autoStart:Boolean (default = true) — Start the bundles in the manifest.
 
baseUrl:String (default = null) — The base URL for relative URL.

Returns
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the manifest load was successful, an Array containing a set of IBundle objects for the bundles from the manifest file will be passed into the result handler.

registerService

()method 
public function registerService(classes:Array, service:Object, properties:Object):IServiceRegistration

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Register a service object implementing the given classes.

NOTE: A bundle may register a single service object under multiple classes. This means that in some implementations it may be possible to cast a returned service object to one of the other classes or interfaces implemented by that service object if you happen to know what those classes or interfaces are for that particular bundle. This is NOT a supported use-case, and some implementations may explicitly prevent this by injecting a proxy. If multiple interfaces should be visible on a single service object, an aggregating interface that extends all the desired interfaces should be created and the service object should be requested by that aggregating interface.

Parameters

classes:Array — An array of Class objects indicating the classes implemented by the service.
 
service:Object — Either the service object itself, or an implementation of IServiceFactory. If the object is not an IServiceFactory and is not an instance of all the classes in the classes array, an exception (TODO: specify which exception) will be thrown.
 
properties:Object — Name-value metadata for the service, can be used as criteria in filters when selecting a service.

Returns
IServiceRegistration — An IServiceRegistration that can be used to manage the service.

Related API Elements

ungetService

()method 
public function ungetService(reference:IServiceReference):Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Release a service retrieved by getService.

Parameters

reference:IServiceReference — The service reference for the service to be released.

Returns
Boolean — If the bundle's usage count for the service was already zero, false is returned. Otherwise, true is returned.
Event Detail

bundleInstalled

Event
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_INSTALLED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle has been installed.

A bundle has been installed.

bundleResolved

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_RESOLVED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is has been resolved.

A bundle has been resolved.

bundleResolving

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_RESOLVING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is about to be resolved.

A bundle is about to be resolved.

bundleStarted

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_STARTED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle has been started.

A bundle has been started.

bundleStarting

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_STARTING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is about to be started.

A bundle is about to be started.

bundleStopped

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_STOPPED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle has been stopped.

A bundle has been stopped.

bundleStopping

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_STOPPING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is about to be stopped.

A bundle is about to be stopped.

bundleUninstalled

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_UNINSTALLED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle has been uninstalled.

A bundle has been uninstalled.

bundleUninstalling

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_UNINSTALLING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is about to be uninstalled.

A bundle is about to be uninstalled.

bundleUpdated

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_UPDATED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle has been updated.

A bundle has been updated.

bundleUpdating

Event  
Event Object Type: com.adobe.gravity.framework.BundleEvent
property BundleEvent.type = com.adobe.gravity.framework.BundleEvent.BUNDLE_UPDATING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a bundle is about to be updated.

A bundle is about to be updated.

serviceModified

Event  
Event Object Type: com.adobe.gravity.framework.ServiceEvent
property ServiceEvent.type = com.adobe.gravity.framework.ServiceEvent.SERVICE_MODIFIED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when the properties of a service have been modified.

The serviceModified event type indicates that the properties of the service have been modified.

serviceRegistered

Event  
Event Object Type: com.adobe.gravity.framework.ServiceEvent
property ServiceEvent.type = com.adobe.gravity.framework.ServiceEvent.SERVICE_REGISTERED

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a service has been registered.

The serviceRegistered event type indicates that the service has been registered.

serviceUnregistering

Event  
Event Object Type: com.adobe.gravity.framework.ServiceEvent
property ServiceEvent.type = com.adobe.gravity.framework.ServiceEvent.SERVICE_UNREGISTERING

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Dispatched when a service is going to be unregistered.

The serviceUnregistering event type indicates that the service is in the process of being unregistered.