Sun OpenSSO Enterprise Policy Agent 3.0 User's Guide for J2EE Agents

J2EE Property Configuration: Application Specific or Global

Certain J2EE agent properties can be configured for specific applications. Therefore, the agent can use different values of the same property for different applications as defined in the configuration file. Properties that are not configured for specific applications apply to all the applications on that deployment container. Such properties are called global properties.

Knowledge of the format of these application-specific constructs is often not required in order to set them. For example when you configure the properties using OpenSSO Enterprise Console, you do not interact with the “<key>[<appname>]=<value>” formatting involved with application-specific constructs. However, if you use OpenSSO Enterprise Console to set an application-specific property, though the formatting information provided in this section is not applicable, the general information about properties that can be both application-specfic and global is useful.

See the following table to determine when the application-specific construct format is required to set these types of properties.

Table 4–3 Use of the Map Construct Format: Required or Not

Method for Setting Properties

Location of Agent Configuration

Use of Application-Specific Construct Format Required

Using the OpenSSO Enterprise Console 

Centralized agent configuration 

NO 

Using the ssoadm command-line utility

Centralized agent configuration 

YES 

Using the OpenSSOAgentConfiguration.properties file

Local agent configuration 

YES 

An application-specific property has the following format (Does not apply when the OpenSSO Enterprise Console is used):

<key>[<appname>]=<value>
key

The configuration key (name of the configuration property)

appname

The application name to which this configuration belongs. The application name is the context path of the application without the leading forward slash character. In a scenario where the application has been deployed at the root-context of the server, the application name should be specified as DefaultWebApp.

value

The value used by the agent to protect the application identified by the given application name


Note –

When an application specific configuration is not present, the agent uses different mechanisms to identify a default value. Configurations are possible where the default value is used as the value specified for the same key without any application specific suffix [<appname>]. The following settings for a single property serve as an example:

com.sun.identity.agents.config.example[Portal] = value1
com.sun.identity.agents.config.example[DefaultWebApp] = value2
com.sun.identity.agents.config.example = value3

The preceding example illustrates that for applications other than the ones deployed on the root context and the context /Portal, the value of the property defaults to value3.


Application Specific configuration properties must follow the rules and syntax of the map construct of configuration entries.


Example 4–4 Example of Application Specific and Global Configuration

com.sun.identity.agents.config.example[Portal] = value1
com.sun.identity.agents.config.example[BankApp] = value2
com.sun.identity.agents.config.example[DefaultWebApp] = value3