Packagecom.vmware.usersession
Classpublic class UserSession
InheritanceUserSession Inheritance Object
Implements flash.events.IEventDispatcher

User session details for the logged in user.

The current UserSession can be retrieved through the UserSessionService

Note: this class was generated from its Java counterpart UserSession



Public Properties
 PropertyDefined By
  clientId : String
Id used to uniquely identify a client session.
UserSession
  locale : String
Locale for the session.
UserSession
  samlTokenXml : String
The XML value of the SAML Token representing the current user.
UserSession
  serversInfo : Array
List of all the servers in the current session.
UserSession
  userName : String
Name of the user who owns the session.
UserSession
Public Methods
 MethodDefined By
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
UserSession
  
dispatchEvent(event:Event):Boolean
UserSession
  
hasEventListener(type:String):Boolean
UserSession
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
UserSession
  
willTrigger(type:String):Boolean
UserSession
Property Detail
clientIdproperty
clientId:String

Id used to uniquely identify a client session.

You can use it for instance to keep track of session specific resources and clean them up when you are notified of the session ending in your ClientSessionEndListener. Note that the HttpSession id cannot be used in place of clientId because the same client session can involve multiple Http sessions.

clientId is only set by the framework when UserSession is accessed in one of two ways:

  1. Within a Java service method for which your corresponding Flex proxy class extends BaseProxy, as shown in the SDK samples.
  2. Or within a DataProviderAdapter or PropertyProviderAdapter (in which case the proxy is the one from Data Access Manager).

This property can be used as the source for data binding.


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

See also

com.vmware.vise.security.ClientSessionEndListener
localeproperty 
locale:String

Locale for the session.

This property can be used as the source for data binding.


Implementation
    public function get locale():String
    public function set locale(value:String):void
samlTokenXmlproperty 
samlTokenXml:String

The XML value of the SAML Token representing the current user. A plug-in can use that information to check the user's authentication if necessary. See the vSphere Single Sign-On documentation.

samlTokenXml can be null if for some reason the UserSession didn't use a proper SSO authentication, but this should not happen in production mode.

This property can be used as the source for data binding.


Implementation
    public function get samlTokenXml():String
    public function set samlTokenXml(value:String):void
serversInfoproperty 
serversInfo:Array

List of all the servers in the current session.

This property can be used as the source for data binding.


Implementation
    public function get serversInfo():Array
    public function set serversInfo(value:Array):void

See also

userNameproperty 
userName:String

Name of the user who owns the session.

This property can be used as the source for data binding.


Implementation
    public function get userName():String
    public function set userName(value:String):void
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean