SessionManager

Package	lc.foundation
Classe	public class SessionManager
Héritage	SessionManager Manager
Implémente	ISessionManager

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The SessionManager class is the standard implementation of the ISessionManager interface. Typically, the AuthenticatingApplication object is used, which automatically creates a SessionManager object.

If the AuthenticatingApplication class is not used, an instantiation of this class can be used to access Document Server.

For information on using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace User Interface .

Eléments de l’API associés

lc.procmgmt.AuthenticatingApplication

Propriétés publiques

	Propriété		Défini par
		authenticatedUser : User The authenticated user, after the successful call using the login or singleSignOn methods.	SessionManager
		buildDate : String [lecture seule] The build date.	SessionManager
		buildNumber : String [lecture seule] The build number.	SessionManager
		channelSet : ChannelSet [lecture seule] A ChannelSet object that is used with Remoting by DataService objects.	SessionManager
		clientUrl : String [lecture seule] The server address, as a URL, for the client collateral.	SessionManager
		dataserviceChannelSet : ChannelSet A ChannelSet object that is appropriate for use with Data Services.	SessionManager
		loadLocationUrl : String [lecture seule] The server URL from which the SWF file is loaded.	SessionManager
		remotingChannelSet : ChannelSet A ChannelSet object that is appropriate for use with Remoting.	SessionManager
		serverUrl : String [lecture seule] The server address, as a URL, for the server session.	SessionManager
		userAssertion : String The SAML assertion data that can be used to pass authentication to Data Services.	SessionManager
		userManagerUrl : String [lecture seule] The URL for single-sign on and authentication.	SessionManager

Méthodes publiques

	Méthode		Défini par
		SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null) Constructor.	SessionManager
		getRemotingEndpoint(endpointName:String):RemoteObject Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.	SessionManager
		getRemotingService(serviceName:String):RemoteObject Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.	SessionManager
		login(username:String, password:String):lc.foundation.util:Token Logs in to the server, authenticating the user.	SessionManager
		logout():lc.foundation.util:Token Logs off the server, which invalidates the server session.	SessionManager
		singleSignOn():lc.foundation.util:Token Determines whether an authenticated session to the Document Server already exists or can be established without additional information, such as in single sign-on (SSO).	SessionManager

Evénements

Cliquez pour plus d’informations sur les événements

	Evénement		Synthèse	Défini par
		authenticationExpired	Dispatched when the authenticated session with the Document Server expires.	SessionManager

Constantes publiques

	Constante		Défini par
		MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [statique] A special value that specifies an information message.	SessionManager
		SESSION_KEY : String = "lc.foundation.ISessionManager" [statique] A special value that specifies the manager key name in the SessionMap object.	SessionManager

Constantes protégées

	Constante		Défini par
		MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [statique] A special value that specifies the user name, password, or both that was provided are invalid.	SessionManager
		MSG_CREDENTIALS_REQUIRED : String = "ALC-WKS-007-149" [statique] A special value that specifies login information is required.	SessionManager
		MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [statique] A special value that specifies a non-specific error occurred.	SessionManager
		MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [statique] A special value that specifies a server-side error identifier for bad credentials.	SessionManager

Détails de la propriété

authenticatedUser

propriété

authenticatedUser:User

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The authenticated user, after the successful call using the login or singleSignOn methods.

Implémentation
public function get authenticatedUser():User
public function set authenticatedUser(value:User):void

buildDate

propriété

buildDate:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The build date.

Implémentation
public function get buildDate():String

buildNumber

propriété

buildNumber:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The build number.

Implémentation
public function get buildNumber():String

channelSet

propriété

