org.modeshape.connector.git

Class GitConnector

java.lang.Object

org.modeshape.jcr.spi.federation.Connector

org.modeshape.jcr.spi.federation.ReadOnlyConnector

org.modeshape.connector.git.GitConnector

All Implemented Interfaces:

Pageable

public class GitConnector
extends ReadOnlyConnector
implements Pageable

A read-only Connector that accesses the content in a local Git repository that is a clone of a remote repository.

This connector has several properties that must be configured via the RepositoryConfiguration:

• directoryPath - The path to the folder that is or contains the .git data structure is to be accessed by this connector.
• remoteName - The alias used by the local Git repository for the remote repository. The default is the "origin". If the value contains commas, the value contains an ordered list of remote aliases that should be searched; the first one to match an existing remote will be used.
• queryableBranches - An array with the names of the branches that should be queryable by the repository. By default, only the master branch is queryable.

The connector results in the following structure:

Path	Description
/branches/{branchName}	The list of branches.
/tags/{tagName}	The list of tags.
/commits/{branchOrTagNameOrCommit}/{objectId}	The history of commits on the branch, tag or object ID name "{branchOrTagNameOrCommit}", where " {objectId}" is the object ID of the commit.
/commit/{branchOrTagNameOrCommit}	The information about a particular branch, tag or commit "{branchOrTagNameOrCommit}".
/tree/{branchOrTagOrObjectId}/{filesAndFolders}/...	The structure of the directories and files in the specified branch, tag or commit "{branchOrTagNameOrCommit}".

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.spi.federation.Connector

Connector.ExtraProperties

Field Summary

Fields inherited from class org.modeshape.jcr.spi.federation.Connector

DEFAULT_ROOT_ID

Constructor Summary

Constructors

Constructor and Description
GitConnector()

Method Summary

Modifier and Type	Method and Description
ExternalBinaryValue	getBinaryValue(String id)
Document	getChildReference(String parentKey, String childKey)
Document	getChildren(PageKey pageKey)
Document	getDocumentById(String id)
String	getDocumentId(String path)
Collection<String>	getDocumentPathsById(String id)
boolean	hasDocument(String id)
protected boolean	includeMimeType()
void	initialize(javax.jcr.NamespaceRegistry registry, NodeTypeManager nodeTypeManager)
protected DocumentWriter	newDocumentWriter(String id)
protected String	remoteName()
protected List<String>	remoteNames()
void	shutdown()

Methods inherited from class org.modeshape.jcr.spi.federation.ReadOnlyConnector

isReadonly, newDocumentId, removeDocument, storeDocument, updateDocument

Methods inherited from class org.modeshape.jcr.spi.federation.Connector

checkFieldNotNull, extraPropertiesFor, extraPropertiesStore, factories, getContext, getEnvironment, getLogger, getMimeTypeDetector, getRepositoryName, getRootDocumentId, getSourceName, getTransactionManager, isCacheable, isQueryable, log, moveExtraProperties, nameFrom, nameFrom, nameFrom, newChildReference, newConnectorChangedSet, newDocument, newPageDocument, pathFactory, pathFrom, pathFrom, propertyFactory, readDocument, setExtraPropertiesStore, translator, writeDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitConnector

public GitConnector()

Method Detail

initialize

public void initialize(javax.jcr.NamespaceRegistry registry,
                       NodeTypeManager nodeTypeManager)
                throws javax.jcr.RepositoryException,
                       IOException

Overrides:

initialize in class Connector

Throws:

javax.jcr.RepositoryException

IOException

newDocumentWriter

protected DocumentWriter newDocumentWriter(String id)

includeMimeType

protected boolean includeMimeType()

shutdown

public void shutdown()

Overrides:

shutdown in class Connector

getDocumentById

public Document getDocumentById(String id)

Specified by:

getDocumentById in class Connector

getChildren

public Document getChildren(PageKey pageKey)

Specified by:

getChildren in interface Pageable

getChildReference

public Document getChildReference(String parentKey,
                                  String childKey)

Overrides:

getChildReference in class Connector

getDocumentId

public String getDocumentId(String path)

Specified by:

getDocumentId in class Connector

getDocumentPathsById

public Collection<String> getDocumentPathsById(String id)

Specified by:

getDocumentPathsById in class Connector

hasDocument

public boolean hasDocument(String id)

Specified by:

hasDocument in class Connector

getBinaryValue

public ExternalBinaryValue getBinaryValue(String id)

Overrides:

getBinaryValue in class Connector

remoteName

protected final String remoteName()

remoteNames

protected final List<String> remoteNames()