| パッケージ | 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 | プロパティ |
dataserviceChannelSet | プロパティ |
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 | プロパティ |
userAssertion | プロパティ |
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 | プロパティ |
SessionManager | () | コンストラクター |
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, 10:34 AM Z