All Comet Way agents share a consistent set of property key names.
| affected_method |
If this property is non-empty, this extension will only apply to the request method (GET, POST, HEAD, etc.) given by this property. |
| affected_path |
If this property is non-empty, this extension will only apply to requests whose URI path start with this property. |
| agent_classname |
Java class name of an agent to be instantiated. |
| allow_directory_lists |
Enables the dynamic generation of directory listings. |
| allow_ips |
A comma separated list of IP addresses or partial IP addresses that are allowed (or * for all) if the default behavior is "deny". |
| allow_properties |
A comma separated list of name=value pairs, if no =value is given, an allow is given if the property exists, otherwise the property must have the given value, used if the default behavior is "deny". |
| alpha_sort_index |
The index will be sorted alphanumerically when set to true. |
| auth_password |
An alphanumeric password used for authentication. |
| auth_username |
An alphanumeric username used for authentication. |
| authentication_agent |
|
| authentication_file |
File where authentication information is stored. This property has been deprecated. |
| authentication_files |
A comma separated list of files where authentication information is stored. |
| bind_address |
This is the local address the agent will bind its server socket to. By default, the agent will bind to all available addresses. |
| bind_port |
The TCP/IP server port created by this agent. |
| cell_circles |
Cells are drawn as circles. |
| cell_filled |
Cells are drawn filled. |
| cell_height |
Height of cells drawn in pixels. |
| cell_width |
Width of cells drawn in pixels. |
| check_hosts |
Flag to check whether hosts are up or not. |
| check_interval |
The time in milliseconds between checks. |
| command_line |
A shell command to be executed by this agent. |
| container_tag |
The name of the containing XML tag. |
| database_name |
The service name prefix where PropsList databases are found. |
| default_behavior |
This determines by default whether all requests should be allowed or denied, can be either "allow" or "deny" (default: allow) |
| default_index |
URL that is loaded when only '/' is requested. |
| default_port |
The default HTTP port. |
| default_reply |
Default reply message. |
| delete_files |
A comma separated list of filenames to delete. |
| delete_messages |
Delete messages from the server after retrieving them successfully. |
| delimiter_char |
|
| deny_ips |
A comma separated list of IP addresses or partial IP addresses that are denied (or * for all) if the default behavior is "allow" (default: ) |
| deny_properties |
A comma separated list of name=value pairs, if no =value is given, a deny is given if the property exists, otherwise the property must have the given value, used if the default behavior is "allow" (default: ) |
| deny_response |
This is the response if a request is to be denied. This is either a 3 number return code or "drop", where the connection is simply dropped (default: 403) |
| domains |
A comma separated list of domain names to which this agent is related. |
| dont_index_list |
A comma separated list of regular expressions. Any files that match will not be listed in the automatically generated directory listing. |
| download_url |
URL of a file to download. |
| echo_debug |
Debug output is echoed to the default reporter if true. |
| echo_error |
Error output is echoed to the default reporter if true. |
| echo_println |
Standard output is echoed to the default reporter if true. |
| echo_warning |
Warning output is echoed to the default reporter if true. |
| email_key |
Key used to retrieve an email address from a PropsList database. |
| exit_code |
The exit code returned by this agent. |
| field_types |
A comma separated list of database field types. |
| file_lifespan_ms |
|
| frame_height |
Height of the window frame in pixels. |
| frame_title |
Title to be displayed in the window frame. |
| frame_visible |
Frame is initially visible when set to true. |
| frame_width |
Width of the window frame in pixels. |
| from_fields |
Comma separated list of database fields from which the data will be read. |
| from_files |
A comma separated list of filenames. |
| grid_height |
Height of the grid to be drawn. |
| grid_visible |
Lines of the grid are drawn when set to true. |
| grid_width |
Width of the grid to be drawn. |
| header_matches_allow |
A comma separated list of patterns (regexp) that are allowed in the header fields if the default behavior is "deny" (default: ) |
| header_matches_deny |
A comma separated list of patterns (regexp) that are denied in the header fields if the default behavior is "allow" (default: ) |
| hide_debug |
Disables debug output when set to true. |
| hide_println |
Disables standard output when set to true. |
| hide_warning |
Disables warning output when set to true. |
| html_directory |
Directory where HTML files are stored. |
| html_response_agent |
Service name of the agent that implements a HTMLResponseInterface. The WebServer will fetch this Agent from the ServiceManager to be used for returning HTML responses, like error messages and other common responses. |
| http_timeout |
Number of milliseconds to wait before failing a HTTP request. |
| id |
Unique ID for this agent. |
| index_agent |
Service name of the request agent that should receive requests by default. |
| initial_wait_time |
The number of milliseconds to wait before taking a first action. |
| is_logger_output |
If true, the log entries will be formatted as if they were HTTP log entries. Otherwise they will be treated as raw entries and will not be formatted |
| jdbc_driver |
Class name of an installed JDBC driver. |
| jdbc_maintain_connection |
Keeps the JDBC connection open between calls if set to true. |
| jdbc_password |
Password for authenticating to a JDBC source. |
| jdbc_url |
URL of a JDBC database to use. |
| jdbc_username |
Username for authenticating to a JDBC source. |
| lnf_classname |
Class name of the look and feel class. Use 'java' for the default look and feel, or 'system' for the system-specific look and feel. |
| load_file |
The file this agent will load from. |
| load_sleep_time |
Number of milliseconds the load monitor thread uses to sleep. |
| log_debug |
Debug output is logged. |
| log_dir |
Directory where log files are created. |
| log_error |
Error output is logged. |
| log_file |
The file that is used as a log file. |
| log_file_date_format |
SimpleDateFormat string used to generate the log file name. |
| log_file_dir |
Directory where log files are created. |
| log_file_prefix |
Used to prepend the names of log files created by this agent. |
| log_file_suffix |
Added to the end of generated log filenames. |
| log_map_file |
The filename of the file that maps a name to a pattern. This allows the LogViewerPage to only show you log entry matches that contain certain patterns. |
| log_println |
Standard output is logged. |
| log_requests |
Requests are logged when set to true. |
| log_warning |
Warning output is logged. |
| logs_per_file |
Maximum number of log entries before a new log file is generated. |
| make_directories |
Automatically create required subdirectories necessary to create the specified file. |
| max_bandwidth |
The number of bytes per second (bps) allowed for each connection. |
| max_connections |
Maximum number of simultaneous TCP/IP connections accepted by this agent. Any connection made after this number has been reached will hang for the thread_pool_timeout time or until another thread in the pool is freed. |
| max_field_length |
This is the maximum length of a field of the request. If any field in the request exceeds this length, a request entity too long will be returned. If your agent requires long request fields, such as large cookies, this property may need to be increased. |
| max_multipart_length |
|
| max_queue_size |
Maximum number of messages to keep in this agent's queue. |
| max_sessions |
The maximum number of concurrent connections. |
| max_show_log_length |
This is the maximum length of log data that will be displayed by the LogViewerPage at once. |
| max_trys |
Maximum number of trys before failing. |
| max_uri_length |
Maximum length URI accepted by the server. |
| message_url |
URL to a message. |
| mime_types_file |
File containing an index of file extensions and their corresponding MIME types. |
| modify_proxied_request |
|
| multihome |
Multiple domain names are mapped if this property is set to true. |
| name |
Name of this agent. |
| name_key |
Key used to retrieve a name from a PropsList database. |
| next_agent_id |
ID of the next agent that will be created. |
| number_of_threads |
Number of threads allocated by this agent for processing requests. |
| offset |
Number of pixels bordering the grid. |
| om_service_name |
Service name of the IObjectManager implementation to use. |
| output_classname |
Classname used by this agent when creating a .java file. |
| output_file |
Path of a file where the agent results will be written. |
| output_format |
CRLF format of the output file (system, unix, macintosh, or dos). |
| password |
Password used by this agent. |
| path_matches_allow |
A comma separated list of patterns (regexp) that are allowed in the URI path if the default behavior is "deny" (default: ) |
| path_matches_deny |
A comma deparated list of patterns (regexp) that are denied in the URI path if the default behavior is "allow" (default: ) |
| pop3_host |
POP3 host used by this agent. |
| pop3_port |
Port for the POP3 server used by this agent. |
| props_tag |
The name of the XML tag containing Props data. |
| proxy_agent |
|
| proxy_file |
File that contains proxy lookup table information. |
| proxy_socket_cache_timeout |
Sets the number of milliseconds for how long cached sockets should be considered alive. |
| proxy_socket_timeout |
The timeout set for the Socket used to connect to the server that is being proxied to. |
| recipients |
A comma separated list of email addresses to which an email message will be sent by this agent. |
| recursive |
This agent operates recursively when set to true. |
| redirect_agent |
|
| redirect_file |
File containing the redirection index used by this agent. |
| refuse_requests |
This is a comma separated list of text that is used to match against the request URI. If the URI contains any of these Strings, the connection is immediately dropped and no response is given. |
| replace_existing_file |
Deletes existing files before writing a new file at the same location when set to true. |
| reply_message |
A message sent in reply to a request. |
| reply_subject |
A subject of a message sent in reply. |
| reply_to |
Reply To email address used by this agent when sending email messages. |
| report_title |
Title of the report generated by this agent. |
| root_dir |
Path to the root directory. |
| save_file |
The file this agent will save to. |
| scan_dir |
The directory to be scanned by this agent. |
| schedule |
Schedule used by this agent. |
| send_debug |
Debug messages are sent. |
| send_email_service_name |
Service name of the SendEmailInterface to use for sending email. |
| send_error |
Error messages are sent. |
| send_println |
Standard messages are sent. |
| send_warning |
Warning messages are sent. |
| service_name |
Service name used by this agent to register itself. |
| service_url |
|
| session_timeout_ms |
Number of milliseconds to wait before timing out a session. |
| session_type |
ObjectType used to create session objects in the Object Manager. |
| show_memory_usage |
Attempt to display memory usage |
| smtp_host |
SMTP host used by this agent to send email messages. |
| smtp_port |
Port of the SMTP host used by this agent to send email messages. |
| smtp_sleep_ms |
Number of milliseconds to wait before sending queued email messages. |
| smtp_timeout_ms |
Number of milliseconds to wait before failing an SMTP connection. |
| socket_initial_timeout |
This property serves 2 purposes. The first is an initial read timeout. Upon a client connection to the agent, the client will have this many milliseconds to start sending the first line of the request, otherwise the agent will immediately respond with a request timed out. The second use for this property is the polling time for a thread in the ThreadPool to free up. |
| socket_linger_time |
This property is obsolete and is no longer used. |
| socket_timeout |
After the agent receives the first line of a client request, the socket's timeout is set to this property. This timeout is meant to be far more lenient than the initial timeout, whose purpose is to prevent DOSing and idling clients. |
| sql_statement |
A statement or query for execution by a SQL database. |
| startup_dir |
Directory from where startup files are loaded. |
| startup_file |
Path to the XML-based startup file. |
| strict_http_version |
If this property is set to true, the agent will only accept HTTP/1.1 requests. Any HTTP/1.0 requests will yield a 505 Version not supported response. |
| subject |
The subject of an email message. |
| table_fields |
A comma separated list of database field names. |
| table_name |
Name of the database table. |
| table_names |
Names of the SQL tables to use. |
| table_types |
|
| thread_pool_timeout |
Number of milliseconds to wait before reclaiming a thread. |
| thread_sleep_ms |
|
| to_fields |
Comma separated list of database fields where the data will be written. |
| to_files |
A comma separated list of filenames. |
| to_table |
Name of the table where the data will be written. |
| to_types |
Comma separated list of database types. |
| use_inet_address_methods |
Use getInetAddress socket method to gather client connection information. |
| user_agent |
The string used to identify this agent to the server. |
| username |
Username used by this agent. |
| verbose |
Additional output is sent to the reporter when this is set to true. |
| webserver_service_name |
Service name of the webserver to which this agent is related. |
