Jump to: navigation, search

Difference between revisions of "CDO/Server Configuration Reference"

< CDO
(Example)
(Example)
Line 2: Line 2:
 
<br>
 
<br>
 
==Example==
 
==Example==
The CDOServerApplication is configured with the <code>cdo-server.xml</code> file. It must be located in the '''folder''' that you declare through the system property <code>net4j.config</code>. Checkout this example from CVS and modify it for your needs: <code>[http://dev.eclipse.org/viewcvs/viewvc.cgi/org.eclipse.emf/org.eclipse.emf.cdo/features/org.eclipse.emf.cdo.server.product-feature/rootfiles/configuration/cdo-server.xml?view=co&root=Modeling_Project org.eclipse.emf.cdo.server.product-feature/rootfiles/configuration/cdo-server.xml]</code>.
+
The CDOServerApplication is configured with the <code>cdo-server.xml</code> file. It must be located in the '''folder''' that you declare through the system property <code>net4j.config</code>.
 +
 
 +
Checkout this example from CVS and modify it for your needs: <code>[http://dev.eclipse.org/viewcvs/viewvc.cgi/org.eclipse.emf/org.eclipse.emf.cdo/features/org.eclipse.emf.cdo.server.product-feature/rootfiles/configuration/cdo-server.xml?view=co&root=Modeling_Project org.eclipse.emf.cdo.server.product-feature/rootfiles/configuration/cdo-server.xml]</code>.
  
 
The subsequent sections explain the used [[#Element cdoServer|XML Elements]].
 
The subsequent sections explain the used [[#Element cdoServer|XML Elements]].

Revision as of 02:15, 11 January 2011


Example

The CDOServerApplication is configured with the cdo-server.xml file. It must be located in the folder that you declare through the system property net4j.config.

Checkout this example from CVS and modify it for your needs: org.eclipse.emf.cdo.server.product-feature/rootfiles/configuration/cdo-server.xml.

The subsequent sections explain the used XML Elements.

Element cdoServer

The root element of the cdo-server.xml file. It can contain zero, one or several acceptor elements and zero, one or several repository elements.

Element acceptor

Defines an IAcceptor instance. Please refer to the Net4j documentation for details about acceptors and connectors.

The type attribute corresponds to the type of an acceptor factory that is contributed via the org.eclipse.net4j.util.factories extension point with a product group of org.eclipse.net4j.acceptors. The remaining attributes depend on the specified type attribute value. The following values are possible with the shipped distribution (subject to user supplied extension):

  • tcp: Acceptor for fast, new I/O based socket connections. The following additional attributes are recognized:
    • listenAddr: The network address the server socket shall be bound to. A value of "0.0.0.0" is the default (whole attribute can be omitted) and tells the socket to listen on all available addresses.
    • port: The network port the server socket shall be bound to. A value of "2036" is the default (whole attribute can be omitted).
  • jvm: Acceptor for JVM internal (non-socket based ) connections. Currently not supported by the Net4Configurator.

The acceptor element can contain zero or one negotiator element(s).

Please note that the acceptor element is likely to be moved to a separate Net4j configuration file in the future.

Element negotiator

Defines an INegotiator instance to be used by the connectors created by an acceptor (defined by the enclosing acceptor element). Please refer to the Net4j documentation for details about negotiators and the pluggable security concept that can be used for authentication and authorization.

The type attribute corresponds to the type of a negotiator factory that is contributed via the org.eclipse.net4j.util.factories extension point with a product group of org.eclipse.net4j.negotiators. The remaining attributes depend on the specified type attribute value. The following values are possible with the shipped distribution (subject to user supplied extension):

  • challenge: Negotiator for simple yet effective and cryptographically secure challenge/response based negotiations. The following additional attributes are recognized:
    • description: The absolute path to a file in the local file system that contains the credentials of the users in the form userid: password.


Element repository

Defines an IRepository instance. Please refer to CDO Server for details about repositories and sessions.

The name attribute uniquely identifies a repository in the scope of a repository configurator.

The repository element can contain several property elements (see below) and must contain exactly one store element.

Property overrideUUID

Specifies a constant UUID for the repository. If omitted the repository will be created with a random UUID. The format of an override UUID is not further specified but should respect the file naming conventions of the used operating system.

Overriding the default random UUID can be useful if you have scripts that operate on the file system folder that is created on the server for each repository and named after the repository UUID.

Property supportingAudits

Specifies whether the repository will support audit views or not. Please note that a repository can only support audit views if its store supports audit views as well:

Store Implementation Allowed Values  Default Value 
org.eclipse.emf.cdo.server.internal.db.DBStore true true
org.eclipse.emf.cdo.server.internal.hibernate.HibernateStore false false
org.eclipse.emf.cdo.server.internal.objectivity.ObjectivityStore (to be done) false false

The shipped DB store does support audit views. Note also that it will not delete or update rows for modified objects if audits are supported. All revised state of the repository will be kept in the DB which can result in databases growing very large!

Property supportingRevisionDeltas

Specifies whether the repository will pass changed revisions to its store in the form of revision deltas (as received from the protocol layer) or as whole revisions. Allowed values as well as the default value are store implementation specific:

Store Implementation Allowed Values  Default Value 
org.eclipse.emf.cdo.server.internal.db.DBStore false false
org.eclipse.emf.cdo.server.internal.hibernate.HibernateStore false false
org.eclipse.emf.cdo.server.internal.objectivity.ObjectivityStore (to be done) true true


Property verifyingRevisions

Specifies whether the repository will verify cached revisions or not. Allowed values are:

  • true
  • false (default)

Verifying a cached revision means to verify if the underlying store has got a newer revision of the same object. This can only happen if the store data can be modified externally, that is without going through the repository.

Please note that a repository can be considerably slowed down if configured to verify all revisions!

Property currentLRUCapacity

Specifies the capacity of the fixed size cache for current revisions in the repository. A revision is called current if it is not revised.

Property revisedLRUCapacity

Specifies the capacity of the fixed size cache for revised revisions in the repository. A revision is called revised if one or more newer revisions of the same object do exist.

Element store

Defines an IStore instance. Please refer to CDO Storage Framework for details about stores, store readers and store writers.

The type attribute corresponds to the type of a store factory that is contributed via the org.eclipse.emf.cdo.server.storeFactory extension point. The remaining attributes depend on the specified type attribute value. The following values are possible with the shipped distribution (subject to user supplied extension):

  • noop: Store that does nothing. A repository with a noop store can function properly as long as the the server is not restarted and the internal caches do not run full so that revisions get evicted and discarded. No additional attributes are recognized.
  • db: Store that connects via JDBC to a relational database and manages persistent revisions and models through a built-in O/R mapper. A DB store element can contain the following nested elements:


Element mappingStrategy

This element is recognized by DB stores and defines the overall mapping strategy of the built-in O/R mapper.

The type attribute corresponds to the type of a mapping strategy factory that is contributed via the org.eclipse.emf.cdo.server.db.mappingStrategies extension point. The following values are possible with the shipped distribution (subject to user supplied extension):


Property toManyReferences

Specifies how the built-in O/R mapper will handle to-many references (collections). The following values are recognized:

  • ONE_TABLE_PER_REFERENCE: Each to-many reference of the model will get its own DB table.
  • ONE_TABLE_PER_CLASS: All to-many references of a model class will share a single DB table.
  • ONE_TABLE_PER_PACKAGE: All to-many references of a model package will share a single DB table.
  • ONE_TABLE_PER_REPOSITORY: All to-many references of all model classes i the repository will share a single DB table.
  • LIKE_ATTRIBUTES: Collections will be serialized to a BLOB column in the same DB table that the attributes of the containing model class are stored in. This option is currently not supported.


Property toOneReferences

Specifies how the built-in O/R mapper will handle to-one references. The following values are recognized:

  • LIKE_ATTRIBUTES: Single references will be stored in a CDOID column in the same DB table that the attributes of the containing model class are stored in. This option is the default option.
  • LIKE_TO_MANY_REFERENCES: Single references will be handled in the same way as specified for to-many references. This option is currently not supported.


Property maxTableNameLength

Enables you to override the default value of the chosen DB adapter for the maximum length of table names.

Property maxFieldNameLength

Enables you to override the default value of the chosen DB adapter for the maximum length of column names.

Property tableNamePrefix

Specifies a common fixed prefix for all table names generated by this mapping strategy.

Property qualifiedNames

Specifies whether generated package or class table names are qualified or not.

Property forceNamesWithID

Specifies whether generated names are always suffixed with an internal ID or only in cases where the generated name absolutely needs mangling.



Element dbAdapter

Defines the IDBAdapter instance of the store. Please refer to Net4j DB Framework for details about DB adapters and SQL dialects.

The type attribute corresponds to the name of a DB adapter factory that is contributed via the org.eclipse.net4j.db.dbAdapters extension point. No additional attributes are recognized.

The DB adapter must match the database specified in the dataSource element.

Element dataSource

Defines the DataSource instance of the store.

The class attribute corresponds to the fully qualified name of the data source class. Please refer to your DB manual for details about the supported data sources and their attributes.


Wikis: CDO Server | CDO | Net4j | EMF | Eclipse