de.shadowhunt.subversion

Interface Repository

All Known Implementing Classes:

AbstractBaseRepository

@ThreadSafe
public interface Repository

Interface listing all available operations on a subversion repository

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Repository.ProtocolVersion Repository.ProtocolVersion that represents the version of the subversion server

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	commit(Transaction transaction, String message) Save all modifications of the current running Transaction
void	copy(Transaction transaction, Resource srcResource, Revision srcRevision, Resource targetResource, boolean parents) Recursively copy a resource in the given revision
Transaction	createTransaction() Create a new Transaction to make modifications within
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
URI	getBaseUri() Returns the URI to the root of this Repository
Repository.ProtocolVersion	getProtocolVersion() Returns the Repository.ProtocolVersion of the server running this Repository
UUID	getRepositoryId() Returns the UUID that identifies the Repository globally
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 parents) 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)
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

Method Detail

add

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

Upload a new revision of the resource and set properties

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)

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

commit

void commit(Transaction transaction,
          @Nullable
          String message)
            throws SubversionException

Save all modifications of the current running Transaction

Parameters:

transaction - the current running Transaction

message - the commit message for the expected operation

Throws:

NullPointerException - if transaction is null

SubversionException - if an error occurs while operating on the repository

copy

void copy(Transaction transaction,
        Resource srcResource,
        Revision srcRevision,
        Resource targetResource,
        boolean parents)
          throws SubversionException

Recursively copy a resource in the given revision

Parameters:

transaction - the current running Transaction

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

srcRevision - 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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

createTransaction

Transaction createTransaction()
                              throws SubversionException

Create a new Transaction to make modifications within

Returns:

the new Transaction

Throws:

SubversionException - if an error occurs while operating on the repository

delete

void delete(Transaction transaction,
          Resource resource)
            throws SubversionException

Delete the resource from the repository

Parameters:

transaction - the current running Transaction

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

download

InputStream download(Resource resource,
                   Revision revision)
                     throws SubversionException

Download the resource

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)

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

downloadURI

URI downloadURI(Resource resource,
              Revision revision)
                throws SubversionException

Determine the HTTP download URI for the resource

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

exists

boolean exists(Resource resource,
             Revision revision)
               throws SubversionException

Check if the resource already exists in the latest revision of the 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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

getBaseUri

URI getBaseUri()

Returns the URI to the root of this Repository

Returns:

the URI to the root of this Repository

getProtocolVersion

Repository.ProtocolVersion getProtocolVersion()

Returns the Repository.ProtocolVersion of the server running this Repository

Returns:

the Repository.ProtocolVersion of the server running this Repository

getRepositoryId

UUID getRepositoryId()

Returns the UUID that identifies the Repository globally

Returns:

the UUID that identifies the Repository globally

info

Info info(Resource resource,
        Revision revision)
          throws SubversionException

Retrieve information for the resource

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

list

Set<Info> list(Resource resource,
             Revision revision,
             Depth depth)
               throws SubversionException

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

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)

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

lock

void lock(Resource resource,
        boolean steal)
          throws SubversionException

Mark the expected revision of the resource as locked

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

Throws:

NullPointerException - if resource is null

SubversionException - if an error occurs while operating on the repository

log

List<Log> log(Resource resource,
            Revision startRevision,
            Revision endRevision,
            int limit)
              throws SubversionException

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

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

mkdir

void mkdir(Transaction transaction,
         Resource resource,
         boolean parents)
           throws SubversionException

Create a folder with all necessary parents folders

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

move

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

Recursively move a resource (latest revision)

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

Throws:

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

propertiesDelete

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

Remove the given properties form the resource

Parameters:

transaction - the current running Transaction

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

properties - ResourceProperty to remove

Throws:

IllegalArgumentException - if properties contain null elements

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

propertiesSet

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

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

Parameters:

transaction - the current running Transaction

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

properties - ResourceProperty to add or override

Throws:

IllegalArgumentException - if properties contain null elements

NullPointerException - if any parameter is null

SubversionException - if an error occurs while operating on the repository

rollback

void rollback(Transaction transaction)
              throws SubversionException

Abort the current running Transaction and revert all modifications

Parameters:

transaction - the current running Transaction

Throws:

NullPointerException - if transaction is null

SubversionException - if an error occurs while operating on the repository

unlock

void unlock(Resource resource,
          boolean force)
            throws SubversionException

Remove the lock on the expected revision of the resource

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

Throws:

NullPointerException - if resource is null

SubversionException - if an error occurs while operating on the repository