net.shibboleth.ext.spring.resource

Class SVNResource

java.lang.Object

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

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

net.shibboleth.ext.spring.resource.SVNResource

All Implemented Interfaces:

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, net.shibboleth.utilities.java.support.resource.Resource, Aware, BeanNameAware, InitializingBean, InputStreamSource

public class SVNResource
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements Resource, BeanNameAware, InitializingBean, net.shibboleth.utilities.java.support.resource.Resource

Implementation of a Spring Resource that communications with a Subversion server (via a spool directory). This resource will fetch the given resource as follows:

• If the revision is a positive number the resource will fetch the resource once during construction time and will never attempt to fetch it again.
• If the revision number is zero or less, signaling the HEAD revision, every call this resource will cause the resource to check to see if the current working copy is the same as the revision in the remote repository. If it is not the new revision will be retrieved.

The behavior of multiple SVNResource operating on the same local copy are undefined.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SVNResource.SVNStatusHandler Simple ISVNStatusHandler implementation that just stores and returns the status.

Field Summary

Fields

Modifier and Type	Field and Description
private org.tmatesoft.svn.core.wc.SVNClientManager	clientManager SVN Client manager.
private DateTime	lastModified Time the resource file was last modified.
private Logger	log Class logger.
private org.tmatesoft.svn.core.SVNURL	remoteRepository URL to the remote repository.
private String	resourceFileName File, within the working copy, represented by this resource.
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
SVNResource(org.tmatesoft.svn.core.wc.SVNClientManager svnClientMgr, org.tmatesoft.svn.core.SVNURL repositoryUrl, File workingCopy, long workingRevision, String resourceFile) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	checkoutOrUpdateResource() 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.
long	contentLength()
Resource	createRelative(String relativePath)
net.shibboleth.utilities.java.support.resource.Resource	createRelativeResource(String relativePath)
boolean	exists()
String	getDescription()
File	getFile()
String	getFilename()
protected String	getFullPath() Helper function to generate the full path for injecting into URLs and URIs.
InputStream	getInputStream()
private DateTime	getLastModificationForRevision(org.tmatesoft.svn.core.wc.SVNRevision revision) Gets the last modified time for the given revision.
protected String	getProtocol() Helper function to return a complex scheme - a conjunction of 'svn' and the underlying protocol.
URI	getURI()
URL	getURL()
boolean	isOpen() Our stream can be read multiple times.
boolean	isReadable() We always say yes.
long	lastModified()
void	setBeanName(String name)
void	setFilename(String fileName) Set the resourceFileName.
private org.tmatesoft.svn.core.wc.SVNRevision	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.

resourceFileName

private String resourceFileName

File, within the working copy, represented by this resource.

lastModified

private DateTime lastModified

Time the resource file was last modified.

Constructor Detail

SVNResource

public SVNResource(@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,
           @Nonnull@ParameterName(name="resourceFile")
           String resourceFile)

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

resourceFile - file, within the working copy, represented by this resource

Throws:

BeanCreationException - thrown if there is a problem initializing the SVN resource

Method Detail

getFilename

public String getFilename()

Specified by:

getFilename in interface net.shibboleth.utilities.java.support.resource.Resource

setFilename

public void setFilename(@Nonnull
               String fileName)

Set the resourceFileName.

Parameters:

fileName - the name

getFullPath

protected String getFullPath()

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

Returns:

the directory path (from svn) pus the file.

getProtocol

protected String getProtocol()

Helper function to return a complex scheme - a conjunction of 'svn' and the underlying protocol.

Returns:

'svn+'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

checkoutOrUpdateResource

protected void checkoutOrUpdateResource()
                                 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

getLastModificationForRevision

private DateTime getLastModificationForRevision(org.tmatesoft.svn.core.wc.SVNRevision revision)
                                         throws IOException

Gets the last modified time for the given revision.

Parameters:

revision - revision to get the last modified date for

Returns:

the last modified time

Throws:

IOException - thrown if there is a problem getting the last modified time

updateResourceDirectory

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

Updates an existing local working copy from the repository.

Returns:

the revision of the fetched content

Throws:

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

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface net.shibboleth.utilities.java.support.resource.Resource

Specified by:

getInputStream in interface InputStreamSource

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface net.shibboleth.utilities.java.support.resource.Resource

isReadable

public boolean isReadable()

We always say yes.

Specified by:

isReadable in interface net.shibboleth.utilities.java.support.resource.Resource

isOpen

public boolean isOpen()

Our stream can be read multiple times.

Specified by:

isOpen in interface net.shibboleth.utilities.java.support.resource.Resource

getURL

public URL getURL()
           throws IOException

Specified by:

getURL in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getURI

public URI getURI()
           throws IOException

Specified by:

getURI in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getFile

public File getFile()
             throws IOException

Specified by:

getFile in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

createRelative

public Resource createRelative(String relativePath)
                        throws IOException

Throws:

IOException

createRelativeResource

public net.shibboleth.utilities.java.support.resource.Resource createRelativeResource(String relativePath)
                                                                               throws IOException

Specified by:

createRelativeResource in interface net.shibboleth.utilities.java.support.resource.Resource

Throws:

IOException

getDescription

public String getDescription()

Specified by:

getDescription in interface net.shibboleth.utilities.java.support.resource.Resource

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware