Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.modeshape.connector.svn
Class SvnRepositorySource

    java.lang.Object
      org.modeshape.graph.connector.base.AbstractRepositorySource
          org.modeshape.graph.connector.base.AbstractNodeCachingRepositorySource<Path,PathNode>
              org.modeshape.connector.svn.SvnRepositorySource

All Implemented Interfaces:
  Serializable, Referenceable, ObjectFactory, BaseRepositorySource, RepositorySource

    @ThreadSafe
    public class SvnRepositorySource

extends AbstractNodeCachingRepositorySource<Path,PathNode>
implements ObjectFactory

The `RepositorySource` for the connector that exposes an area of the local/remote svn repository as content in a repository. This source considers a workspace name to be the path to the directory on the repository's root directory location that represents the root of that workspace. New workspaces can be created, as long as the names represent valid paths to existing directories.

See Also:
  Serialized Form

Field Summary
`protected static String` | `ALLOW_CREATING_WORKSPACES`
`protected static String` | `CACHE_POLICY`
`protected static boolean` | `DEFAULT_SUPPORTS_CREATING_WORKSPACES` This source does support creating workspaces.
`static boolean` | `DEFAULT_SUPPORTS_UPDATES` This source supports udpates by default, but each instance may be configured to be read-only or updateable}.
`protected static String` | `DEFAULT_WORKSPACE`
`static String` | `DEFAULT_WORKSPACE_NAME` The default name of the `defaultWorkspace` property.
`protected static String` | `PREDEFINED_WORKSPACE_NAMES`
`protected static String` | `RETRY_LIMIT`
`protected static String` | `ROOT_NODE_UUID`
`protected static String` | `SOURCE_NAME`
`protected static boolean` | `SUPPORTS_EVENTS` This source supports events.
`protected static boolean` | `SUPPORTS_REFERENCES` This source supports creating references.
`protected static boolean` | `SUPPORTS_SAME_NAME_SIBLINGS` This source supports same-name-siblings.
`protected static String` | `SVN_PASSWORD`
`protected static String` | `SVN_REPOSITORY_ROOT_URL`
`protected static String` | `SVN_USERNAME`

Fields inherited from class org.modeshape.graph.connector.base.AbstractNodeCachingRepositorySource
`DEFAULT_NODE_CACHE_POLICY, NODE_CACHE_POLICY`

Fields inherited from class org.modeshape.graph.connector.base.AbstractRepositorySource
`cachePolicy, DEFAULT_CACHE_POLICY, DEFAULT_RETRY_LIMIT, DEFAULT_ROOT_NODE_UUID, repositoryContext, retryLimit, rootNodeUuid`

Constructor Summary
`SvnRepositorySource()` Create a repository source instance.

Method Summary
`boolean` | `areUpdatesAllowed()` Get whether this source allows updates.
`boolean` | `equals(Object obj)`
`RepositorySourceCapabilities` | `getCapabilities()` Get the capabilities for this source.
`RepositoryConnection` | `getConnection()` Get a connection from this source.
`String` | `getDefaultWorkspaceName()` Get the path to the existing directory that should be used for the default workspace.
`Object` | `getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment)`
`String` | `getPassword()`
`String[]` | `getPredefinedWorkspaceNames()` Gets the names of the workspaces that are available when this source is created.
`Reference` | `getReference()`
`String` | `getRepositoryRootUrl()`
`boolean` | `getSupportsUpdates()` Get whether this source supports updates.
`String` | `getUsername()`
`int` | `hashCode()`
`boolean` | `isCreatingWorkspacesAllowed()` Get whether this source allows workspaces to be created dynamically.
`void` | `setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)` Set whether this source allows workspaces to be created dynamically.
`void` | `setDefaultWorkspaceName(String pathToDirectoryForDefaultWorkspace)` Set the file system path to the existing directory that should be used for the default workspace.
`void` | `setPassword(String password)`
`void` | `setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)` Sets the names of the workspaces that are available when this source is created.
`void` | `setRepositoryRootUrl(String url)` Set the url for the subversion repository.
`void` | `setUpdatesAllowed(boolean allowUpdates)` Set whether this source allows updates to data within workspaces
`void` | `setUsername(String username)`

Methods inherited from class org.modeshape.graph.connector.base.AbstractNodeCachingRepositorySource
`addNodeCachePolicyChangedListener, addNodeCachePolicyReference, getNodeCachePolicy, removeNodeCachePolicyChangedListener, setNodeCachePolicy`

Methods inherited from class org.modeshape.graph.connector.base.AbstractRepositorySource
`close, getDefaultCachePolicy, getName, getRepositoryContext, getRetryLimit, getRootNodeUuid, getRootNodeUuidObject, initialize, setCachePolicy, setName, setRetryLimit, setRootNodeUuid, setRootNodeUuidObject, valuesFrom`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### SOURCE_NAME

    protected static final String SOURCE_NAME

