de.shadowhunt.subversion.internal

Class AbstractBaseRepository

java.lang.Object

de.shadowhunt.subversion.internal.AbstractBaseRepository

All Implemented Interfaces:

Repository

public abstract class AbstractBaseRepository
extends Object
implements Repository

Base for all Repository

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractBaseRepository.ResourceMapper

Nested classes/interfaces inherited from interface de.shadowhunt.subversion.Repository

Repository.ProtocolVersion

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	client
protected AbstractBaseRepository.ResourceMapper	config
protected org.apache.http.protocol.HttpContext	context
protected URI	repository

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBaseRepository(URI repository, AbstractBaseRepository.ResourceMapper config, org.apache.http.client.HttpClient client, org.apache.http.protocol.HttpContext context)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Transaction transaction, Resource resource, boolean parents, InputStream content) Upload a new revision of the resource and set properties
void	copy(Transaction transaction, Resource sourceResource, Revision sourceRevision, Resource targetResource, boolean parents) Recursively copy a resource in the given revision
void	delete(Transaction transaction, Resource resource) Delete the resource from the repository
InputStream	download(Resource resource, Revision revision) Download the resource
URI	downloadURI(Resource resource, Revision revision) Determine the HTTP download URI for the resource
boolean	exists(Resource resource, Revision revision) Check if the resource already exists in the latest revision of the repository
protected static RepositoryCache	fromTransaction(Transaction transaction)
URI	getBaseUri() Returns the URI to the root of this Repository
protected Set<Info>	getInfosWithLockTokens(Transaction transaction)
UUID	getRepositoryId() Returns the UUID that identifies the Repository globally
protected de.shadowhunt.subversion.internal.VersionParser	getVersionParser()
Info	info(Resource resource, Revision revision) Retrieve information for the resource
Set<Info>	list(Resource resource, Revision revision, Depth depth) Retrieve information for the resource in the given revision and its child resources (depending on depth parameter)
void	lock(Resource resource, boolean steal) Mark the expected revision of the resource as locked
List<Log>	log(Resource resource, Revision startRevision, Revision endRevision, int limit) Retrieve the log information for the revisions between startRevision and endRevision of the resource
void	mkdir(Transaction transaction, Resource resource, boolean parent) Create a folder with all necessary parents folders
void	move(Transaction transaction, Resource srcResource, Resource targetResource, boolean parents) Recursively move a resource (latest revision)
void	propertiesDelete(Transaction transaction, Resource resource, ResourceProperty... properties) Remove the given properties form the resource
void	propertiesSet(Transaction transaction, Resource resource, ResourceProperty... properties) Set the given properties for the resource (new properties will be added, existing properties will be overridden)
protected abstract void	registerResource(Transaction transaction, Resource resource, Revision revision)
void	rollback(Transaction transaction) Abort the current running Transaction and revert all modifications
void	unlock(Resource resource, boolean force) Remove the lock on the expected revision of the resource
protected void	validateTransaction(Transaction transaction)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.shadowhunt.subversion.Repository

commit, createTransaction, getProtocolVersion

Field Detail

client

protected final org.apache.http.client.HttpClient client

config

protected final AbstractBaseRepository.ResourceMapper config

context

protected final org.apache.http.protocol.HttpContext context

repository

protected final URI repository

Constructor Detail

AbstractBaseRepository

protected AbstractBaseRepository(URI repository,
                      AbstractBaseRepository.ResourceMapper config,
                      org.apache.http.client.HttpClient client,
                      org.apache.http.protocol.HttpContext context)

Method Detail

fromTransaction

protected static RepositoryCache fromTransaction(Transaction transaction)

add

public void add(Transaction transaction,
       Resource resource,
       boolean parents,
       InputStream content)

Description copied from interface: Repository

Upload a new revision of the resource and set properties

Specified by:

add in interface Repository

Parameters:

transaction - the current running Transaction

resource - the Resource of the resource (relative to the repository root)

parents - whether to create missing parents folders or not

content - InputStream from which the content will be read (will be closed after transfer)

copy

public void copy(Transaction transaction,
        Resource sourceResource,
        Revision sourceRevision,
        Resource targetResource,
        boolean parents)

Description copied from interface: Repository

Recursively copy a resource in the given revision

Specified by:

copy in interface Repository

Parameters:

transaction - the current running Transaction

sourceResource - the Resource of the source resource (relative to the repository root)

sourceRevision - Revision of the resource to copy

targetResource - the Resource of the target resource (relative to the repository root)

parents - whether to create missing parents folders or not

delete

public void delete(Transaction transaction,
          Resource resource)

Description copied from interface: Repository

Delete the resource from the repository

Specified by:

delete in interface Repository

Parameters:

transaction - the current running Transaction

resource - the Resource of the resource (relative to the repository root)

download

public final InputStream download(Resource resource,
                   Revision revision)

Description copied from interface: Repository

Download the resource

Specified by:

download in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

