SessionManager

Paket	lc.foundation
Klasse	public class SessionManager
Vererbung	SessionManager Manager
Implementiert	ISessionManager

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The 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 .

Verwandte API-Elemente

lc.procmgmt.AuthenticatingApplication

Öffentliche Eigenschaften

	Eigenschaft		Definiert von
		authenticatedUser : User The authenticated user, after the successful call using the login or singleSignOn methods.	SessionManager
		buildDate : String [schreibgeschützt] The build date.	SessionManager
		buildNumber : String [schreibgeschützt] The build number.	SessionManager
		channelSet : ChannelSet [schreibgeschützt] A ChannelSet object that is used with Remoting by DataService objects.	SessionManager
		clientUrl : String [schreibgeschützt] 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 [schreibgeschützt] 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 [schreibgeschützt] 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 [schreibgeschützt] The URL for single-sign on and authentication.	SessionManager

Öffentliche Methoden

	Methode		Definiert von
		SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null) Constructor.	SessionManager
		getRemotingEndpoint(endpointName:String):RemoteObject Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.	SessionManager
		getRemotingService(serviceName:String):RemoteObject Retrieves a RemoteObject object configured with the authenticated user's credentials for invoking an operation on the specified Remoting service.	SessionManager
		login(username:String, password:String):lc.foundation.util:Token Logs in to the server, authenticating the user.	SessionManager
		logout():lc.foundation.util:Token Logs off the server, which invalidates the server session.	SessionManager
		singleSignOn():lc.foundation.util:Token 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

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

	Ereignis		Übersicht	Definiert von
		authenticationExpired	Dispatched when the authenticated session with the Document Server expires.	SessionManager

Öffentliche Konstanten

	Konstante		Definiert von
		MSG_AUTHENTICATION_EXPIRED : String = "ALC-WKS-007-108" [statisch] A special value that specifies an information message.	SessionManager
		SESSION_KEY : String = "lc.foundation.ISessionManager" [statisch] A special value that specifies the manager key name in the SessionMap object.	SessionManager

Geschützte Konstanten

	Konstante		Definiert von
		MSG_BAD_CREDENTIALS : String = "ALC-WKS-007-001" [statisch] 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" [statisch] A special value that specifies login information is required.	SessionManager
		MSG_NON_SPECIFIC_ERROR : String = "ALC-WKS-007-000" [statisch] A special value that specifies a non-specific error occurred.	SessionManager
		MSG_SERVER_BAD_CREDENTIALS : String = "ALC-WKS-005-000" [statisch] A special value that specifies a server-side error identifier for bad credentials.	SessionManager

Eigenschaftendetails

authenticatedUser

Eigenschaft

authenticatedUser:User

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The authenticated user, after the successful call using the login or singleSignOn methods.

Implementierung
public function get authenticatedUser():User
public function set authenticatedUser(value:User):void

buildDate

Eigenschaft

buildDate:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The build date.

Implementierung
public function get buildDate():String

buildNumber

Eigenschaft

buildNumber:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The build number.

Implementierung
public function get buildNumber():String

channelSet

Eigenschaft

