Server Traits
Each server type (EventDC, NetworkDC, SeismogramDC, PlottableDC) has a getTraits method that returns a PropertyContainer that allows clients to discover characteristics of the server so they can more easily decide which servers to use and more effectively use those servers. There are two classes of server traits, optional and required. Required traits are ones that all servers of a type can and should be expected to advertise. They are fields on the returned object and must be filled in to the best effort of the server. It is not required that these values always be exactly correct (for example time of latest data) but should be close enough to allow clients to make reasonable decisions. Currently, only the seismogram and plottable servers have required traits. Optional characteristics are items that might be useful, and the server may wish to provide, but are not bound to. These are returned as string key-value pairs for flexibility. Over time, it is possible that some optional characteristics may become required if they are found to be of common need.
Optional Traits
To aid server and client writers, a list of common keys for use in optional traits are given here. Servers should use as many of these as possible, and create new keys in consultation with other server maintainers in order to standardize them as much as possible. New keys should also be submitted for inclusion here to aid client writters in determining what keys are in use.
General Keys
These keys can be used for optional characteristics of servers of any type.
| Key |
Description |
| description |
A textual description of the service, fit for display to an end user in a dialog. May be long. |
| shortDescription |
A very short description of the service, usually a few words, fit for display on a single line, up to 60 characters. |
| operator |
Name of the host institution or group for this server. |
| contactEmail |
Email address to allow a user to contact the maintainers of the server, for example to report problems. |
| contactURL |
URL that clients can go to for more information on the service, perhaps including current status (ie service is down due to xyz). |
NetworkDC
| Key |
Description |
| authoritativeNetworks |
Networks for which this server considers itself the authoriative source of network information. Should be a comma separated list of network codes, temporary networks should append the 2 digit begin year to the code. |
EventDC
| Key |
Description |
| primaryCatalogs |
Catalogs for which this servers considers itself to be the primary source. |
SeismogramDC
Required fields can be found in the definition of SeismogramDCTraits in IfSeismogramDC.idl
.
| Key |
Description |
| authoritativeNetworks |
Networks for which this server considers itself the authoriative source of seismograms. Should be a comma separated list of network codes, temporary networks should append the 2 digit begin year to the code. |
| qc |
Whether the data in this server has been quality controlled or not, either y, n, or b for both. |
PlottableDC
