| Package | com.adobe.livecycle.ria.security.api |
| Class | public class SecurityConfig |
| Inheritance | SecurityConfig  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
SecurityConfig classcaptures the required configuration required for the security client library to function.
Various properties are provided in the class to capture portions of the URL information.
The baseUrl property contains the information of the host or server, port, and context root where the
Experience Server is deployed and the loginUrl property contains the relative path of login page.
For example, the baseUrl value to access the Experience Server can be http://myserver:4502/mycompany and
the login page can reside in /system/login. The two values appended together provide you the complete
URL of http://myserver:4502/mycompany/system/login.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| baseUrl : String
The base URL which would be appended to all other URLs. | SecurityConfig | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentUserServiceDestination : String
The Data Services Remoting destination name used to fetch details about the user after the user has
authenticated successfully with the server. | SecurityConfig | ||
| loginUrl : String
The URL value used to log in to the Experience Server. | SecurityConfig | ||
| logoutUrl : String
The URL value used to log out of the Experience Server. | SecurityConfig | ||
| maxAge : int
The duration in seconds for which a pin is valid. | SecurityConfig | ||
| maxUse : int
The maximum number of times a pin can be used. | SecurityConfig | ||
| operationName : String
The name of the operation invoked on the Remoting destination used to fetch the user details. | SecurityConfig | ||
| pinServletUrl : String
The URL of pin servlet which creates, updates, or deletes a pin. | SecurityConfig | ||
| securedServletChannelUrl : String
The Data Services AMF channel URL used for secured connections. | SecurityConfig | ||
| servletChannelUrl : String
The Data Services AMF channel URL. | SecurityConfig | ||
| statusCheckUrl : String
The URL value used to determine the current status of user. | SecurityConfig | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SecurityConfig | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
Provides configuration details. | SecurityConfig | ||
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| PIN_ENABLED_PARAM_KEY : String = "enabled" [static]
A special value that specifies the HTTP request parameter key to enable a pin in a pin update request. | SecurityConfig | ||
| PIN_MAXAGE_PARAM_KEY : String = "maxAge" [static]
A special that specifies the HTTP request parameter key name to set the maximum age (in seconds) for a pin in a pin update request. | SecurityConfig | ||
| PIN_MAXUSE_PARAM_KEY : String = "maxUse" [static]
A special value that specifies the HTTP request parameter key name to set the maximum usage of a pin in a pin update request. | SecurityConfig | ||
| PIN_REQUEST_PARAM_KEY : String = ":cqpin" [static]
A special value that specifies the HTTP request parameter key while requesting for a pin. | SecurityConfig | ||
| PIN_RESPONSE_FORMAT : String = ".txt" [static]
A special value that specifies the HTTP response format of a create, update, or delete pin HTTP request. | SecurityConfig | ||
baseUrl | property |
baseUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The base URL which would be appended to all other URLs. In case of a Flex application running within a browser, this value is automatically detected. However, the base URL may require changes to when the context path of the Experience Server application changes.
When the Experience Server is deployed to a context root other than "/",then it is necessary for you to suffix
the baseURL value with /contextRoot. However, when you deploy to a folder under the context root of "/", it is not necessary.
For example:
- When the Experience Server is deployed to "
/", this the property value ishttp://server:port/ - When the Experience Server is deployed to a context root folder, such as "
ABC", the property value ishttp://server:port/ABC.
Implementation
public function get baseUrl():String public function set baseUrl(value:String):voidcurrentUserServiceDestination | property |
currentUserServiceDestination:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The Data Services Remoting destination name used to fetch details about the user after the user has authenticated successfully with the server.
The default value is /dataservices/messagebroker/amf.
Implementation
public function get currentUserServiceDestination():String public function set currentUserServiceDestination(value:String):voidloginUrl | property |
loginUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The URL value used to log in to the Experience Server. The value is a relative path to the the baseUrl property.
The default value is /j_security_check.
Implementation
public function get loginUrl():String public function set loginUrl(value:String):voidlogoutUrl | property |
logoutUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The URL value used to log out of the Experience Server. The value is a relative path to the the baseUrl property.
The default value is /system/sling/logout.
Implementation
public function get logoutUrl():String public function set logoutUrl(value:String):voidmaxAge | property |
maxAge:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The duration in seconds for which a pin is valid.
The default value is 7200.
Implementation
public function get maxAge():int public function set maxAge(value:int):voidmaxUse | property |
maxUse:int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The maximum number of times a pin can be used.
The default value is 4.
Implementation
public function get maxUse():int public function set maxUse(value:int):voidoperationName | property |
operationName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The name of the operation invoked on the Remoting destination used to fetch the user details.
The default value is getCurrentUserAsMap.
Implementation
public function get operationName():String public function set operationName(value:String):voidpinServletUrl | property |
pinServletUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The URL of pin servlet which creates, updates, or deletes a pin.
The default value is /libs/cq/security/content/pin.
Implementation
public function get pinServletUrl():String public function set pinServletUrl(value:String):voidsecuredServletChannelUrl | property |
securedServletChannelUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The Data Services AMF channel URL used for secured connections.
The default value is /dataservices/messagebroker/amfsecure.
Implementation
public function get securedServletChannelUrl():String public function set securedServletChannelUrl(value:String):voidservletChannelUrl | property |
servletChannelUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The Data Services AMF channel URL.
The default value is /dataservices/messagebroker/amf.
Implementation
public function get servletChannelUrl():String public function set servletChannelUrl(value:String):voidstatusCheckUrl | property |
statusCheckUrl:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The URL value used to determine the current status of user.
The value is a relative path to the the baseUrl property.
The default value is /system/sling/loginstatus.
Implementation
public function get statusCheckUrl():String public function set statusCheckUrl(value:String):voidSecurityConfig | () | Constructor |
public function SecurityConfig()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
toString | () | method |
PIN_ENABLED_PARAM_KEY | Constant |
public static const PIN_ENABLED_PARAM_KEY:String = "enabled"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A special value that specifies the HTTP request parameter key to enable a pin in a pin update request.
PIN_MAXAGE_PARAM_KEY | Constant |
public static const PIN_MAXAGE_PARAM_KEY:String = "maxAge"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A special that specifies the HTTP request parameter key name to set the maximum age (in seconds) for a pin in a pin update request.
PIN_MAXUSE_PARAM_KEY | Constant |
public static const PIN_MAXUSE_PARAM_KEY:String = "maxUse"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A special value that specifies the HTTP request parameter key name to set the maximum usage of a pin in a pin update request.
PIN_REQUEST_PARAM_KEY | Constant |
public static const PIN_REQUEST_PARAM_KEY:String = ":cqpin"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A special value that specifies the HTTP request parameter key while requesting for a pin.
PIN_RESPONSE_FORMAT | Constant |
public static const PIN_RESPONSE_FORMAT:String = ".txt"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Security 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
A special value that specifies the HTTP response format of a create, update, or delete pin HTTP request.
Mon Apr 10 2017, 12:28 PM -07:00