channelSet:ChannelSet [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is used with Remoting by DataService objects. This for internal use only.

Implementierung
public function get channelSet():ChannelSet

clientUrl

Eigenschaft

clientUrl:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the client collateral.

Implementierung
public function get clientUrl():String

dataserviceChannelSet

Eigenschaft

dataserviceChannelSet:ChannelSet

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A ChannelSet object that is appropriate for use with Data Services.

Implementierung
public function get dataserviceChannelSet():ChannelSet
public function set dataserviceChannelSet(value:ChannelSet):void

loadLocationUrl

Eigenschaft

loadLocationUrl:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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.

Implementierung
public function get loadLocationUrl():String

remotingChannelSet

Eigenschaft

remotingChannelSet:ChannelSet

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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.

Implementierung
public function get remotingChannelSet():ChannelSet
public function set remotingChannelSet(value:ChannelSet):void

serverUrl

Eigenschaft

serverUrl:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The server address, as a URL, for the server session.

Implementierung
public function get serverUrl():String

userAssertion

Eigenschaft

userAssertion:String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The SAML assertion data that can be used to pass authentication to Data Services.

Implementierung
public function get userAssertion():String
public function set userAssertion(value:String):void

userManagerUrl

Eigenschaft

userManagerUrl:String [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

The URL for single-sign on and authentication.

Implementierung
public function get userManagerUrl():String

Konstruktordetails

()

Konstruktor

public function SessionManager(server:String, session:SessionMap, clientUrl:String = null, userManagerUrl:String = null)

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Parameter

	`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`) — Specifies URL to access the Document Server. A value of `null` specifies to use `/workspace-server/`.

	`userManagerUrl:String` (default = `null`) — Specifies the URL for single-sign on and authentication. A value of `null` specifies to use `/um/`.

Methodendetails

getRemotingEndpoint

()

Methode

public function getRemotingEndpoint(endpointName:String):RemoteObject

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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.

Parameter

endpointName:String — Specifies the name of the Remoting startpoint.

Rückgabewerte

RemoteObject — A ready to use RemoteObject.

getRemotingService

()

Methode

public function getRemotingService(serviceName:String):RemoteObject

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 10

Laufzeitversionen:

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.

Parameter

serviceName:String — Specifies the name of the Remoting startpoint.

Rückgabewerte

RemoteObject — A ready to use RemoteObject.

login

()

Methode

public function login(username:String, password:String):lc.foundation.util:Token

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Logs in to the server, authenticating the user.

Parameter

	`username:String` — Specifies the user profile.

	`password:String` — Specifies the password.

Rückgabewerte

lc.foundation.util:Token — A Token object used to set result and fault handlers that execute when the operation completes.

logout

()

Methode

public function logout():lc.foundation.util:Token

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Logs off the server, which invalidates the server session.

Rückgabewerte

lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.

singleSignOn

()

Methode

public function singleSignOn():lc.foundation.util:Token

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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.

Rückgabewerte

lc.foundation.util:Token — A token used to set result and fault handlers that execute when the operation completes.

Ereignisdetails

authenticationExpired

Ereignis

Ereignisobjekttyp: lc.foundation.events.LiveCycleFaultEvent

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

Dispatched when the authenticated session with the Document Server expires.

Konstantendetails

MSG_AUTHENTICATION_EXPIRED

Konstante

public static const MSG_AUTHENTICATION_EXPIRED:String = "ALC-WKS-007-108"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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

Konstante

protected static const MSG_BAD_CREDENTIALS:String = "ALC-WKS-007-001"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

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

Konstante

protected static const MSG_CREDENTIALS_REQUIRED:String = "ALC-WKS-007-149"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies login information is required.

MSG_NON_SPECIFIC_ERROR

Konstante

protected static const MSG_NON_SPECIFIC_ERROR:String = "ALC-WKS-007-000"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a non-specific error occurred.

MSG_SERVER_BAD_CREDENTIALS

Konstante

protected static const MSG_SERVER_BAD_CREDENTIALS:String = "ALC-WKS-005-000"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a server-side error identifier for bad credentials.

SESSION_KEY

Konstante

public static const SESSION_KEY:String = "lc.foundation.ISessionManager"

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Workspace 9

Laufzeitversionen:

AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the manager key name in the SessionMap object.

Rechtliche Hinweise | Onlinedatenschutzerklärung

SessionManager - AS3 ADEP Workspace

Klassen x

authenticatedUser

buildDate

buildNumber

channelSet

clientUrl

dataserviceChannelSet

loadLocationUrl

remotingChannelSet

serverUrl

userAssertion

userManagerUrl

SessionManager

getRemotingEndpoint

getRemotingService

login

logout

singleSignOn

authenticationExpired

MSG_AUTHENTICATION_EXPIRED

MSG_BAD_CREDENTIALS

MSG_CREDENTIALS_REQUIRED

MSG_NON_SPECIFIC_ERROR

MSG_SERVER_BAD_CREDENTIALS

SESSION_KEY