See Also:
  Constant Field Values

### CACHE_POLICY

    protected static final String CACHE_POLICY

See Also:
  Constant Field Values

### SVN_REPOSITORY_ROOT_URL

    protected static final String SVN_REPOSITORY_ROOT_URL

See Also:
  Constant Field Values

### SVN_USERNAME

    protected static final String SVN_USERNAME

See Also:
  Constant Field Values

### SVN_PASSWORD

    protected static final String SVN_PASSWORD

See Also:
  Constant Field Values

### RETRY_LIMIT

    protected static final String RETRY_LIMIT

See Also:
  Constant Field Values

### ROOT_NODE_UUID

    protected static final String ROOT_NODE_UUID

See Also:
  Constant Field Values

### DEFAULT_WORKSPACE

    protected static final String DEFAULT_WORKSPACE

See Also:
  Constant Field Values

### PREDEFINED_WORKSPACE_NAMES

    protected static final String PREDEFINED_WORKSPACE_NAMES

See Also:
  Constant Field Values

### ALLOW_CREATING_WORKSPACES

    protected static final String ALLOW_CREATING_WORKSPACES

See Also:
  Constant Field Values

### SUPPORTS_EVENTS

    protected static final boolean SUPPORTS_EVENTS

  This source supports events.

  See Also:
    Constant Field Values

### SUPPORTS_SAME_NAME_SIBLINGS

    protected static final boolean SUPPORTS_SAME_NAME_SIBLINGS

  This source supports same-name-siblings.

  See Also:
    Constant Field Values

### DEFAULT_SUPPORTS_CREATING_WORKSPACES

    protected static final boolean DEFAULT_SUPPORTS_CREATING_WORKSPACES

  This source does support creating workspaces.

  See Also:
    Constant Field Values

### DEFAULT_SUPPORTS_UPDATES

    public static final boolean DEFAULT_SUPPORTS_UPDATES

  This source supports udpates by default, but each instance may be configured to be read-only or updateable}.

  See Also:
    Constant Field Values

### DEFAULT_WORKSPACE_NAME

    public static final String DEFAULT_WORKSPACE_NAME

  The default name of the `defaultWorkspace` property.

  See Also:
    Constant Field Values

### SUPPORTS_REFERENCES

    protected static final boolean SUPPORTS_REFERENCES

  This source supports creating references.

  See Also:
    Constant Field Values

Constructor Detail

### SvnRepositorySource

    public SvnRepositorySource()

  Create a repository source instance.

Method Detail

### getCapabilities

    public RepositorySourceCapabilities getCapabilities()

  Get the capabilities for this source.

  Specified by:
    `getCapabilities` in interface `RepositorySource`
  Returns:
    the capabilities for this source; never null
  See Also:
    `RepositorySource.getCapabilities()`

### getRepositoryRootUrl

    public String getRepositoryRootUrl()

  Returns:
    the url

### setRepositoryRootUrl

    public void setRepositoryRootUrl(String url)

  Set the url for the subversion repository.

  Parameters:
    `url` - - the url location.
  Throws:
    `IllegalArgumentException` - If svn url is null or empty

### getUsername

    public String getUsername()

### setUsername

    public void setUsername(String username)

  Parameters:
    `username` -

### getPassword

    public String getPassword()

### setPassword

    public void setPassword(String password)

  Parameters:
    `password` -

### getSupportsUpdates

    @Description(i18n=SvnRepositoryConnectorI18n.class,
                 value="updatesAllowedPropertyDescription")
    @Label(i18n=SvnRepositoryConnectorI18n.class,
           value="updatesAllowedPropertyLabel")
    @Category(i18n=SvnRepositoryConnectorI18n.class,
              value="updatesAllowedPropertyCategory")
    @ReadOnly
    public boolean getSupportsUpdates()

  Get whether this source supports updates.

  Returns:
    true if this source supports updates, or false if this source only supports reading content.

### getDefaultWorkspaceName

    public String getDefaultWorkspaceName()

  Get the path to the existing directory that should be used for the default workspace. This path should be relative to the `repository root URL`. If the default is specified as a null String or is not a valid and resolvable path, this source will consider the default to be the current working directory of this virtual machine, as defined by the `new File(".")`.

  Specified by:
    `getDefaultWorkspaceName` in interface `BaseRepositorySource`
  Returns:
    the file system path to the directory representing the default workspace, or null if the default should be the current working directory

### setDefaultWorkspaceName

    public void setDefaultWorkspaceName(String pathToDirectoryForDefaultWorkspace)

  Set the file system path to the existing directory that should be used for the default workspace. This path should be relative to the `repository root URL`. If the default is specified as a null String or is not a valid and resolvable path, this source will consider the default to be the current working directory of this virtual machine, as defined by the `new File(".")`.

  Parameters:
    `pathToDirectoryForDefaultWorkspace` - the valid and resolvable file system path to the directory representing the default workspace, or null if the current working directory should be used as the default workspace

