JervisRemote (Jervis 1.6 API)

Provides a minimum standard interface a Jervis remote requires. Throughout Jervis these functions will be called on the remote. It is recommended that only the functions in this interface should be used by Job DSL plugin scripts when accessing a remote. Failure to do so risks the flexibility and portability of switching remote sources.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`List`	`branches(String project)` Query a remote project for a list of branches.
	`String`	`getCloneUrl()` Repositories will be cloned from this base Git URI.
	`String`	`getFile(String project, String file_path)` Get the contents of a file in a remote git project for a given reference.
	`String`	`getFile(String project, String file_path, String ref)` Get the contents of a file in a remote git project for a given reference.
	`ArrayList`	`getFolderListing(String project)` List the contents of the root directory of the default branch.
	`ArrayList`	`getFolderListing(String project, String dir_path)` List a the contents of a folder path in a project of the default branch.
	`ArrayList`	`getFolderListing(String project, String dir_path, String ref)` Get list a file path in a project for the given reference.
	`String`	`getWebUrl()` A web interface to browse repository code.
	`String`	`toString()` This method is used by Jervis to output friendly messages including the remote.

- Method Detail
  - List branches(String project)
    
    Query a remote project for a list of branches.
    Returns:
    A List containing all of the branches listed on the remote project.
  - String getCloneUrl()
    
    Repositories will be cloned from this base Git URI.
    Returns:
    A base git URI in which a repository can be cloned.
  - String getFile(String project, String file_path)
    
    Get the contents of a file in a remote git project for a given reference. Uses the default branch. Most commonly the file requested will be the Jervis YAML file.
    Returns:
    A String which contains the contents of the file requested.
  - String getFile(String project, String file_path, String ref)
    
    Get the contents of a file in a remote git project for a given reference. Most commonly the file requested will be the Jervis YAML file.
    Returns:
    A String which contains the contents of the file requested.
  - ArrayList getFolderListing(String project)
    
    List the contents of the root directory of the default branch. This will typically be used to list the contents of the root directory for the reference so that build scripts can be generated from the list.
    Returns:
    A list of files in the requested file path.
  - ArrayList getFolderListing(String project, String dir_path)
    
    List a the contents of a folder path in a project of the default branch. This will typically be used to list the contents of the root directory for the reference so that build scripts can be generated from the list.
    Returns:
    A list of files in the requested file path.
  - ArrayList getFolderListing(String project, String dir_path, String ref)
    
    Get list a file path in a project for the given reference. This will typically be used to list the contents of the root directory for the reference so that build scripts can be generated from the list.
    Returns:
    A list of files in the requested file path.
  - String getWebUrl()
    
    A web interface to browse repository code.
    Returns:
    A base web URL in which to browse code.
  - String toString()
    
    This method is used by Jervis to output friendly messages including the remote.
    Returns:
    A human readable String for this type of remote.

Summary:
Method

| Detail:
Method

Jervis API documentation.

[Groovy] Interface JervisRemote

Methods Summary

Method Detail

List branches(String project)

String getCloneUrl()

String getFile(String project, String file_path)

String getFile(String project, String file_path, String ref)

ArrayList getFolderListing(String project)

ArrayList getFolderListing(String project, String dir_path)

ArrayList getFolderListing(String project, String dir_path, String ref)

String getWebUrl()

String toString()