Previous Topic: Configure the SiteMinder Agent

Next Topic: Agent Configuration Object

SiteMinder Agent for JBoss Configuration File

By default, the SiteMinder Agent for JBoss installation creates a single agent configuration file, JavaAgent.conf in the SMAGENT_HOME/config directory.

Each Agent configuration file is created with the following required default configuration parameters/values:

Parameter

Description

DefaultAgentName

The agent identity the Policy Server uses to associate policies with the SiteMinder Agent.

EnableAgent

Specifies whether the SiteMinder Agent is enabled. Possible values are Yes and No.

Default value is Yes.

AgentConfigObject

The Agent Configuration Object specified during installation.

SmHostFile

Path to the local Host Configuration File. Path can be specified in absolute terms or relative to SMAGENT_HOME.

Note: On Windows, you must specify paths using double backslashes ("\\") rather than single backslash ("\") to separate directories. On UNIX, use standard single slash ("/") separators.

Example values:

  • (Windows) C:\\Program Files\\CA\\JBossAgent\\config\\SmHost.conf
  • (Windows) config\\SmHost.conf
  • (UNIX) export/JBossAgent/config/SmHost.conf
  • (UNIX) /config/SmHost.conf

ServerName

A string that will be used in the SiteMinder Agent log to identify the JBoss Application Server.

appserverjaasloginhandler

Specifies the SiteMinder Agent for JBoss login handler class.

Default value is "com.ca.soa.agent.appserver.jaas.jboss.JBossLoginHandler". Do not change this value.

appserverjmshandler

Specifies the SiteMinder Agent for JBoss JMS handler class.

Default value is "com.ca.soa.agent.appserver.jaxrpc.jms.jboss.JBossJMSMessageHandler". Do not change this value.

You should not need to edit the preconfigured values unless the location of the Host Configuration File changes or you want to refer to a different Agent Configuration Object. If you choose to use local configuration, you can add other Agent configuration parameters to these preconfigured values.

Note: Parameters held in the Agent configuration file are static; if you change these settings while the JBoss server is running, the SiteMinder Agent will not pick up the change until JBoss is restarted.

The JavaAgent.conf file also contains a list of SiteMinder Agent plugin classes; you do not need to alter this information.

Generally, you only need to edit the JavaAgent.conf.file if you change the name of your Agent Configuration Object.

Sample JavaAgent.conf (Windows)

# Java Agent Configuration File
#
# This file contains bootstrap information required by
# the SiteMinder Java Agent
#

#
# Configuration for agent testagent
#
defaultagentname=agentjboss
enablewebagent=yes
agentconfigobject=soaagentconfig
servername=jboss.example.com
smhostfile=C:\\Program Files\\CA\\JBossAgent\\config\\SmHost.conf

appserverjaasloginhandler=com.ca.soa.agent.appserver.jaas.jboss.JBossLoginHandler
appserverjmshandler=com.ca.soa.agent.appserver.jaxrpc.jms.jboss.JBossJMSMessageHandler

# Configure plugins for the agent testagent
transport_plugin_list=com.ca.soa.agent.httpplugin.pluginconfig.HttpPluginConfig, com.ca.soa.agent.jaxrpcplugin.pluginconfig.JaxRpcPluginConfig, com.ca.soa.agent.jmsplugin.pluginconfig.JMSPluginConfig, com.ca.soa.agent.jaxwsplugin.pluginconfig.JaxWsPluginConfig
msg_body_plugin_list=com.ca.soa.agent.txmplugin.pluginconfig.TxmPluginConfig, com.ca.soa.agent.jaxwsplugin.pluginconfig.JaxWsPluginConfig
credential_plugin_list=com.ca.soa.agent.httpplugin.pluginconfig.HttpPluginConfig, com.ca.soa.agent.jaxwsplugin.pluginconfig.JaxWsPluginConfig
variable_resolver_plugin_list=com.ca.soa.agent.txmplugin.pluginconfig.TxmPluginConfig

# <EOF>