API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class IGNGeoRMSecurity

Package | org.openscales.core.security.ign
Class | public class IGNGeoRMSecurity
Inheritance | IGNGeoRMSecurity AbstractSecurity

IGN GeoRM security implementation. This module will retreive an GeoRM token in order to be able to request protected datas Documentation is available at https://api.ign.fr/geoportail/api/doc/index.html

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | host : String | IGNGeoRMSecurity
|  | initialized : Boolean | AbstractSecurity
|  | key : String | IGNGeoRMSecurity
|  | map : Map | AbstractSecurity
|  | proxy : String Proxy used for security authentication There is 3 cases : - proxy is explicitly defined - proxy is explicitly defined to "" => no proxy will be used - proxy is null => use the proxy of the map | AbstractSecurity
|  | securityParameter : String [read-only] | IGNGeoRMSecurity
|  | securityParameterName : String | IGNGeoRMSecurity
|  | token : String | IGNGeoRMSecurity
|  | ttl : int | IGNGeoRMSecurity

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | _initialized : Boolean = false | AbstractSecurity

Public Methods

| Method | Defined by
--- | --- | ---
|  | IGNGeoRMSecurity(map:Map, key:String, proxy:String = null, host:String = null) | IGNGeoRMSecurity
|  | initialize():void Authenticate and retreive config to print it in logs | IGNGeoRMSecurity
|  | logout():void | IGNGeoRMSecurity
|  | update():void | IGNGeoRMSecurity
|  | userActivityHandler(e:LayerEvent):void | IGNGeoRMSecurity

Property detail

host | property

`host:String` [read-write]Implementation
`public function get host():String`
`public function set host(value:String):void`

key | property |

`key:String` [read-write]Implementation
`public function get key():String`
`public function set key(value:String):void`

securityParameter | property |

`securityParameter:String` [read-only]Implementation
`public function get securityParameter():String`

securityParameterName | property |

`securityParameterName:String` [read-write]Implementation
`public function get securityParameterName():String`
`public function set securityParameterName(value:String):void`

token | property |

`token:String` [read-write]Implementation
`public function get token():String`
`public function set token(value:String):void`

ttl | property |

`ttl:int` [read-write]Implementation
`public function get ttl():int`
`public function set ttl(value:int):void`
Constructor detail

IGNGeoRMSecurity | () | constructor

`public function IGNGeoRMSecurity(map:Map, key:String, proxy:String = null, host:String = null)`Parameters

| `map:Map`
| `key:String`
| `proxy:String` (default = `null`)``
| `host:String` (default = `null`)``

Method detail

initialize | () | method

`public override function initialize():void`

Authenticate and retreive config to print it in logs

logout | () | method |

`public override function logout():void`

update | () | method |

`public override function update():void`

userActivityHandler | () | method |

`public function userActivityHandler(e:LayerEvent):void` Parameters

| `e:LayerEvent`