| Paquete | lc.foundation |
| Clase | public class SessionManager |
| Herencia | SessionManager  Manager |
| Implementa | ISessionManager |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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 de API relacionados
Propiedades públicas
| Propiedad | Definido por | ||
|---|---|---|---|
| authenticatedUser : User
The authenticated user, after the successful
call using the login or singleSignOn methods. | SessionManager | ||
| buildDate : String [solo lectura]
The build date. | SessionManager | ||
| buildNumber : String [solo lectura]
The build number. | SessionManager | ||
| channelSet : ChannelSet [solo lectura]
A ChannelSet object that is used with Remoting by DataService objects. | SessionManager | ||
| clientUrl : String [solo lectura]
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 [solo lectura]
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 [solo lectura]
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 [solo lectura]
The URL for single-sign on and authentication. | SessionManager | ||
Métodos públicos
| 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 | ||
Eventos
| Evento | Resumen | Definido por | ||
|---|---|---|---|---|
| Dispatched when the authenticated session with the Document Server expires. | SessionManager | |||
Constantes públicas
| Constante | Definido por | ||
|---|---|---|---|
| MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [estática]
A special value that specifies an information message. | SessionManager | ||
| SESSION_KEY : String = "lc.foundation.ISessionManager" [estática]
A special value that specifies the manager key name in the SessionMap object. | SessionManager | ||
Constantes protegidas
| Constante | Definido por | ||
|---|---|---|---|
| MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [estática]
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ática]
A special value that specifies login information is required. | SessionManager | ||
| MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [estática]
A special value that specifies a non-specific error occurred. | SessionManager | ||
| MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [estática]
A special value that specifies a server-side error identifier for bad credentials. | SessionManager | ||
Información sobre propiedades
authenticatedUser | propiedad |
authenticatedUser:User| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The authenticated user, after the successful
call using the login or singleSignOn methods.
Implementación
public function get authenticatedUser():User public function set authenticatedUser(value:User):voidbuildDate | propiedad |
buildDate:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The build date.
Implementación
public function get buildDate():StringbuildNumber | propiedad |
buildNumber:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The build number.
Implementación
public function get buildNumber():StringchannelSet | propiedad |
channelSet:ChannelSet [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is used with Remoting by DataService objects.
This for internal use only.
Implementación
public function get channelSet():ChannelSetclientUrl | propiedad |
clientUrl:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the client collateral.
Implementación
public function get clientUrl():StringdataserviceChannelSet | propiedad |
dataserviceChannelSet:ChannelSet| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is appropriate for use with Data Services.
Implementación
public function get dataserviceChannelSet():ChannelSet public function set dataserviceChannelSet(value:ChannelSet):voidloadLocationUrl | propiedad |
loadLocationUrl:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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.
Implementación
public function get loadLocationUrl():StringremotingChannelSet | propiedad |
remotingChannelSet:ChannelSet| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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.
Implementación
public function get remotingChannelSet():ChannelSet public function set remotingChannelSet(value:ChannelSet):voidserverUrl | propiedad |
serverUrl:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the server session.
Implementación
public function get serverUrl():StringuserAssertion | propiedad |
userAssertion:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The SAML assertion data that can be used to pass authentication to Data Services.
Implementación
public function get userAssertion():String public function set userAssertion(value:String):voiduserManagerUrl | propiedad |
userManagerUrl:String [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The URL for single-sign on and authentication.
Implementación
public function get userManagerUrl():StringInformación sobre constructores
SessionManager | () | Información sobre |
public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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/.
|
Información sobre métodos
getRemotingEndpoint | () | método |
public function getRemotingEndpoint(endpointName:String):RemoteObject| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs off the server, which invalidates the server session.
Valor devueltolc.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| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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.
Valor devueltolc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
Información sobre eventos
authenticationExpired | Evento |
Tipo de objeto de evento:
lc.foundation.events.LiveCycleFaultEvent| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the authenticated session with the Document Server expires.
Información sobre constantes
MSG_AUTHENTICATION_EXPIRED | Constante |
public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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"| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Versiones de motor de ejecución: | 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:12 PM Z