jenkins.plugins.gerrit

Class GerritURI

java.lang.Object

jenkins.plugins.gerrit.GerritURI

public class GerritURI
extends Object

A GerritURI encapsulates a Gerrit remote URI and is able to extract certain properties like the project name and URI prefix.

Constructor Summary

Constructors

Constructor and Description
GerritURI(org.eclipse.jgit.transport.URIish remoteURI) Create a new Gerrit URI from the given remote URI.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.transport.URIish	getApiURI() Get the Gerrit REST-API base URL, using the correct prefix.
String	getPrefix() Get the URI prefix from the remote URI.
String	getProject() Get the Gerrit project name from the remote URI.
org.eclipse.jgit.transport.URIish	getRemoteURI() Get the full Gerrit remote URI.
org.eclipse.jgit.transport.URIish	setPath(String path) Set the Gerrit path.
org.eclipse.jgit.transport.URIish	setProject(String projectName) Set a Gerrit project

Methods inherited from class java.lang.Object

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

Constructor Detail

GerritURI

public GerritURI(org.eclipse.jgit.transport.URIish remoteURI)

Create a new Gerrit URI from the given remote URI.

Parameters:

remoteURI - the remote URI, e.g. https://host/a/project

Method Detail

getRemoteURI

public org.eclipse.jgit.transport.URIish getRemoteURI()

Get the full Gerrit remote URI.

Returns:

the remote URI

getProject

public String getProject()

Get the Gerrit project name from the remote URI.

Returns:

the Gerrit project name

getPrefix

public String getPrefix()

Get the URI prefix from the remote URI.

Returns:

the URI prefix, e.g. /gerrit/ when Gerrit is configured with httpd.listenUrl protocol://host:port/gerrit/.

getApiURI

public org.eclipse.jgit.transport.URIish getApiURI()
                                            throws URISyntaxException

Get the Gerrit REST-API base URL, using the correct prefix.

Returns:

Gerrit base URL for calling REST-API

Throws:

URISyntaxException - if URL is invalid.

setPath

public org.eclipse.jgit.transport.URIish setPath(String path)

Set the Gerrit path.

Returns:

Gerrit URL with the path.

setProject

public org.eclipse.jgit.transport.URIish setProject(String projectName)
                                             throws URISyntaxException

Set a Gerrit project

Returns:

Gerrit URL to the project

Throws:

URISyntaxException