org.tmatesoft.svn.core.internal.io.dav

Class DAVCommitEditor

java.lang.Object

org.tmatesoft.svn.core.internal.io.dav.DAVCommitEditor

All Implemented Interfaces:

ISVNDeltaConsumer, ISVNEditor

class DAVCommitEditor
extends java.lang.Object
implements ISVNEditor

Version:

1.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREATE_TXN
static java.lang.String	CREATE_TXN_WITH_PROPS
private java.lang.String	myActivity
private java.lang.String	myActivityLocation
private java.lang.String	myBaseChecksum
private java.lang.Runnable	myCloseCallback
private ISVNWorkspaceMediator	myCommitMediator
private DAVConnection	myConnection
private java.io.OutputStream	myCurrentDelta
private java.util.Set<java.lang.String>	myDeletedPaths
private java.io.File	myDeltaFile
private java.util.Stack	myDirsStack
private java.util.Map	myFilesMap
private boolean	myIsAborted
private boolean	myIsFirstWindow
private SVNURL	myLocation
private java.util.Map	myPathsMap
private DAVRepository	myRepository
private SVNProperties	myRevProps
private java.lang.String	myTxnRootUrl
private java.lang.String	myTxnUrl
static java.lang.String	SKEL_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
DAVCommitEditor(DAVRepository repository, DAVConnection connection, java.lang.String message, ISVNWorkspaceMediator mediator, java.lang.Runnable closeCallback)
DAVCommitEditor(DAVRepository repository, DAVConnection connection, SVNProperties revProps, ISVNWorkspaceMediator mediator, java.lang.Runnable closeCallback)

Method Summary

Modifier and Type	Method and Description
void	abortEdit() Aborts the current running editor due to errors occured.
void	absentDir(java.lang.String path) Indicates that a path is present as a subdirectory in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).
void	absentFile(java.lang.String path) Indicates that a path is present as a file in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).
void	addDir(java.lang.String path, java.lang.String copyPath, long copyRevision) Adds a directory.
void	addFile(java.lang.String path, java.lang.String copyPath, long copyRevision) Adds a file.
void	applyTextDelta(java.lang.String path, java.lang.String baseChecksum) Starts applying text delta(s) to an opened file.
void	changeDirProperty(java.lang.String name, SVNPropertyValue value) Changes the value of a property of the currently opened/added directory.
void	changeFileProperty(java.lang.String path, java.lang.String name, SVNPropertyValue value) Changes the value of a property of the currently opened/added file.
private void	checkoutResource(DAVResource resource, boolean allow404)
void	closeDir() Closes the currently opened directory fixing all changes of its properties and/or entries.
SVNCommitInfo	closeEdit() Closes this editor finalizing the whole operation the editor was used for.
void	closeFile(java.lang.String path, java.lang.String textChecksum) Closes the opened file fixing all properties and/or contents changes.
private java.lang.String[]	createActivity()
private byte[]	createTxnPostBody(SVNProperties revisionProperties)
void	deleteEntry(java.lang.String path, long revision) Deletes an entry.
void	openDir(java.lang.String path, long revision) Opens a directory.
void	openFile(java.lang.String path, long revision) Opens a file.
void	openRoot(long revision) Opens the root directory on which the operation was invoked.
private void	patchResourceProperties(java.lang.String path, SVNProperties properties)
private void	runCloseCallback()
void	targetRevision(long revision) Sets the target revision the operation is running for.
java.io.OutputStream	textDeltaChunk(java.lang.String path, SVNDiffWindow diffWindow) Collects a next delta chunk.
void	textDeltaEnd(java.lang.String path) Finalizes collecting text delta(s).

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_TXN_WITH_PROPS

public static final java.lang.String CREATE_TXN_WITH_PROPS

See Also:

Constant Field Values

CREATE_TXN

public static final java.lang.String CREATE_TXN

See Also:

Constant Field Values

SKEL_MIME_TYPE

public static final java.lang.String SKEL_MIME_TYPE

See Also:

Constant Field Values

myConnection

private DAVConnection myConnection

myLocation

private SVNURL myLocation

myRepository

private DAVRepository myRepository

myCloseCallback

private java.lang.Runnable myCloseCallback

myActivity

private java.lang.String myActivity

myDirsStack

private java.util.Stack myDirsStack

myCommitMediator

private ISVNWorkspaceMediator myCommitMediator

myPathsMap

private java.util.Map myPathsMap

myFilesMap

private java.util.Map myFilesMap

myBaseChecksum

private java.lang.String myBaseChecksum

