org.antmod.scm
Class ScmUrl

java.lang.Object
  org.antmod.scm.ScmUrl

public class ScmUrl
extends java.lang.Object

Representation of an SCM url.

The format of this element is as follows:

scm:<provider>:<provider-parameters>

For cvs, the format for pserver repositories should be (password is optional):

scm:cvs:pserver:user[:password]@host:/cvs/root:module-name

For local system repositories

scm:cvs:local:ignored:/cvs/root:module-name

For ssh access:

scm:cvs:ext:user@host:/cvs/root:module-name

Subversion syntax (between brackets is optional):

scm:svn:protocol://[user[:password]@]host/path/to/svn[:module-name]

Subversion urls using this syntax look for example like this:

scm:svn:http://user:password@host.example.com/path/to/svn

scm:svn:http://host.example.com:8080/path/to/svn

scm:svn:svn://host.example.com/path/to/svn

scm:svn:file:///C:/path/to/localsvn

scm:svn:file:///cygdrive/c/path/to/localsvn

Remember that CVS will expect an environment variable called CVS_RSH to be set, typically to ssh or your ssh client.

Author:

Klaas Waslander

Constructor Summary

ScmUrl(java.lang.String urlString)
Constructs new ScmUrl instance based on the parsed contents of the given scm url string.

Method Summary

java.lang.String	getHost()
java.lang.String	getModule()
java.lang.String	getPassword()
java.lang.String	getPath()
java.lang.String	getProtocol()
java.lang.String	getType()
java.lang.String	getUrlString() Get the original URL string with which this ScmUrl was created.
java.lang.String	getUrlStringNoModule() Get the original URL string with which this ScmUrl was created, without the module element (if any).
java.lang.String	getUser()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmUrl

public ScmUrl(java.lang.String urlString)
       throws java.lang.IllegalArgumentException,
              java.text.ParseException

Constructs new ScmUrl instance based on the parsed contents of the given scm url string.

Parameters:

urlString - The string representing the SCM url.

Throws:

java.lang.IllegalArgumentException

java.text.ParseException

Method Detail

getHost

public java.lang.String getHost()

Returns:

getModule

public java.lang.String getModule()

Returns:

getPassword

public java.lang.String getPassword()

Returns:

getPath

public java.lang.String getPath()

Returns:

getProtocol

public java.lang.String getProtocol()

Returns:

getType

public java.lang.String getType()

Returns:

getUser

public java.lang.String getUser()

Returns:

getUrlString

public java.lang.String getUrlString()

Get the original URL string with which this ScmUrl was created.

getUrlStringNoModule

public java.lang.String getUrlStringNoModule()

Get the original URL string with which this ScmUrl was created, without the module element (if any).