Properties File for Federation Web Services

Web Agent Guides › Web Agent Option Pack Guide › Deploy Federation Web Services as a Web Application › Properties File for Federation Web Services

Properties File for Federation Web Services

The AffWebServices.properties file contains all the initialization parameters for Federation Web Services. For deploying FWS, set only the parameter that specifies the location of the WebAgent.conf file. For the rest of the settings, accept the default values or modify as needed.

The settings are as follows:

AffWebServices.properties Settings	Value
NotificationLibraryType	Specifies the library type the Web Agent uses for notification alerts. Note: The SPS federation gateway does not support this service.
NotificationLibraryDetails	Indicates the Java classname or the C library and function name. Note: The SPS federation gateway does not support this service.
SMserverPort	Determines which Policy Server service at the producer processes the notification tunnel calls.
AgentConfigLocation	Indicates the location of the WebAgent.conf file. If you are using a 4.x IIS or Sun ONE Web Agent, this field can be left blank.

The installed location of the AffWebServices.properties file is in the following locations:

For a web or application server
web_agent_or_webagent_option_pack_home/affwebservices/WEB-INF/classes
For the SPS federation gateway:
sps_home/secure-proxy/Tomcat/webapps/affwebservices/WEB-INF/classes

web_agent_home

Indicates the installed location of the Web Agent.

sps_home

Indicates the installed location of the Secure Proxy Server.

Set up the LoggerConfig.properties File

The LoggerConfig.properties file lets you enable logging so the Federation Web Services application can record the following information:

Assertion retrieval
Session management
Notification alert information
Trace messages

The log file shows activity at the asserting party and the relying party, depending on how your site is configured.

Note: The LoggerConfig.properties file is in UTF-8 format. If you plan to modify this file, use an editor that supports this format.

The installed location of the LoggerConfig.properties file is:

For the Web Agent, the location is
web_agent_home/affwebservices/WEB-INF/classes
For an application server
deployment_directory/affwebservices/WEB-INF/classes
For the SPS federation gateway:
sps_home/secure-proxy/Tomcat/webapps/affwebservices/WEB-INF/classes

web_agent_home

Indicates the installed location of the Web Agent.

deployment_directory

Indicates the default deployment directory for your application server.

sps_home

Indicates the installed location of CA SiteMinder SPS.

Modify the settings as needed. If a value is not specified, the default value for the default locale is used.

The following table shows the settings in the LoggerConfig.properties file.

LoggerConfig.properties Settings	Description
EnableDNSLookup	Instructs the FWS application whether to do a DNS or reverse DNS lookup when processing an incoming SAML request at the consuming site. Select Y or N. When an incoming SAML request is received at a consumer site, FWS logs the details of the request, including the requesting host name. The DNS lookup call collects the host name. The default behavior is to do the DNS lookup. If you select N for this heading, the DNS call is not made and the IP address is logged instead.
LoggingOn (required)	Enables log output. Select Y or N.
LocalFileName (required)	Names the file to use for log output.
LogLocalTime	Enables use of local time for log messages. Select Y or N.
LogRollover	Defines the type of rollover functionality. Select Y or N then define the LogSize or LogCount parameter.
LogSize	Specifies the maximum file size, in megabytes, when rolling over log files by size.
LogCount	Specifies how many log output files to leave when roll-over is enabled.
TracingOn	Enables trace log output. Select Y or N.
TraceFileName	Names the file to use for trace log output.
TraceConfig	Specifies the trace configuration file. For more information, see Trace Logging.
TraceRollover	Defines the type of rollover functionality for tracing. Select Y or N and then specify a TraceSize or TraceCount value.
TraceSize	Specifies the maximum file size, in megabytes, when rolling over trace log files by size.
TraceCount	Specifies how many trace log output files to leave when roll-over is enabled.
TraceFormat	Specifies the trace output file format (default, fixed-width fields, delimited format, XML)
TraceDelim	Defines the character to use as a delimiter when using fixed-width fields as the trace format.

Deploy Federation Web Services as a Web Application

If you are using the Web Agent Option Pack, deploy the Federation Web Services (FWS) application into operation.

Configure one of the following application servers to work with FWS:

Set Up ServletExec to Work with Federation Web Services.
Set Up WebLogic to Work with Federation Web Services.
Set Up WebSphere to Work with Federation Web Services.
Set Up a JBOSS or Tomcat to Work with Federation Web Services.

If you are using the SPS federation gateway, Federation Web Services is already deployed on the embedded Tomcat server.