The ArcIMS Servlet Connector property file, Esrimap_prop, stores defaults for the behavior of the ArcIMS Servlet Connector.

Esrimap_prop file is installed in your Web server's servlet directory. See Common servlet engine file locations for a list of common Web servers and their servlet directory location.

This file defines the following Servlet connector properties.

enable=True

Set to "False" to disable the ArcIMS Servlet Connector from accepting HTTP requests. ConnnectorPing is the only request that will be accepted when this property is disabled.

appServerMachine=AIMSHOST

The name or IP address of the machine on which the ArcIMS Application Server is running. For example:

appServerMachine=mymachine

If you want to add additional ArcIMS Application Servers to your site configuration, list their names or IP addresses separated by commas.

appServerMachine=129.103.35.97,123.151.62.57 or appServerMachine=machine1,machine2,machine3

Each appServerMachine must have a corresponding port number in the appServerClientPort property of this property file.

For more information about setting up multiple Application Servers and failover, see Step 2: Planning an ArcIMS site configuration in the ArcIMS Installation Guide, and look for the topic "Common site configuration scenarios".

appServerClientPort=5300

The port on which the ArcIMS Servlet Connector communicates with the ArcIMS Application Server.

appServerClientPort=5300

If you want to add additional ArcIMS Application Server machines to your site configuration, first list them in the appServerMachine property. Then add their corresponding port numbers, separated by commas, to this property:

appServerClientPort=5300,5350

List the port numbers in the same order as their corresponding machines are listed in the appServerMachine property. For example, if the port number for machine1 is 1111 and the port number for machine2 is 2222, the property entries would like the following:

appServerMachine=machine1,machine2 appServerClientPort=1111,2222

For more information, see Configuring ArcIMS ports.

failover=False

Sets how the Servlet Connector makes use of multiple ArcIMS Application Server machines listed in the appServerMachine property. When set to False, the Servlet Connector utilizes the Application Server machines in a round robin fashion. It will send the first request to the first machine in the list, the next request to the next machine in the list, and so on. Upon reaching the end of list, it will return to the first machine again. When set to True, the Servlet Connector sends all requests to the first machine in the list as long as the machine continues to respond. If the machine fails to respond, the Servlet Connector begins sending requests to the second machine in the list, and so on.

For more information, see Using multiple Application Servers for redundancy.

debug=False

Set to True if you want additional debug information to be logged to the servlet engine's stdout file. This file may be a log file or a console window.

authenticate=False

Set to True if you want to enable authentication of requests processed by the ArcIMS Servlet Connector. Authentication allows you to restrict access to ArcIMS services. For more information, see Restricting access to ArcIMS services.

authMethods=Basic

Specifies the authentication method for transmitting the username and password from the client to the server. The two methods available are basic and digest authentication.

Basic authentication uses base64-encoding to transmit the username and password from the client to the server. This means that anyone who can intercept the transmission can determine the username and password.

Digest is more secure and is the recommended value. It provides a higher level of security because the username and password is not transmitted over the Internet. Digest is required for publishing metadata to a Metadata Service.

authenticateWithSessions=True

Enables authentication with sessions. When set to True, and based on browser settings, session information may be stored in the form of a cookie by the browser. When set to False, session information is not enabled. You may want to set this property to False when you want the highest level of authentication that requires the Servlet Connector to validate username and password for every request it receives.

This property works in conjunction with sessionTimeout, which specifies the length of time to maintain the session.

sessionTimeout=120

Session duration in seconds. Only used when authenticate and authenticateWithSessions properties are set to True. Specifies the length of time to maintain a session between the client and Servlet Connector when authenticateWithSessions is true. If this property is omitted, the default value is 120 seconds. For most applications, the default value will be adequate.

aclFileName=

Specifies the path and filename to the Access Control List (ACL) XML file. For more information, see Enabling authentication with a file-based ACL.

Only forward slashes can be used in the path.

Windows: aclFileName=/servlets/aimsacl.xml UNIX: aclFileName=/servlets/aimsacl.xml

A sample ACL file is located in the /ArcIMS/Documentation directory and is called sample_aimsacl.xml.

realm=ArcIMS Network

Identifies to the user which username and password are being requested for. Generally it is useful to have the same realm name for Web sites using the same access control list. The realm name is given with the password prompt. If not specified, realm defaults to "ArcIMS Network".

useJdbc=

True or False. Only used when authenticate=True. Enables a JDBC-accessible database to store authentication privileges. Note: If you set the properties for both XML file-based and JDBC-based ACL, the JDBC settings will be used. For more information, see Enabling authentication with a jdbc-based ACL.

jdbcDriver=

Name of the JDBC driver to be used. The location of the drivers must be part of the servlet engine's classpath setting. Only used when authenticate=True and useJdbc=True.

jdbcDriver=zyh.sql.dbf.DBFDriver

jdbcUrl=

JDBC database URL to the database that contains permissions and users table. Only used when authenticate=True and useJdbc=True.

