Cheshire3 Object Model - Server


class cheshire3.baseObjects.Server(session, configFile='serverConfig.xml')[source]

A Server object is a collection point for other objects.

A Server is a collection point for other objects and an initial entry into the system for requests from a ProtocolHandler. A server might know about several Databases, RecordStores and so forth, but its main function is to check whether the request should be accepted or not and create an environment in which the request can be processed.

It will likely have access to a UserStore database which maintains authentication and authorization information. The exact nature of this information is not defined, allowing many possible backend implementations.

Servers are the top level of configuration for the system and hence their constructor requires the path to a local XML configuration file, however from then on configuration information may be retrieved from other locations such as a remote datastore to enable distributed environments to maintain synchronicity.

get_config(session, id)

Return a configuration for the given object.

get_default(session, id, default=None)

Return the default value for an option on this object

get_object(session, id)

Return the object with the given id.

Searches first within this object’s scope, or search upwards for it.

get_path(session, id, default=None)

Return the named path

get_setting(session, id, default=None)

Return the value for a setting on this object.


The following implementations are included in the distribution by default:

class cheshire3.server.SimpleServer(session, configFile='serverConfig.xml')[source]