org.eclipse.emf.cdo.common

## Interface CDOCommonRepository

- All Superinterfaces:
    CDOTimeProvider, IAdaptable
  All Known Subinterfaces:
    CDOAdminClientRepository, CDOAdminRepository, CDORepositoryInfo, InternalFailoverParticipant, InternalRepository, InternalSynchronizableRepository, IRepository, ISynchronizableRepository
  All Known Implementing Classes:
    CDOSessionProtocol.OpenSessionResult

      public interface CDOCommonRepository
      extends CDOTimeProvider, IAdaptable

  Abstracts the information about CDO repositories that is common to both client and server side.

  A CDOCommonRepository can fire the following events:

  - `CDOCommonRepository.TypeChangedEvent` after the `repository type` has changed in a fail-over cluster.
  - `CDOCommonRepository.StateChangedEvent` after the `repository state` has changed in a replicating deployment.
  Since:
    3.0
  Author:
    Eike Stepper
  No Implement
    This interface is not intended to be implemented by clients.
  No Extend
    This interface is not intended to be extended by clients.
  Apiviz
  Apiviz
    `CDOCommonRepository.IDGenerationLocation`, `CDOCommonRepository.Type`, `CDOCommonRepository.State`
  Apiviz
    `CDOCommonRepository.TypeChangedEvent` - - fires, `CDOCommonRepository.StateChangedEvent` - - fires

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `CDOCommonRepository.CommitInfoStorage` Enumerates the possible `ID generation locations` of a CDO repository.
    `static class` | `CDOCommonRepository.IDGenerationLocation` Enumerates the possible `ID generation locations` of a CDO repository.
    `static class` | `CDOCommonRepository.State` Enumerates the possible `states` of a CDO repository.
    `static interface` | `CDOCommonRepository.StateChangedEvent` An `event` fired when the `state` of a CDO repository has changed.
    `static class` | `CDOCommonRepository.Type` Enumerates the possible `types` of a CDO repository.
    `static interface` | `CDOCommonRepository.TypeChangedEvent` An `event` fired when the `type` of a CDO repository has changed.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `CDOCommonRepository.CommitInfoStorage` | `getCommitInfoStorage()`
    `long` | `getCreationTime()` Returns the creation time of this repository.
    `CDOCommonRepository.IDGenerationLocation` | `getIDGenerationLocation()`
    `String` | `getName()` Returns the name of this repository.
    `Set<CDOID.ObjectType>` | `getObjectIDTypes()` Returns the type of CDOIDs created by the store of this repository.
    `CDOID` | `getRootResourceID()` Returns the ID of the root resource of this repository.
    `CDOCommonRepository.State` | `getState()` Returns the state of this repository.
    `String` | `getStoreType()` Returns the type of the store of this repository.
    `CDOCommonRepository.Type` | `getType()` Returns the type of this repository.
    `String` | `getUUID()` Returns the UUID of this repository.
    `boolean` | `isAuthenticating()` Returns `true` if this repository requires user authentication, `false` otherwise.
    `boolean` | `isEnsuringReferentialIntegrity()` Returns `true` if this repository ensures referential integrity, `false` otherwise.
    `boolean` | `isSerializingCommits()` Returns `true` if this repository serializes commits, `false` otherwise.
    `boolean` | `isSupportingAudits()` Returns `true` if this repository supports auditing, `false` otherwise.
    `boolean` | `isSupportingBranches()` Returns `true` if this repository supports branching, `false` otherwise.
    `boolean` | `isSupportingEcore()` Deprecated. As of 4.2 instances of Ecore are always supported (on demand).
    `boolean` | `isSupportingUnits()` Returns `true` if this repository supports units, `false` otherwise.
    `boolean` | `waitWhileInitial(IProgressMonitor monitor)`

    - ### Methods inherited from interface org.eclipse.emf.cdo.common.util.CDOTimeProvider

      `getTimeStamp`

    - ### Methods inherited from interface org.eclipse.core.runtime.IAdaptable

      `getAdapter`

- - ### Method Detail

    - #### getName

          String getName()

      Returns the name of this repository.

    - #### getUUID

          String getUUID()

      Returns the UUID of this repository.

    - #### getType

          CDOCommonRepository.Type getType()

      Returns the type of this repository.

    - #### getState

          CDOCommonRepository.State getState()

      Returns the state of this repository.

    - #### getCreationTime

          long getCreationTime()

      Returns the creation time of this repository.

    - #### getStoreType

          String getStoreType()

      Returns the type of the store of this repository.

    - #### getObjectIDTypes

          Set<CDOID.ObjectType> getObjectIDTypes()

      Returns the type of CDOIDs created by the store of this repository.

    - #### getIDGenerationLocation

          CDOCommonRepository.IDGenerationLocation getIDGenerationLocation()

      Since:
        4.1

    - #### getCommitInfoStorage

          CDOCommonRepository.CommitInfoStorage getCommitInfoStorage()

      Since:
        4.6

    - #### getRootResourceID

          CDOID getRootResourceID()

      Returns the ID of the root resource of this repository.

    - #### isAuthenticating

          boolean isAuthenticating()

      Returns `true` if this repository requires user authentication, `false` otherwise.
      Since:
        4.4

    - #### isSupportingAudits

          boolean isSupportingAudits()

      Returns `true` if this repository supports auditing, `false` otherwise.

    - #### isSupportingBranches

          boolean isSupportingBranches()

      Returns `true` if this repository supports branching, `false` otherwise.

    - #### isSupportingUnits

          boolean isSupportingUnits()

      Returns `true` if this repository supports units, `false` otherwise.
      Since:
        4.5

    - #### isSupportingEcore

          @Deprecated
          boolean isSupportingEcore()

      Deprecated. As of 4.2 instances of Ecore are always supported (on demand).
      Returns `true` if this repository supports instances of Ecore, `false` otherwise.
      Since:
        4.0

    - #### isSerializingCommits

          boolean isSerializingCommits()

      Returns `true` if this repository serializes commits, `false` otherwise.
      Since:
        4.2

    - #### isEnsuringReferentialIntegrity

          boolean isEnsuringReferentialIntegrity()

      Returns `true` if this repository ensures referential integrity, `false` otherwise.
      Since:
        4.0

    - #### waitWhileInitial

          boolean waitWhileInitial(IProgressMonitor monitor)

      Since:
        4.2

Copyright (c) 2014 Eike Stepper (Berlin, Germany) and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html