### getPredefinedWorkspaceNames

    public String[] getPredefinedWorkspaceNames()

  Gets the names of the workspaces that are available when this source is created. Each workspace name corresponds to a path to a directory on the file system.

  Returns:
    the names of the workspaces that this source starts with, or null if there are no such workspaces
  See Also:
    `setPredefinedWorkspaceNames(String[])`, `setCreatingWorkspacesAllowed(boolean)`

### setPredefinedWorkspaceNames

    public void setPredefinedWorkspaceNames(String[] predefinedWorkspaceNames)

  Sets the names of the workspaces that are available when this source is created. Each workspace name corresponds to a path to a directory on the file system.

  Parameters:
    `predefinedWorkspaceNames` - the names of the workspaces that this source should start with, or null if there are no such workspaces
  See Also:
    `setCreatingWorkspacesAllowed(boolean)`, `getPredefinedWorkspaceNames()`

### isCreatingWorkspacesAllowed

    @Description(i18n=SvnRepositoryConnectorI18n.class,
                 value="creatingWorkspacesAllowedPropertyDescription")
    @Label(i18n=SvnRepositoryConnectorI18n.class,
           value="creatingWorkspacesAllowedPropertyLabel")
    @Category(i18n=SvnRepositoryConnectorI18n.class,
              value="creatingWorkspacesAllowedPropertyCategory")
    public boolean isCreatingWorkspacesAllowed()

  Get whether this source allows workspaces to be created dynamically.

  Specified by:
    `isCreatingWorkspacesAllowed` in interface `BaseRepositorySource`
  Overrides:
    `isCreatingWorkspacesAllowed` in class `AbstractRepositorySource`
  Returns:
    true if this source allows workspaces to be created by clients, or false if the set of workspaces is fixed
  See Also:
    `setPredefinedWorkspaceNames(String[])`, `getPredefinedWorkspaceNames()`, `setCreatingWorkspacesAllowed(boolean)`

### setCreatingWorkspacesAllowed

    public void setCreatingWorkspacesAllowed(boolean allowWorkspaceCreation)

  Set whether this source allows workspaces to be created dynamically.

  Parameters:
    `allowWorkspaceCreation` - true if this source allows workspaces to be created by clients, or false if the set of workspaces is fixed
  See Also:
    `setPredefinedWorkspaceNames(String[])`, `getPredefinedWorkspaceNames()`, `isCreatingWorkspacesAllowed()`

### areUpdatesAllowed

    @Description(i18n=SvnRepositoryConnectorI18n.class,
                 value="updatesAllowedPropertyDescription")
    @Label(i18n=SvnRepositoryConnectorI18n.class,
           value="updatesAllowedPropertyLabel")
    @Category(i18n=SvnRepositoryConnectorI18n.class,
              value="updatesAllowedPropertyCategory")
    public boolean areUpdatesAllowed()

  Get whether this source allows updates.

  Specified by:
    `areUpdatesAllowed` in interface `BaseRepositorySource`
  Overrides:
    `areUpdatesAllowed` in class `AbstractRepositorySource`
  Returns:
    true if this source allows updates by clients, or false if no updates are allowed
  See Also:
    `setUpdatesAllowed(boolean)`

### setUpdatesAllowed

    public void setUpdatesAllowed(boolean allowUpdates)

  Set whether this source allows updates to data within workspaces

  Specified by:
    `setUpdatesAllowed` in interface `BaseRepositorySource`
  Parameters:
    `allowUpdates` - true if this source allows updates to data within workspaces clients, or false if updates are not allowed.
  See Also:
    `areUpdatesAllowed()`

### equals

    public boolean equals(Object obj)

  Overrides:
    `equals` in class `Object`

### hashCode

    public int hashCode()

  Overrides:
    `hashCode` in class `Object`

### getReference

    public Reference getReference()

  Specified by:
    `getReference` in interface `Referenceable`
  See Also:
    `Referenceable.getReference()`

### getObjectInstance

    public Object getObjectInstance(Object obj,
                                    Name name,
                                    Context nameCtx,
                                    Hashtable<?,?> environment)
                             throws Exception

  Specified by:
    `getObjectInstance` in interface `ObjectFactory`
  Throws:
    `Exception`
  See Also:
    `ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)`

### getConnection

    public RepositoryConnection getConnection()
                                       throws RepositorySourceException

  Get a connection from this source. Even though each RepositorySource need not be thread safe, this method should be safe to be called concurrently by multiple threads.

  Specified by:
    `getConnection` in interface `RepositorySource`
  Returns:
    a connection
  Throws:
    `RepositorySourceException` - if there is a problem obtaining a connection
  See Also:
    `RepositorySource.getConnection()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2012 JBoss, a division of Red Hat. All Rights Reserved.