| Pacote | lc.foundation |
| Classe | public class SessionManager |
| Herança | SessionManager  Manager |
| Implementações | ISessionManager |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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 .
Elementos da API relacionados
| Propriedade | Definido por | ||
|---|---|---|---|
| authenticatedUser : User
The authenticated user, after the successful
call using the login or singleSignOn methods. | SessionManager | ||
| buildDate : String [somente leitura]
The build date. | SessionManager | ||
| buildNumber : String [somente leitura]
The build number. | SessionManager | ||
| channelSet : ChannelSet [somente leitura]
A ChannelSet object that is used with Remoting by DataService objects. | SessionManager | ||
| clientUrl : String [somente leitura]
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 [somente leitura]
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 [somente leitura]
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 [somente leitura]
The URL for single-sign on and authentication. | SessionManager | ||
| Método | Definido por | ||
|---|---|---|---|
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 | ||
| Evento | Resumo | Definido por | ||
|---|---|---|---|---|
| Dispatched when the authenticated session with the Document Server expires. | SessionManager | |||
| Constante | Definido por | ||
|---|---|---|---|
| MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [estático]
A special value that specifies an information message. | SessionManager | ||
| SESSION_KEY : String = "lc.foundation.ISessionManager" [estático]
A special value that specifies the manager key name in the SessionMap object. | SessionManager | ||
| Constante | Definido por | ||
|---|---|---|---|
| MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [estático]
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" [estático]
A special value that specifies login information is required. | SessionManager | ||
| MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [estático]
A special value that specifies a non-specific error occurred. | SessionManager | ||
| MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [estático]
A special value that specifies a server-side error identifier for bad credentials. | SessionManager | ||
authenticatedUser | propriedade |
authenticatedUser:User| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The authenticated user, after the successful
call using the login or singleSignOn methods.
Implementação
public function get authenticatedUser():User public function set authenticatedUser(value:User):voidbuildDate | propriedade |
buildNumber | propriedade |
buildNumber:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The build number.
Implementação
public function get buildNumber():StringchannelSet | propriedade |
channelSet:ChannelSet [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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.
Implementação
public function get channelSet():ChannelSetclientUrl | propriedade |
clientUrl:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the client collateral.
Implementação
public function get clientUrl():StringdataserviceChannelSet | propriedade |
dataserviceChannelSet:ChannelSet| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is appropriate for use with Data Services.
Implementação
public function get dataserviceChannelSet():ChannelSet public function set dataserviceChannelSet(value:ChannelSet):voidloadLocationUrl | propriedade |
loadLocationUrl:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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.
Implementação
public function get loadLocationUrl():StringremotingChannelSet | propriedade |
remotingChannelSet:ChannelSet| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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.
Implementação
public function get remotingChannelSet():ChannelSet public function set remotingChannelSet(value:ChannelSet):voidserverUrl | propriedade |
serverUrl:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the server session.
Implementação
public function get serverUrl():StringuserAssertion | propriedade |
userAssertion:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The SAML assertion data that can be used to pass authentication to Data Services.
Implementação
public function get userAssertion():String public function set userAssertion(value:String):voiduserManagerUrl | propriedade |
userManagerUrl:String [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The URL for single-sign on and authentication.
Implementação
public function get userManagerUrl():StringSessionManager | () | Construtor |
public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Parâmetrosserver: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/.
|
getRemotingEndpoint | () | método |
public function getRemotingEndpoint(endpointName:String):RemoteObject| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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.
Parâmetros
endpointName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
getRemotingService | () | método |
public function getRemotingService(serviceName:String):RemoteObject| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| Versões de 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.
Parâmetros
serviceName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
login | () | método |
public function login(username:String, password:String):lc.foundation.util:Token| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs in to the server, authenticating the user.
Parâmetros
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 | () | método |
public function logout():lc.foundation.util:Token| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs off the server, which invalidates the server session.
Retornalc.foundation.util:Token — A token used to set result and fault handlers that execute when the
operation completes.
|
singleSignOn | () | método |
public function singleSignOn():lc.foundation.util:Token| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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.
Retornalc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
authenticationExpired | Evento |
lc.foundation.events.LiveCycleFaultEvent| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the authenticated session with the Document Server expires.
MSG_AUTHENTICATION_EXPIRED | Constante |
public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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 | Constante |
protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de 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 | Constante |
protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | 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"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | 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"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | 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"| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versões de runtime: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies the manager key name in the SessionMap object.
Wed Jun 13 2018, 11:10 AM Z