All properties listed in the below table are all the possible TAP configuration properties. Some of them are mandatory. If one of these properties is missing, the TAP Service will not able to start: an error will be displayed immediately in the application server log and a HTTP 503 error will be sent when accessing the TAP URL.
Besides, you should know that any property key not listed in this table will be ignored without error or warning message.
However, any not allowed property value will generate a warning message in the application server log and the default value will be kept. Thus, the TAP Service will be started and available but the desired configuration value will not be set. So, you should take a look at the application server log every times you start the TAP Service!
Here is an empty minimum TAP configuration file: tap_min.properties and a complete one: tap_full.properties.
Important note: Any limit value is an integer and so can be at most: 231-1 bytes/rows = 2147483647B/R (or also for the byte unit: = 2147483kB = 2147MB = 2GB). Otherwise, you should use the null value 0 to raise the limit constraint.
Legend: M means that the property is mandatory. If nothing is written for the second column, the property is optional.
| Property | Type | Description | Example | |
|---|---|---|---|---|
| General | ||||
| service_home_page | text |
Path to the page which will be the index/home page of the TAP Service. A default home page - just listing the TAP resources - is set if none is provided. |
|
|
| Provider | ||||
| provider_name | text | Name of the provider of the TAP Service. |
|
|
| service_description | text | Description of the TAP Service. | ||
| Database | ||||
| jdbc_driver | text |
JDBC driver path. By default, it is guessed in function of the database name provided in the jdbc_url property. It MUST be provided if another DBMS is used or if the JDBC driver path does not match the following ones:
|
oracle.jdbc.driver.OracleDriver | |
| jdbc_url | M | text |
It must be a JDBC driver URL. Note: The username, password or other parameters may be included in it, but in this case, the corresponding properties should leave empty or not provided at all. |
|
| db_username | text |
Mandatory if the username is not already provided in jdbc_url Username used to access to the database. |
||
| db_password | text |
Mandatory if the password is not already provided in jdbc_url Password used by db_username to access to the database. Note: No password encryption can be done in this configuration file for the moment. |
||
| sql_translator | M | text |
The translator to use in order to translate ADQL to a SQL compatible with the used DBMS and its spatial extension. The TAP library supports only Postgresql (without spatial extension) and PgSphere for the moment. But you can provide your own SQL translator (even if it does not have spatial features), by providing a path to a class (within brackets: {...}) that implements ADQLTranslator and which have at least an empty constructor. |
|
| Metadata | ||||
| metadata | M | text |
Define the way the library must get the list of all schemas, tables and columns to publish and all their metadata (e.g. utype, description, type, ...) In its current state, the library proposes two methods:
|
|
| metadata_file | text |
Mandatory if the value of "metadata" is "xml". Local file path to the TableSet XML document. This XML must implement the schema TableSet defined by VODataService. |
/home/foo/my_metadata.xml | |
| Files | ||||
| file_manager | M | text |
Type of the file manager. Accepted values are: local (to manage files on the local system). You can also add another way to manage files by providing the path (within brackets: {...}) to a class implementing TAPFileManager and having at least one constructor with only a java.util.Properties parameter. |
|
| file_root_path | M | text | File path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be. | |
| directory_per_user | boolean |
Tells whether a directory should be created for each user. If yes, the user directory will be named with the user ID. In this directory, there will be error files, job results and it may be the backup file of the user. The default value is: true. |
|
|
| group_user_directories | boolean |
Tells whether user directories must be grouped. If yes, directories are grouped by the first letter found in the user ID. The default value is: false. |
|
|
| default_retention_period | integer |
The default period (in seconds) to keep query results. The prefix "default" means here that this value is put by default by the TAP Service if the client does not provide a value for it. The default period MUST be less or equals to the maximum retention period. If this rule is not respected, the default retention period is set immediately to the maximum retention period. A negative or null value means there is no restriction over the default retention period: job results will be kept forever. Float values are not allowed. By default query results are kept forever: default_retention_period=0. |
86400 (1 day) | |
| max_retention_period | integer |
The maximum period (in seconds) to keep query results. The prefix "max" means here that the client can not set a retention period greater than this one. The maximum period MUST be greater or equals to the default retention period. If this rule is not respected, the default retention period is set immediately to the maximum retention period. A negative or null value means there is no restriction over the maximum retention period: the job results will be kept forever. Float values are not allowed. By default query results are kept forever: max_retention_period=0. |
604800 (1 week) | |
| UWS Backup | ||||
| backup_frequency | text or integer |
Frequency at which the UWS service (that's to say, all its users and jobs) must be backuped. Allowed values are: never (no backup will never be done), user_action (each time a user does a writing action, like creating or execution a job), a time (must be positive and not null) in milliseconds. By default, no backup is done, so: backup_frequency=never. |
|
|
| backup_mode | text |
Tells whether the backup must be one file for every user, or one file for each user. This second option should be chosen if your TAP Service is organizing its files by user directories ; see the property directory_per_user. Allowed values are: user (one backup file for each user), whole (one file for all users ; may generates a big file). The default mode is: whole. |
|
|
| Asynchronous jobs management | ||||
| max_async_jobs | integer |
Maximum number of asynchronous jobs that can run simultaneously. A negative or null value means there is no restriction over the number of running asynchronous jobs. By default, there is no restriction: max_async_jobs=0. |
|
|
| Query Execution | ||||
| default_execution_duration | integer |
Default time (in milliseconds) for query execution. The prefix "default" means here that the execution duration will be this one if the client does not set one. The default duration MUST be less or equals to the maximum execution duration. If this rule is not respected, the default execution duration is set immediately to the maximum execution duration. A negative or null value means there is no restriction over the default execution duration: the execution could never end. Float values are not allowed. By default, there is no restriction: default_execution_duration=0. |
600000 (10 minutes) | |
| max_execution_duration | integer |
Maximum time (in milliseconds) for query execution. The prefix "max" means here that the client can not set a time greater than this one. The maximum duration MUST be greater or equals to the default execution duration. If this rule is not respected, the default execution duration is set immediately to the maximum execution duration. A negative or null value means there is no restriction over the maximum execution duration: the execution could never end. Float values are not allowed. By default, there is no restriction: max_execution_duration=0. |
3600000 (1 hour) | |
| Output | ||||
| output_add_formats | text |
Comma separated list of output formats for query results, in addition to the VOTable. Allowed values are: json, csv, tsv, sv(<separator>)[:mime_type[:mime_type_alias]], or a path (within brackets: {...}) to a class implementing OutputFormat<ResultSet> and having at least one constructor with only a tap.ServiceConnection<ResultSet> parameter. Note: if no MIME type or MIME type alias is provided for the sv(...) format, defaults are: text/plain and text. So sv([]) is equivalent to sv([]):text/plain:text. |
|
|
| output_default_limit | text |
Default limit for the result output. The prefix "default" means here that this value will be set if the client does not provide one. This limit can be expressed in only one unit: rows. A negative or null value means there is no restriction over this limit. Float values are not allowed. Obviously this limit MUST be less or equal than output_max_limit. By default, there is no restriction: output_default_limit=0 |
|
|
| output_max_limit | text |
Maximum limit for the result output. The prefix "max" means here that the client can not set a limit greater than this one. This limit can be expressed in only one unit: rows. A negative or null value means there is no restriction over this limit. Float values are not allowed. Obviously this limit MUST be greater or equal than output_default_limit. By default, there is no restriction: output_max_limit=0 |
|
|
| Upload | ||||
| upload_enabled | boolean |
Tells whether the Upload must be enabled. If enabled, files can be uploaded in the file_root_path, the corresponding tables can be added inside the UPLOAD_SCHEMA of the database, queried and then deleted. By default, the Upload is disabled: upload_enabled=false. |
|
|
| upload_default_db_limit | text |
Default limit for the number of uploaded records that can be inserted inside the database. The prefix "default" means here that this value will be set if the client does not provide one. This limit can be expressed with 2 types: rows or bytes. For rows, you just have to suffix the value by a "r" (upper- or lower-case) or by nothing (by default, nothing will mean "rows"). For bytes, you have to suffix the numeric value by "B", "kB", "MB" or "GB". Here, unit is case sensitive. No other storage unit is allowed. A negative or null value means there is no restriction over this limit. Float values are not allowed. Warning! Obviously this limit MUST be less or equal than upload_max_db_limit, and MUST be of the same type as it. If the chosen type is rows, this limit MUST also be strictly less than upload_max_file_size. By default, there is no restriction: upload_default_db_limit=0 |
|
|
| upload_max_db_limit | text |
Maximum limit for the number of uploaded records that can be inserted inside the database. The prefix "max" means here that the client can not set a limit greater than this one. This limit can be expressed with 2 types: rows or bytes. For rows, you just have to suffix the value by a "r" (upper- or lower-case), with nothing (by default, nothing will mean "rows"). For bytes, you have to suffix the numeric value by "B", "kB", "MB" or "GB". Here, unit is case sensitive. No other storage unit is allowed. A negative or null value means there is no restriction over this limit. Float values are not allowed. Warning! Obviously this limit MUST be greater or equal than upload_default_db_limit, and MUST be of the same type as it. If the chosen type is rows, this limit MUST also be strictly less than upload_max_file_size. By default, there is no restriction: upload_max_db_limit=0 |
|
|
| upload_max_file_size | text |
Maximum allowed size for the uploaded file. This limit MUST be expressed in bytes. Thus, you have to suffix the numeric value by "B", "kB", "MB" or "GB". Here, unit is case sensitive. No other storage unit is allowed. Warning! When the upload is enabled, there must be a maximum file size. Here, no "unlimited" value is possible ; 0 and any negative value are not allowed. Warning! In function of the chosen upload_max_db_limit type, upload_max_file_size MUST be greater in order to figure out the file metadata part. By default, the maximum size is set to its maximum possible value: upload_max_file_size=2147483647B (~2GB) |
|
|