Constructor Detail

• SVNCopyClient

  public SVNCopyClient​(ISVNAuthenticationManager authManager,
                       ISVNOptions options)

  Constructs and initializes an SVNCopyClient object with the specified run-time configuration and authentication drivers.

  If options is null, then this SVNCopyClient will be using a default run-time configuration driver which takes client-side settings from the default SVN's run-time configuration area but is not able to change those settings (read more on ISVNOptions and SVNWCUtil).

  If authManager is null, then this SVNCopyClient will be using a default authentication and network layers driver (see SVNWCUtil.createDefaultAuthenticationManager()) which uses server-side settings and auth storage from the default SVN's run-time configuration area (or system properties if that area is not found).

  Parameters:

  authManager - an authentication and network layers driver

  options - a run-time configuration options driver

• SVNCopyClient

  public SVNCopyClient​(ISVNRepositoryPool repositoryPool,
                       ISVNOptions options)

  Constructs and initializes an SVNCopyClient object with the specified run-time configuration and repository pool object.

  If options is null, then this SVNCopyClient will be using a default run-time configuration driver which takes client-side settings from the default SVN's run-time configuration area but is not able to change those settings (read more on ISVNOptions and SVNWCUtil).

  If repositoryPool is null, then SVNRepositoryFactory will be used to create repository access objects.

  Parameters:

  repositoryPool - a repository pool object

  options - a run-time configuration options driver

• SVNCopyClient

  public SVNCopyClient​(SvnOperationFactory of)

Method Detail

• initDefaults

  protected void initDefaults()

  Overrides:

  initDefaults in class SVNBasicClient

• setCommitHandler

  public void setCommitHandler​(ISVNCommitHandler handler)

  Sets an implementation of ISVNCommitHandler to the commit handler that will be used during commit operations to handle commit log messages. The handler will receive a clien's log message and items (represented as SVNCommitItem objects) that will be committed. Depending on implementor's aims the initial log message can be modified (or something else) and returned back.

  If using SVNCopyClient without specifying any commit handler then a default one will be used - DefaultSVNCommitHandler.

  Parameters:

  handler - an implementor's handler that will be used to handle commit log messages

  See Also:

  getCommitHandler(), SVNCommitItem

• getCommitHandler

  public ISVNCommitHandler getCommitHandler()

  Returns the specified commit handler (if set) being in use or a default one (DefaultSVNCommitHandler) if no special implementations of ISVNCommitHandler were previousely provided.

  Returns:

  the commit handler being in use or a default one

  See Also:

  setCommitHandler(ISVNCommitHandler), DefaultSVNCommitHandler

• setCommitParameters

  public void setCommitParameters​(ISVNCommitParameters parameters)

  Sets commit parameters to use.

  When no parameters are set default ones are used.

  Parameters:

  parameters - commit parameters

  See Also:

  getCommitParameters()

• getCommitParameters

  public ISVNCommitParameters getCommitParameters()

  Returns commit parameters.

  If no user parameters were previously specified, once creates and returns default ones.

  Returns:

  commit parameters

  See Also:

  setCommitParameters(ISVNCommitParameters)

• setExternalsHandler

  public void setExternalsHandler​(ISVNExternalsHandler externalsHandler)

  Sets an externals handler to be used by this client object.

  Parameters:

  externalsHandler - user's implementation of ISVNExternalsHandler

  Since:

  1.2

  See Also:

  getExternalsHandler()

• setDisableLocalModificationCopying

  public void setDisableLocalModificationCopying​(boolean disable)

• getExternalsHandler

  public ISVNExternalsHandler getExternalsHandler()

  Returns an externals handler used by this update client.

  If no user's handler is provided then ISVNExternalsHandler.DEFAULT is returned and used by this client object by default.

  For more information what externals handlers are for, please, refer to ISVNExternalsHandler and doCopy(SVNCopySource[], SVNURL, boolean, boolean, boolean, String, SVNProperties).

  Returns:

  externals handler being in use

  Since:

  1.2

  See Also:

  setExternalsHandler(ISVNExternalsHandler)

• doCopy

  public void doCopy​(SVNCopySource[] sources,
                     java.io.File dst,
                     boolean isMove,
                     boolean makeParents,
                     boolean failWhenDstExists)
              throws SVNException

  Copies each source in sources to dst.

  If multiple sources are given, dst must be a directory, and sources will be copied as children of dst.

  Each src in sources must be files or directories under version control, or URLs of a versioned item in the repository. If sources has multiple items, they must be all repository URLs or all working copy paths.

  The parent of dst must already exist.

  If sources has only one item, attempts to copy it to dst. If failWhenDstExists is false and dst already exists, attempts to copy the item as a child of dst. If failWhenDstExists is true and dst already exists, throws an SVNException with the SVNErrorCode.ENTRY_EXISTS error code.

  If sources has multiple items, and failWhenDstExists is false, all sources are copied as children of dst. If any child of dst already exists with the same name any item in sources, throws an SVNException with the SVNErrorCode.ENTRY_EXISTS error code.

  If sources has multiple items, and failWhenDstExists is true, throws an SVNException with the SVNErrorCode.CLIENT_MULTIPLE_SOURCES_DISALLOWED.

  This method is just a variant of a local add operation, where sources are scheduled for addition as copies. No changes will happen to the repository until a commit occurs. This scheduling can be removed with SVNWCClient.doRevert(File[], SVNDepth, Collection).

  If makeParents is true, creates any non-existent parent directories also.

  If the caller's ISVNEventHandler is non-null, invokes it for each item added at the new location.

  Note: this routine requires repository access only when sources are urls.

  Parameters:

  sources - array of copy sources

  dst - destination working copy path

  isMove - if true, then it will be a move operation (delete, then add with history)

  makeParents - if true, creates non-existent parent directories as well

  failWhenDstExists - controls whether to fail or not if dst already exists

  Throws:

  SVNException

  Since:

  1.2, SVN 1.5