revision - the Revision of the resource to retrieve

Returns:

InputStream from which the content can be read (caller has to close the stream properly)

downloadURI

public final URI downloadURI(Resource resource,
              Revision revision)

Description copied from interface: Repository

Determine the HTTP download URI for the resource

Specified by:

downloadURI in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

revision - the Revision of the resource to retrieve

Returns:

the HTTP download URI for the resource

exists

public final boolean exists(Resource resource,
             Revision revision)

Description copied from interface: Repository

Check if the resource already exists in the latest revision of the repository

Specified by:

exists in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

revision - the Revision of the resource to retrieve

Returns:

true if the resource already exists in the latest revision of the repository otherwise false

getBaseUri

public final URI getBaseUri()

Description copied from interface: Repository

Returns the URI to the root of this Repository

Specified by:

getBaseUri in interface Repository

Returns:

the URI to the root of this Repository

getInfosWithLockTokens

protected Set<Info> getInfosWithLockTokens(Transaction transaction)

getRepositoryId

public final UUID getRepositoryId()

Description copied from interface: Repository

Returns the UUID that identifies the Repository globally

Specified by:

getRepositoryId in interface Repository

Returns:

the UUID that identifies the Repository globally

getVersionParser

protected de.shadowhunt.subversion.internal.VersionParser getVersionParser()

info

public final Info info(Resource resource,
        Revision revision)

Description copied from interface: Repository

Retrieve information for the resource

Specified by:

info in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

revision - the Revision of the resource to retrieve

Returns:

Info for the resource

list

public final Set<Info> list(Resource resource,
             Revision revision,
             Depth depth)

Description copied from interface: Repository

Retrieve information for the resource in the given revision and its child resources (depending on depth parameter)

Specified by:

list in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

revision - the Revision of the resource to retrieve

depth - whether to retrieve only for the given resource, its children or only part of its children depending on the value of Depth

Returns:

Set of Info for the resource and its child resources (depending on depth parameter)

lock

public final void lock(Resource resource,
        boolean steal)

Description copied from interface: Repository

Mark the expected revision of the resource as locked

Specified by:

lock in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

steal - if the resource is locked by another user true will override the lock, otherwise the operation will fail

log

public final List<Log> log(Resource resource,
            Revision startRevision,
            Revision endRevision,
            int limit)

Description copied from interface: Repository

Retrieve the log information for the revisions between startRevision and endRevision of the resource

Specified by:

log in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

startRevision - the first Revision of the resource to retrieve (including)

endRevision - the last Revision of the resource to retrieve (including)

limit - maximal number of Log entries, if the value is lower or equal to 0 all entries will be returned

Returns:

ordered (early to latest) List of Log for the revisions between startRevision and endRevision of the resource

mkdir

public void mkdir(Transaction transaction,
         Resource resource,
         boolean parent)

Description copied from interface: Repository

Create a folder with all necessary parents folders

Specified by:

mkdir in interface Repository

Parameters:

transaction - the current running Transaction

resource - the Resource of the resource (relative to the repository root)

parent - whether to create missing parents folders or not

move

public void move(Transaction transaction,
        Resource srcResource,
        Resource targetResource,
        boolean parents)

Description copied from interface: Repository

Recursively move a resource (latest revision)

Specified by:

move in interface Repository

Parameters:

transaction - the current running Transaction

srcResource - the Resource of the source resource (relative to the repository root)

targetResource - the Resource of the target resource (relative to the repository root)

parents - whether to create missing parents folders or not

propertiesDelete

public void propertiesDelete(Transaction transaction,
                    Resource resource,
                    ResourceProperty... properties)

Description copied from interface: Repository

Remove the given properties form the resource

Specified by:

propertiesDelete in interface Repository

Parameters:

transaction - the current running Transaction

resource - the Resource of the resource (relative to the repository root)

properties - ResourceProperty to remove

propertiesSet

public void propertiesSet(Transaction transaction,
                 Resource resource,
                 ResourceProperty... properties)

Description copied from interface: Repository

Set the given properties for the resource (new properties will be added, existing properties will be overridden)

Specified by:

propertiesSet in interface Repository

Parameters:

transaction - the current running Transaction

resource - the Resource of the resource (relative to the repository root)

properties - ResourceProperty to add or override

registerResource

protected abstract void registerResource(Transaction transaction,
                    Resource resource,
                    Revision revision)

rollback

public void rollback(Transaction transaction)

Description copied from interface: Repository

Abort the current running Transaction and revert all modifications

Specified by:

rollback in interface Repository

Parameters:

transaction - the current running Transaction

unlock

public final void unlock(Resource resource,
          boolean force)

Description copied from interface: Repository

Remove the lock on the expected revision of the resource

Specified by:

unlock in interface Repository

Parameters:

resource - the Resource of the resource (relative to the repository root)

force - the user that created the lock must match the user who wants to delete it, unless force is true

validateTransaction

protected void validateTransaction(Transaction transaction)