net.shibboleth.ext.spring.resource

Class SVNRunnable

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.resource.SVNRunnable

All Implemented Interfaces:

Runnable, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class SVNRunnable
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements Runnable, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Implementation of a Runnable that communications with a Subversion server (via a spool directory).

Field Summary

Fields

Modifier and Type	Field and Description
private org.tmatesoft.svn.core.wc.SVNClientManager	clientManager SVN Client manager.
private Logger	log Class logger.
private org.tmatesoft.svn.core.SVNURL	remoteRepository URL to the remote repository.
private org.tmatesoft.svn.core.wc.SVNRevision	retrievalRevision Revision of the working copy.
private File	workingCopyDirectory Directory where the working copy will be kept.

Constructor Summary

Constructors

Constructor and Description
SVNRunnable(org.tmatesoft.svn.core.wc.SVNClientManager svnClientMgr, org.tmatesoft.svn.core.SVNURL repositoryUrl, File workingCopy, long workingRevision) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	checkoutOrUpdate() Checks out the resource specified by the remoteRepository in to the working copy workingCopyDirectory.
private org.tmatesoft.svn.core.wc.SVNRevision	checkoutResourceDirectory() Fetches the content from the SVN repository and creates the local working copy.
protected void	checkWorkingCopyDirectory(File directory) Checks that the given file exists, or can be created, is a directory, and is read/writable by this process.
protected String	getProtocol() Helper function to generate the full path for injecting into URLs and URIs.
void	run()
void	setBeanName(String name)
private void	updateResourceDirectory() Updates an existing local working copy from the repository.
private boolean	workingCopyDirectoryExists() Checks to see if the working copy directory exists.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId, setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

log

private final Logger log

Class logger.

clientManager

@Nonnull
private final org.tmatesoft.svn.core.wc.SVNClientManager clientManager

SVN Client manager.

remoteRepository

@Nonnull
private org.tmatesoft.svn.core.SVNURL remoteRepository

URL to the remote repository.

workingCopyDirectory

@Nonnull
private File workingCopyDirectory

Directory where the working copy will be kept.

retrievalRevision

private org.tmatesoft.svn.core.wc.SVNRevision retrievalRevision

Revision of the working copy.

Constructor Detail

SVNRunnable

public SVNRunnable(@Nonnull@ParameterName(name="svnClientMgr")
           org.tmatesoft.svn.core.wc.SVNClientManager svnClientMgr,
           @Nonnull@ParameterName(name="repositoryUrl")
           org.tmatesoft.svn.core.SVNURL repositoryUrl,
           @Nonnull@ParameterName(name="workingCopy")
           File workingCopy,
           @ParameterName(name="workingRevision")
           long workingRevision)

Constructor.

Parameters:

svnClientMgr - manager used to create SVN clients

repositoryUrl - URL of the remote repository

workingCopy - directory that will serve as the root of the local working copy

workingRevision - revision of the resource to retrieve or -1 for HEAD revision

Throws:

org.springframework.beans.factory.BeanCreationException - thrown if there is a problem initializing the SVN resource

Method Detail

getProtocol

protected String getProtocol()

Helper function to generate the full path for injecting into URLs and URIs.

Returns:

the directory path (from svn) pus the file. protected String getFullPath() { final StringBuffer buffer = new StringBuffer(remoteRepository.getPath().length() + 1 + getFilename().length()); buffer.append(remoteRepository.getPath()).append('/').append(getFilename()); return buffer.toString(); } /** Helper function to return a complex scheme - a conjunction of 'svn' and the underlying protocol.

checkWorkingCopyDirectory

protected void checkWorkingCopyDirectory(@Nonnull
                             File directory)
                                  throws IOException

Checks that the given file exists, or can be created, is a directory, and is read/writable by this process.

Parameters:

directory - the directory to check

Throws:

IOException - thrown if the file is invalid

checkoutOrUpdate

protected void checkoutOrUpdate()
                         throws IOException

Checks out the resource specified by the remoteRepository in to the working copy workingCopyDirectory. If the working copy is empty than an SVN checkout is performed if the working copy already exists then an SVN update is performed.

Throws:

IOException - thrown if there is a problem communicating with the remote repository, the revision does not exist, or the working copy is unusable

workingCopyDirectoryExists

private boolean workingCopyDirectoryExists()

Checks to see if the working copy directory exists.

Returns:

true if the working copy directory exists, false otherwise

checkoutResourceDirectory

private org.tmatesoft.svn.core.wc.SVNRevision checkoutResourceDirectory()
                                                                 throws IOException

Fetches the content from the SVN repository and creates the local working copy.

Returns:

the revision of the fetched content

Throws:

IOException - thrown if there is a problem checking out the content from the repository

updateResourceDirectory

private void updateResourceDirectory()
                              throws IOException

Updates an existing local working copy from the repository.

Throws:

IOException - thrown if there is a problem updating the working copy

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

run

public void run()

Specified by:

run in interface Runnable