myRevProps

private SVNProperties myRevProps

myActivityLocation

private java.lang.String myActivityLocation

myDeletedPaths

private java.util.Set<java.lang.String> myDeletedPaths

myTxnRootUrl

private java.lang.String myTxnRootUrl

myTxnUrl

private java.lang.String myTxnUrl

myCurrentDelta

private java.io.OutputStream myCurrentDelta

myDeltaFile

private java.io.File myDeltaFile

myIsAborted

private boolean myIsAborted

myIsFirstWindow

private boolean myIsFirstWindow

Constructor Detail

DAVCommitEditor

public DAVCommitEditor(DAVRepository repository,
                       DAVConnection connection,
                       java.lang.String message,
                       ISVNWorkspaceMediator mediator,
                       java.lang.Runnable closeCallback)

DAVCommitEditor

public DAVCommitEditor(DAVRepository repository,
                       DAVConnection connection,
                       SVNProperties revProps,
                       ISVNWorkspaceMediator mediator,
                       java.lang.Runnable closeCallback)

Method Detail

targetRevision

public void targetRevision(long revision)
                    throws SVNException

Description copied from interface: ISVNEditor

Sets the target revision the operation is running for. For example, the target revision to which an update is running.

Specified by:

targetRevision in interface ISVNEditor

Parameters:

revision - a revision number

Throws:

SVNException

absentDir

public void absentDir(java.lang.String path)
               throws SVNException

Description copied from interface: ISVNEditor

Indicates that a path is present as a subdirectory in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).

Specified by:

absentDir in interface ISVNEditor

Parameters:

path - a dir path relative to the root directory opened by openRoot()

Throws:

SVNException

absentFile

public void absentFile(java.lang.String path)
                throws SVNException

Description copied from interface: ISVNEditor

Indicates that a path is present as a file in the edit source, but can not be conveyed to the edit consumer (perhaps because of authorization restrictions).

Specified by:

absentFile in interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

Throws:

SVNException

openRoot

public void openRoot(long revision)
              throws SVNException

Description copied from interface: ISVNEditor

Opens the root directory on which the operation was invoked. All property changes as well as entries adding/deletion will be applied to this root directory. When coming back up to this root (after traversing the entire tree) you should close the root by calling ISVNEditor.closeDir().

Specified by:

openRoot in interface ISVNEditor

Parameters:

revision - the revision number of the root directory

Throws:

SVNException

deleteEntry

public void deleteEntry(java.lang.String path,
                        long revision)
                 throws SVNException

Description copied from interface: ISVNEditor

Deletes an entry.

In a commit - deletes an entry from a repository. In an update - deletes an entry locally (since it has been deleted in the repository). In a status - informs that an entry has been deleted.

Specified by:

deleteEntry in interface ISVNEditor

Parameters:

path - an entry path relative to the root directory opened by openRoot()

revision - the revision number of path

Throws:

SVNException

addDir

public void addDir(java.lang.String path,
                   java.lang.String copyPath,
                   long copyRevision)
            throws SVNException

Description copied from interface: ISVNEditor

Adds a directory.

In a commit - adds a new directory to a repository. In an update - locally adds a directory that was added in the repository. In a status - informs about a new directory scheduled for addition.

If copyFromPath is not null then it says that path is copied from copyFromPath located in copyFromRevision.

Specified by:

addDir in interface ISVNEditor

Parameters:

path - a directory path relative to the root directory opened by openRoot()

copyPath - an ancestor of the added directory

copyRevision - the revision of the ancestor

Throws:

SVNException

openDir

public void openDir(java.lang.String path,
                    long revision)
             throws SVNException

Description copied from interface: ISVNEditor

Opens a directory. All property changes as well as entries adding/deletion can be applied to this directory.

Specified by:

openDir in interface ISVNEditor

Parameters:

path - a directory path relative to the root directory opened by openRoot()

revision - the revision of the directory

Throws:

SVNException

changeDirProperty

public void changeDirProperty(java.lang.String name,
                              SVNPropertyValue value)
                       throws SVNException

Description copied from interface: ISVNEditor

Changes the value of a property of the currently opened/added directory.

Specified by:

changeDirProperty in interface ISVNEditor

Parameters:

name - the name of a property to be changed

value - new property value

Throws:

SVNException

See Also:

ISVNEditor.openDir(String, long)

closeDir

public void closeDir()
              throws SVNException

Description copied from interface: ISVNEditor

Closes the currently opened directory fixing all changes of its properties and/or entries. Closing a directory picks up an editor to a parent directory.

