| Pacchetto | lc.foundation |
| Classe | public class SessionManager |
| Ereditarietà | SessionManager  Manager |
| Implementa | ISessionManager |
| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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 .
Elementi API correlati
Proprietà pubbliche
| Proprietà | Definito da | ||
|---|---|---|---|
| authenticatedUser : User
The authenticated user, after the successful
call using the login or singleSignOn methods. | SessionManager | ||
| buildDate : String [sola lettura]
The build date. | SessionManager | ||
| buildNumber : String [sola lettura]
The build number. | SessionManager | ||
| channelSet : ChannelSet [sola lettura]
A ChannelSet object that is used with Remoting by DataService objects. | SessionManager | ||
| clientUrl : String [sola lettura]
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 [sola lettura]
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 [sola lettura]
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 [sola lettura]
The URL for single-sign on and authentication. | SessionManager | ||
Metodi pubblici
| Metodo | Definito da | ||
|---|---|---|---|
SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)
Constructor. | SessionManager | ||
Retrieves a RemoteObject object configured with the authenticated user's
credentials for invoking an operation on the specified Remoting service. | SessionManager | ||
Retrieves a RemoteObject object configured with the authenticated user's
credentials for invoking an operation on the specified Remoting service. | SessionManager | ||
Logs in to the server, authenticating the user. | SessionManager | ||
Logs off the server, which invalidates the server session. | SessionManager | ||
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 | ||
Eventi
| Evento | Riepilogo | Definito da | ||
|---|---|---|---|---|
| Dispatched when the authenticated session with the Document Server expires. | SessionManager | |||
Costanti pubbliche
| Costante | Definito da | ||
|---|---|---|---|
| MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [statico]
A special value that specifies an information message. | SessionManager | ||
| SESSION_KEY : String = "lc.foundation.ISessionManager" [statico]
A special value that specifies the manager key name in the SessionMap object. | SessionManager | ||
Costanti protette
| Costante | Definito da | ||
|---|---|---|---|
| MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [statico]
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" [statico]
A special value that specifies login information is required. | SessionManager | ||
| MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [statico]
A special value that specifies a non-specific error occurred. | SessionManager | ||
| MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [statico]
A special value that specifies a server-side error identifier for bad credentials. | SessionManager | ||
Descrizione delle proprietà
authenticatedUser | proprietà |
authenticatedUser:User| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The authenticated user, after the successful
call using the login or singleSignOn methods.
Implementazione
public function get authenticatedUser():User public function set authenticatedUser(value:User):voidbuildDate | proprietà |
buildNumber | proprietà |
buildNumber:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The build number.
Implementazione
public function get buildNumber():StringchannelSet | proprietà |
channelSet:ChannelSet [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is used with Remoting by DataService objects.
This for internal use only.
Implementazione
public function get channelSet():ChannelSetclientUrl | proprietà |
clientUrl:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the client collateral.
Implementazione
public function get clientUrl():StringdataserviceChannelSet | proprietà |
dataserviceChannelSet:ChannelSet| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is appropriate for use with Data Services.
Implementazione
public function get dataserviceChannelSet():ChannelSet public function set dataserviceChannelSet(value:ChannelSet):voidloadLocationUrl | proprietà |
loadLocationUrl:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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.
Implementazione
public function get loadLocationUrl():StringremotingChannelSet | proprietà |
remotingChannelSet:ChannelSet| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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.
Implementazione
public function get remotingChannelSet():ChannelSet public function set remotingChannelSet(value:ChannelSet):voidserverUrl | proprietà |
serverUrl:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the server session.
Implementazione
public function get serverUrl():StringuserAssertion | proprietà |
userAssertion:String| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The SAML assertion data that can be used to pass authentication to Data Services.
Implementazione
public function get userAssertion():String public function set userAssertion(value:String):voiduserManagerUrl | proprietà |
userManagerUrl:String [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The URL for single-sign on and authentication.
Implementazione
public function get userManagerUrl():StringDescrizione della funzione di costruzione
SessionManager | () | Funzione di costruzione |
public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Parametriserver: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)null specifies to use /workspace-server/.
| |
userManagerUrl:String (default = null)null specifies to use /um/.
|
Descrizione dei metodi
getRemotingEndpoint | () | metodo |
public function getRemotingEndpoint(endpointName:String):RemoteObject| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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.
Parametri
endpointName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
getRemotingService | () | metodo |
public function getRemotingService(serviceName:String):RemoteObject| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 10 |
| Versioni runtime: | 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.
Parametri
serviceName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
login | () | metodo |
public function login(username:String, password:String):lc.foundation.util:Token| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs in to the server, authenticating the user.
Parametri
username:String — Specifies the user profile.
| |
password:String — Specifies the password.
|
lc.foundation.util:Token — A Token object used to set result and fault handlers that execute when the
operation completes.
|
logout | () | metodo |
public function logout():lc.foundation.util:Token| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs off the server, which invalidates the server session.
Restituiscelc.foundation.util:Token — A token used to set result and fault handlers that execute when the
operation completes.
|
singleSignOn | () | metodo |
public function singleSignOn():lc.foundation.util:Token| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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.
Restituiscelc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
Descrizione degli eventi
authenticationExpired | Evento |
Tipo di oggetto evento:
lc.foundation.events.LiveCycleFaultEvent| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the authenticated session with the Document Server expires.
Descrizione delle costanti
MSG_AUTHENTICATION_EXPIRED | Costante |
public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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 | Costante |
protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | 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 | Costante |
protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies login information is required.
MSG_NON_SPECIFIC_ERROR | Costante |
protected static const MSG_NON_SPECIFIC_ERROR:String = "ALC-WKS-007-000"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies a non-specific error occurred.
MSG_SERVER_BAD_CREDENTIALS | Costante |
protected static const MSG_SERVER_BAD_CREDENTIALS:String = "ALC-WKS-005-000"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies a server-side error identifier for bad credentials.
SESSION_KEY | Costante |
public static const SESSION_KEY:String = "lc.foundation.ISessionManager"| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Adobe Digital Enterprise Platform Document Services - Area di lavoro 9 |
| Versioni runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies the manager key name in the SessionMap object.
Tue Jun 12 2018, 02:44 PM Z