jdbcUrl=jdbc:<database>:@<machine>.<domain>.<organization> jdbcUrl=jdbc:oracle:oci8:@s2315.mymachine.com jdbcUrl=jdbc:DBF:/C:/arcims/middleware/secureesrimap jdbcUrl=jdbc:microsoft:sqlserver://servername:1433 jdbcUrl=jdbc:odbc:access_acl

jdbcUser=

Authentication database's user name. Only used when authenticate=True and useJdbc=True.

jdbcUser=user1

jdbcPassword=

Specifies the authentication database's password. Only used when authenticate=True and useJdbc=True.

dbcPassword=password1

jdbcPermTable=

Name of the authentication database's permissions table. The permissions table stores all of the individual authentication rules for each service. Only used when authenticate=True and useJdbc=True.

jdbcUserTable=

Specifies the name of the table in the database that lists the valid usernames and passwords. Only used when authenticate=True and useJdbc=True.

jdbcUidColumn=

Name of the userid column found in both the permissions and users tables. The userid column is the unique identifier between the users and permissions tables. Only used when authenticate=True and useJdbc=True.

redirect=False

HTML viewer specific. Enables the HTML viewer to connect to multiple hosts. The ArcIMS Servlet Connector must be told to redirect to different ArcIMS Servlet Connectors on different machines.

Set redirect to True to enable redirection. Redirection does not work with services that require password authentication. HTML Viewer sites created by Designer can only access the services set up on the Web server where the pages originate. To access services on another Web server, the Servlet Connector must be instructed to redirect the request to the Servlet Connector on the remote Web server. The response from the remote Servlet Connector is then sent back to the viewer as if it had been handled locally. For more information, see Customizing the HTML Viewer.

If you choose to set redirect to True, you cannot use authentication. During redirection, the request is redirected to a different service on a different ArcIMS Application Server. The Servlet Connecter cannot handle authentication for a service running on another Application Server.

redirectableHosts=

Specifies the list of host machines to use when redirect=true. Use a comma to separate host machine names. Use an asterisk (*) to allow access to any host machine on the network.

redirectableHosts=host1,host2,host3,host4 redirectableHosts=*

spatialServer.AllowRequestOutput=False

When a GET_IMAGE or GET_EXTRACT request is made, users have the option to specify an output directory and file name for images and zip files by using OUTPUT. When this property is set to False, any output directory included in the request is ignored and not processed by the Servlet Connector. When set to True, users can change the output directory in a request. The recommended value is False. For more information, see Setting Spatial Server restrictions when using the Servlet Connector.

spatialServer.AllowResponsePath=False

This property determines if ArcXML responses sent by the Spatial Server to the client contain pathnames to images, raster symbols, and zip files. By setting this property to False, the pathnames are omitted from the responses. The URLs are unaffected. The following ArcXML responses are affected:

• RASTERMARKERSYMBOL image, RASTERFILLSYMBOL image, and RASTERSHIELDSYMBOL image in a SERVICEINFO response.
• LEGEND file and OUTPUT file in an IMAGE response.
• The attribute file in an EXTRACT, OUTPUT, and LAYOUT response.

If the property is set to True, the pathnames are included in the response. The recommended value is False.

spatialServer.ForbiddenImageTypes=

This property determines which output formats are forbidden when OUTPUT type is used in a GET_IMAGE request. Valid output types are:

• Image Services: gif, jpg, png8, png (png24)
• ArcMap Image Services: gif, jpg, png8, png (png24), bmp, tif

Note: for the png24 format, use 'png' in the list rather than 'png24'.

By default, no output types are forbidden. Multiple types can be included in a comma delimited list. In the following example, bmp, tif, and png24 formats are forbidden:

spatialServer.ForbiddenImageTypes=bmp,tif,png

When a GET_IMAGE request includes an OUTPUT type with a forbidden format, an image is generated in the default service format. For example, if a service is started using PNG8 as the output format, the image will be generated in png8 format. A warning message is written to the Spatial Server log file stating that a forbidden format was requested.

Png24, tif, and bmp files can be quite large and can easily exceed 1 MB in size. If you are concerned about performance, especially where bandwidth may be an issue, these files formats may take too long to transfer. If this is the case, you may want to disable these format types.

spatialServer.ForbiddenLayoutTypes=

This property determines which output formats are forbidden when OUTPUT type is used in a GET_LAYOUT request. Valid output types are: ai, bmp, emf, eps, gif, jpg, pdf, png8, png24, svg, and tif. By default, no output types are forbidden. Multiple types can be included in a comma delimited list.

In the following example, bmp, emf, and eps formats are forbidden:

spatialServer.ForbiddenLayoutTypes=bmp,emf,eps

When a request is made using a forbidden format, a layout image is generated in the default service format. For example, if a service is started using png8 as the output format, the layout will be generated in png8 format. A warning message is written to the Spatial Server log file stating that a forbidden format was requested.