+Show TOC
×Hide TOC

ServiceProxyLocator

Kind of class:	public class
Package:	com.bourre.remoting
Inherits from:	none
Implements:	Locator
Author:	romain
Classpath:	com.bourre.remoting.ServiceProxyLocator
File last modified:	Monday, 24 November 2008, 11:36:48

► View source

▼ Hide source

package com.bourre.remoting
{
    import com.bourre.collection.HashMap;
    import com.bourre.core.Locator;
    import com.bourre.log.PixlibDebug;
    
    import flash.net.URLRequest;
    import flash.utils.Dictionary;        

    /**
     * @author romain
     */
    public class ServiceProxyLocator
      implements Locator
    {
        public var gatewayURL : URLRequest;
        private var _m : HashMap;
        
        public function ServiceProxyLocator( )
        {
            _m = new HashMap();
        }
        
        public function setCredentials( sUserID : String, sPassword : String ) : void
        {
            if ( !hasGateway() ) 
            {
                RemotingDebug.ERROR("**Error** GatewayURL is undefined in " + this );
                return;
            }
            RemotingConnection.getRemotingConnection( gatewayURL.url ).setCredentials( sUserID, sPassword );
        }
        
        public function registerService( sServiceName : String, service : AbstractServiceProxy ) : void
        {
            if ( !hasGateway() ) 
            {
                RemotingDebug.ERROR("**Error** GatewayURL is undefined in " + this );
                return;
                
            } else if ( isRegistered( sServiceName ) )
            {
                RemotingDebug.ERROR( "A service instance is already registered with '" + sServiceName + "' name." );
                return;
                
            } else
            {
                if (service)
                {
                    if (service.getURL() == null ) service.setURL( gatewayURL );
                    _m.put( sServiceName, service );
                    
                } else
                {
                    _m.put( sServiceName, new ServiceProxy( gatewayURL, sServiceName) );
                }
            }
        }
        
        // Locator implementation 
        public function isRegistered( key : String ) : Boolean
        {
            return _m.containsKey( key ) ;
        }
        
        public function locate( key : String ) : Object
        {
            if (!_m.containsKey( key ) ) 
            {
                RemotingDebug.ERROR( "Can't find Service instance with '" + key + "' name." );
            }
            return _m.get( key );
        }
        
        public function add( d : Dictionary ) : void
        {
            for ( var key : * in d ) 
            {
                try
                {
                    registerService( key, d[ key ] as AbstractServiceProxy );

                } catch( e : Error )
                {
                    e.message = this + ".add() fails. " + e.message;
                    PixlibDebug.ERROR(e.message );
                    throw( e );
                }
            }
        }

        // Util function
        public function hasGateway() : Boolean
        {
            return gatewayURL !=  null ;
        }

        /**
         * Returns an <code>Array</code> view of the keys contained in this locator.
         *
         * @return an array view of the keys contained in this locator
         */
        public function getKeys() : Array
        {
            return _m.getKeys();
        }

        /**
         * Returns an <code>Array</code> view of the values contained in this locator.
         *
         * @return an array view of the values contained in this locator
         */
        public function getValues() : Array
        {
            return _m.getValues();
        }
    }
}
internal class PrivateConstructorAccess {}

Summary

Constructor

ServiceProxyLocator

Instance properties

gatewayURL : URLRequest

Instance methods

setCredentials (sUserID:String, sPassword:String) : void
registerService (sServiceName:String, service:AbstractServiceProxy) : void
isRegistered (key:String) : Boolean
- Returns {VISDOC_CODE_BLOCK_3} is there is a ressource associated
locate (key:String) : Object
- Returns the ressource associated with the passed-in {VISDOC_CODE_BLOCK_9}.
add (d:Dictionary) : void
- Adds all ressources contained in the passed-in dictionnary
hasGateway : Boolean
getKeys : Array
- Returns an Array view of the keys contained in this locator.
getValues : Array
- Returns an Array view of the values contained in this locator.

Constructor

ServiceProxyLocator

public function ServiceProxyLocator (

)

Instance properties

gatewayURL

public gatewayURL:URLRequest

(read,write)

Instance methods

add

public function add (

d:Dictionary) : void

Adds all ressources contained in the passed-in dictionnary
into this locator instance. If there is keys used both in
the locator and in the dictionnary an exception is thrown.

Parameters:

dictionnary instance which contains ressources
to be added

Throws:

{VISDOC_LINK_0}{VISDOC_CODE_BLOCK_12} — One or more
keys present in the dictionnary already exist in this
locator instance.
#

Specified by:

Locator.add

getKeys

public function getKeys (

) : Array

Returns an Array view of the keys contained in this locator.

Returns:

an array view of the keys contained in this locator

Specified by:

Locator.getKeys

getValues

public function getValues (

) : Array

Returns an Array view of the values contained in this locator.

Returns:

an array view of the values contained in this locator

Specified by:

Locator.getValues

hasGateway

public function hasGateway (

) : Boolean

isRegistered

public function isRegistered (

key:String) : Boolean

Returns {VISDOC_CODE_BLOCK_3} is there is a ressource associated
with the passed-in {VISDOC_CODE_BLOCK_4}. To avoid errors when
retreiving ressources from a locator you should systematically
use the {VISDOC_CODE_BLOCK_5} function to check if the
ressource you would access is already accessible before any
call to the {VISDOC_CODE_BLOCK_6} function.

Returns:

{VISDOC_CODE_BLOCK_7} is there is a ressource associated
with the passed-in {VISDOC_CODE_BLOCK_8}.
#

Specified by:

Locator.isRegistered

locate

public function locate (

key:String) : Object

Returns the ressource associated with the passed-in {VISDOC_CODE_BLOCK_9}.
If there is no ressource identified by the passed-in key, the
function will fail with an error. To avoid the throw of an exception
when attempting to access to a ressource, take care to check the
existence of the ressource before trying to access to it.

Parameters:

key:

identifier of the ressource to access

Returns:

the ressource associated with the passed-in {VISDOC_CODE_BLOCK_10}
#

Throws:

{VISDOC_LINK_0}{VISDOC_CODE_BLOCK_11} — There is no ressource
associated with the passed-in key
#

Specified by:

Locator.locate

registerService

public function registerService (

sServiceName:String, service:AbstractServiceProxy) : void

setCredentials

public function setCredentials (

sUserID:String, sPassword:String) : void