| Пакет | lc.foundation |
| Класс | public class SessionManager |
| Наследование | SessionManager  Manager |
| Реализует | ISessionManager |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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 .
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
| authenticatedUser : User
The authenticated user, after the successful
call using the login or singleSignOn methods. | SessionManager | ||
| buildDate : String [только для чтения]
The build date. | SessionManager | ||
| buildNumber : String [только для чтения]
The build number. | SessionManager | ||
| channelSet : ChannelSet [только для чтения]
A ChannelSet object that is used with Remoting by DataService objects. | SessionManager | ||
| clientUrl : String [только для чтения]
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 [только для чтения]
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 [только для чтения]
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 [только для чтения]
The URL for single-sign on and authentication. | SessionManager | ||
| Метод | Определено | ||
|---|---|---|---|
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 | ||
| Событие | Сводка | Определено | ||
|---|---|---|---|---|
| Dispatched when the authenticated session with the Document Server expires. | SessionManager | |||
| Константа | Определено | ||
|---|---|---|---|
| MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [статические]
A special value that specifies an information message. | SessionManager | ||
| SESSION_KEY : String = "lc.foundation.ISessionManager" [статические]
A special value that specifies the manager key name in the SessionMap object. | SessionManager | ||
| Константа | Определено | ||
|---|---|---|---|
| MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [статические]
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" [статические]
A special value that specifies login information is required. | SessionManager | ||
| MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [статические]
A special value that specifies a non-specific error occurred. | SessionManager | ||
| MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [статические]
A special value that specifies a server-side error identifier for bad credentials. | SessionManager | ||
authenticatedUser | свойство |
authenticatedUser:User| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The authenticated user, after the successful
call using the login or singleSignOn methods.
Реализация
public function get authenticatedUser():User public function set authenticatedUser(value:User):voidbuildDate | свойство |
buildNumber | свойство |
channelSet | свойство |
channelSet:ChannelSet [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is used with Remoting by DataService objects.
This for internal use only.
Реализация
public function get channelSet():ChannelSetclientUrl | свойство |
clientUrl:String [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the client collateral.
Реализация
public function get clientUrl():StringdataserviceChannelSet | свойство |
dataserviceChannelSet:ChannelSet| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A ChannelSet object that is appropriate for use with Data Services.
Реализация
public function get dataserviceChannelSet():ChannelSet public function set dataserviceChannelSet(value:ChannelSet):voidloadLocationUrl | свойство |
loadLocationUrl:String [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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.
Реализация
public function get loadLocationUrl():StringremotingChannelSet | свойство |
remotingChannelSet:ChannelSet| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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.
Реализация
public function get remotingChannelSet():ChannelSet public function set remotingChannelSet(value:ChannelSet):voidserverUrl | свойство |
serverUrl:String [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The server address, as a URL, for the server session.
Реализация
public function get serverUrl():StringuserAssertion | свойство |
userAssertion:String| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The SAML assertion data that can be used to pass authentication to Data Services.
Реализация
public function get userAssertion():String public function set userAssertion(value:String):voiduserManagerUrl | свойство |
userManagerUrl:String [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The URL for single-sign on and authentication.
Реализация
public function get userManagerUrl():StringSessionManager | () | Конструктор |
public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Параметры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)null specifies to use /workspace-server/.
| |
userManagerUrl:String (default = null)null specifies to use /um/.
|
getRemotingEndpoint | () | метод |
public function getRemotingEndpoint(endpointName:String):RemoteObject| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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.
Параметры
endpointName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
getRemotingService | () | метод |
public function getRemotingService(serviceName:String):RemoteObject| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| Версии среды выполнения: | 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.
Параметры
serviceName:String — Specifies the name of the Remoting startpoint.
|
RemoteObject — A ready to use RemoteObject.
|
login | () | метод |
public function login(username:String, password:String):lc.foundation.util:Token| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs in to the server, authenticating the user.
Параметры
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 | () | метод |
public function logout():lc.foundation.util:Token| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Logs off the server, which invalidates the server session.
Возвращаетlc.foundation.util:Token — A token used to set result and fault handlers that execute when the
operation completes.
|
singleSignOn | () | метод |
public function singleSignOn():lc.foundation.util:Token| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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.
Возвращаетlc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.
|
authenticationExpired | Событие |
lc.foundation.events.LiveCycleFaultEvent| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the authenticated session with the Document Server expires.
MSG_AUTHENTICATION_EXPIRED | Константа |
public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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 | Константа |
protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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 | Константа |
protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies login information is required.
MSG_NON_SPECIFIC_ERROR | Константа |
protected static const MSG_NON_SPECIFIC_ERROR:String = "ALC-WKS-007-000"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies a non-specific error occurred.
MSG_SERVER_BAD_CREDENTIALS | Константа |
protected static const MSG_SERVER_BAD_CREDENTIALS:String = "ALC-WKS-005-000"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies a server-side error identifier for bad credentials.
SESSION_KEY | Константа |
public static const SESSION_KEY:String = "lc.foundation.ISessionManager"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Версии среды выполнения: | 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, 11:34 AM Z