Installation Guides › SOA Agent for IBM WebSphere Guide › Configure the SOA Agent › SOA Agent for WebSphere Configuration File

Previous Topic: How to Configure the SOA Agent

Next Topic: Agent Configuration Object

SOA Agent for WebSphere Configuration File

By default, the SOA Agent for WebSphere installation creates a single agent configuration file, JavaAgent.conf.

The agent configuration file is located in the SOA_HOME/config directory, where SOA_HOME is the location where you installed the SOA Agent. For example:

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 SOA Agent.

The default value is "SoaAgent". Do not change this value.

EnableAgent

Specifies whether the SOA 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 SOA_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\\SOASecurityManager\\soaagent\\wasagent\\config\\SmHost.conf
  • (Windows) config\\SmHost.conf
  • (UNIX) export/soaagent/wasagent/config/SmHost.conf
  • (UNIX) /config/SmHost.conf

ServerName

A string that will be used in the SOA Agent log to identify the WebSphere Server.

appserverjaasloginhandler

Specifies the Application Server-specific SOA Agent handler class for WebSphere.

Default value is "com.ca.soa.agent.appserver.jaas.was.WasLoginHandler". 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 WebSphere server is running, the SOA Agent will not pick up the change until WebSphere is restarted.

The JavaAgent.conf file also contains a list of SOA 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)

# SOA Agent Configuration File
#
# This file contains bootstrap information required by
# the SOA Agent
#
defaultagentname=SoaAgent
enableagent=yes
agentconfigobject=wsagent1_ac
servername=SOAWAS61
smhostfile=config\\SmHost.conf
appserverjaasloginhandler=com.ca.soa.agent.appserver.jaas.was.WasLoginHandler

# Configure plugins for the agent SoaAgent
transport_plugin_list=com.ca.soa.agent.httpplugin.pluginconfig.HttpPluginConfig, com.ca.soa.agent.jaxrpcplugin.pluginconfig.JaxRpcPluginConfig
msg_body_plugin_list=com.ca.soa.agent.txmplugin.pluginconfig.TxmPluginConfig
credential_plugin_list=com.ca.soa.agent.httpplugin.pluginconfig.HttpPluginConfig, com.ca.soa.agent.txmplugin.pluginconfig.TxmPluginConfig
variable_resolver_plugin_list=com.ca.soa.agent.txmplugin.pluginconfig.TxmPluginConfig

# <EOF>

More information:

Agent Configuration Object