channelSet:ChannelSet [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is used with Remoting by DataService objects. This for internal use only.

Implémentation
public function get channelSet():ChannelSet

clientUrl

propriété

clientUrl:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the client collateral.

Implémentation
public function get clientUrl():String

dataserviceChannelSet

propriété

dataserviceChannelSet:ChannelSet

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with Data Services.

Implémentation
public function get dataserviceChannelSet():ChannelSet
public function set dataserviceChannelSet(value:ChannelSet):void

loadLocationUrl

propriété

loadLocationUrl:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The server URL from which the SWF file is loaded. The URL does not include the name of the SWF file.

Implémentation
public function get loadLocationUrl():String

remotingChannelSet

propriété

remotingChannelSet:ChannelSet

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with Remoting. Generally, using the getRemotingService method is more convenient.

Implémentation
public function get remotingChannelSet():ChannelSet
public function set remotingChannelSet(value:ChannelSet):void

serverUrl

propriété

serverUrl:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the server session.

Implémentation
public function get serverUrl():String

userAssertion

propriété

userAssertion:String

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The SAML assertion data that can be used to pass authentication to Data Services.

Implémentation
public function get userAssertion():String
public function set userAssertion(value:String):void

userManagerUrl

propriété

userManagerUrl:String [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

The URL for single-sign on and authentication.

Implémentation
public function get userManagerUrl():String

Détails du constructeur

()

Constructeur

public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Paramètres

	`server:String` — Specifies the location of the server as a URL. If the URL is a value of `null`, the Manager default to accessing the Document Server at the same location from where the Workspace SWF file is retrieved.

	`session:SessionMap` — Specifies the `SessionMap` object to use.

	`clientUrl:String` (default = `null`) — Specifies URL to access the Document Server. A value of `null` specifies to use `/workspace-server/`.

	`userManagerUrl:String` (default = `null`) — Specifies the URL for single-sign on and authentication. A value of `null` specifies to use `/um/`.

Détails de la méthode

getRemotingEndpoint

()

méthode

public function getRemotingEndpoint(endpointName:String):RemoteObject

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service. Successful authentication is a prerequisite.

Paramètres

endpointName:String — Specifies the name of the Remoting startpoint.

Valeur renvoyée

RemoteObject — A ready to use RemoteObject.

getRemotingService

()

méthode

public function getRemotingService(serviceName:String):RemoteObject

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service. Successful authentication is a prerequisite.

Paramètres

serviceName:String — Specifies the name of the Remoting startpoint.

Valeur renvoyée

RemoteObject — A ready to use RemoteObject.

login

()

méthode

public function login(username:String, password:String):lc.foundation.util:Token

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Logs in to the server, authenticating the user.

Paramètres

	`username:String` — Specifies the user profile.

	`password:String` — Specifies the password.

Valeur renvoyée

lc.foundation.util:Token — A Token object used to set result and fault handlers that execute when the operation completes.

logout

()

méthode

public function logout():lc.foundation.util:Token

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Logs off the server, which invalidates the server session.

Valeur renvoyée

lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.

singleSignOn

()

méthode

public function singleSignOn():lc.foundation.util:Token

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Determines whether an authenticated session to the Document Server already exists or can be established without additional information, such as in single sign-on (SSO). If an authenticated session is established, the server session is valid and the result handler on the returned token is called. If an authenticated session is not established, the fault handler is called.

Valeur renvoyée

lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.

Détails de l’événement

authenticationExpired

Evénement

Type d’objet d’événement: lc.foundation.events.LiveCycleFaultEvent

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when the authenticated session with the Document Server expires.

Détails de la constante

MSG_AUTHENTICATION_EXPIRED

Constante

public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies an information message. The session for the user has expired. The user must log in again to Workspace.

MSG_BAD_CREDENTIALS

Constante

protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the user name, password, or both that was provided are invalid.

MSG_CREDENTIALS_REQUIRED

Constante

protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies login information is required.

MSG_NON_SPECIFIC_ERROR

Constante

protected static const MSG_NON_SPECIFIC_ERROR:String = "ALC-WKS-007-000"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a non-specific error occurred.

MSG_SERVER_BAD_CREDENTIALS

Constante

protected static const MSG_SERVER_BAD_CREDENTIALS:String = "ALC-WKS-005-000"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a server-side error identifier for bad credentials.

SESSION_KEY

Constante

public static const SESSION_KEY:String = "lc.foundation.ISessionManager"

Version du langage:

ActionScript 3.0

Version du produit:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Versions du moteur d’exécution:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the manager key name in the SessionMap object.

Informations juridiques | Politique de confidentialité en ligne

SessionManager - AS3 ADEP Workspace

Classes x

authenticatedUser

buildDate

buildNumber

channelSet

clientUrl

dataserviceChannelSet

loadLocationUrl

remotingChannelSet

serverUrl

userAssertion

userManagerUrl

SessionManager

getRemotingEndpoint

getRemotingService

login

logout

singleSignOn

authenticationExpired

MSG_AUTHENTICATION_EXPIRED

MSG_BAD_CREDENTIALS

MSG_CREDENTIALS_REQUIRED

MSG_NON_SPECIFIC_ERROR

MSG_SERVER_BAD_CREDENTIALS

SESSION_KEY