Specified by:

closeDir in interface ISVNEditor

Throws:

SVNException

addFile

public void addFile(java.lang.String path,
                    java.lang.String copyPath,
                    long copyRevision)
             throws SVNException

Description copied from interface: ISVNEditor

Adds a file.

In a commit - adds a new file to a repository. In an update - locally adds a file that was added in the repository. In a status - informs about a new file scheduled for addition.

If copyFromPath is not null then it says that path is copied from copyFromPath located in copyFromRevision.

Specified by:

addFile in interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

copyPath - an ancestor of the added file

copyRevision - the revision of the ancestor

Throws:

SVNException

openFile

public void openFile(java.lang.String path,
                     long revision)
              throws SVNException

Description copied from interface: ISVNEditor

Opens a file. After it's opened, apply delta to its contents or change the file properties.

Specified by:

openFile in interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

revision - the revision of the file

Throws:

SVNException

applyTextDelta

public void applyTextDelta(java.lang.String path,
                           java.lang.String baseChecksum)
                    throws SVNException

Description copied from interface: ISVNDeltaConsumer

Starts applying text delta(s) to an opened file.

Specified by:

applyTextDelta in interface ISVNDeltaConsumer

Parameters:

path - a file path relative to the edit root directory

baseChecksum - an MD5 checksum for the base file contents (before the file is changed)

Throws:

SVNException - if the calculated base file checksum didn't match the expected baseChecksum

textDeltaChunk

public java.io.OutputStream textDeltaChunk(java.lang.String path,
                                           SVNDiffWindow diffWindow)
                                    throws SVNException

Description copied from interface: ISVNDeltaConsumer

Collects a next delta chunk. The return type is nomore relevant and is left only for backward compatibility. So, the return value may be just null. Otherwise if it's not null, the stream will be immediately closed.

If there are more than one windows for the file, this method is called several times.

Specified by:

textDeltaChunk in interface ISVNDeltaConsumer

Parameters:

path - a file path relative to the edit root directory

diffWindow - a next diff window

Returns:

an output stream

Throws:

SVNException

textDeltaEnd

public void textDeltaEnd(java.lang.String path)
                  throws SVNException

Description copied from interface: ISVNDeltaConsumer

Finalizes collecting text delta(s).

Specified by:

textDeltaEnd in interface ISVNDeltaConsumer

Parameters:

path - a file path relative to the edit root directory

Throws:

SVNException

changeFileProperty

public void changeFileProperty(java.lang.String path,
                               java.lang.String name,
                               SVNPropertyValue value)
                        throws SVNException

Description copied from interface: ISVNEditor

Changes the value of a property of the currently opened/added file.

Specified by:

changeFileProperty in interface ISVNEditor

Parameters:

path - file path relative to the root of this editor

name - property name

value - property value

Throws:

SVNException

closeFile

public void closeFile(java.lang.String path,
                      java.lang.String textChecksum)
               throws SVNException

Description copied from interface: ISVNEditor

Closes the opened file fixing all properties and/or contents changes.

Specified by:

closeFile in interface ISVNEditor

Parameters:

path - a file path relative to the root directory opened by openRoot()

textChecksum - an MD5 checksum for the modified file

Throws:

SVNException - if the calculated upon the actual changed contents checksum does not match the expected textChecksum

closeEdit

public SVNCommitInfo closeEdit()
                        throws SVNException

Description copied from interface: ISVNEditor

Closes this editor finalizing the whole operation the editor was used for. In a commit - sends collected data to commit a transaction.

Specified by:

closeEdit in interface ISVNEditor

Returns:

a committed revision information

Throws:

SVNException

abortEdit

public void abortEdit()
               throws SVNException

Description copied from interface: ISVNEditor

Aborts the current running editor due to errors occured.

If an exception is thrown from an editor's method, call this method to abort the editor.

Specified by:

abortEdit in interface ISVNEditor

Throws:

SVNException

runCloseCallback

private void runCloseCallback()

createActivity

private java.lang.String[] createActivity()
                                   throws SVNException

Throws:

SVNException

patchResourceProperties

private void patchResourceProperties(java.lang.String path,
                                     SVNProperties properties)
                              throws SVNException

Throws:

SVNException

checkoutResource

private void checkoutResource(DAVResource resource,
                              boolean allow404)
                       throws SVNException

Throws:

SVNException

createTxnPostBody

private byte[] createTxnPostBody(SVNProperties revisionProperties)
                          throws SVNException

Throws:

SVNException