net.nemerosa.ontrack.extension.git

Class GitController

java.lang.Object

net.nemerosa.ontrack.ui.controller.AbstractResourceController

net.nemerosa.ontrack.extension.support.AbstractExtensionController<GitExtensionFeature>

net.nemerosa.ontrack.extension.git.GitController

@RestController
 @RequestMapping(value="extension/git")
public class GitController
extends net.nemerosa.ontrack.extension.support.AbstractExtensionController<GitExtensionFeature>

Field Summary

Fields inherited from class net.nemerosa.ontrack.extension.support.AbstractExtensionController

feature

Constructor Summary

Constructors

Constructor and Description
GitController(GitExtensionFeature feature, net.nemerosa.ontrack.model.structure.StructureService structureService, GitService gitService, GitConfigurationService configurationService, net.nemerosa.ontrack.extension.issues.IssueServiceRegistry issueServiceRegistry, net.nemerosa.ontrack.model.security.SecurityService securityService)

Method Summary

Modifier and Type	Method and Description
net.nemerosa.ontrack.model.buildfilter.BuildDiff	changeLog(net.nemerosa.ontrack.extension.api.model.BuildDiffRequest request) Change log entry point
org.springframework.http.ResponseEntity<java.lang.String>	changeLog(net.nemerosa.ontrack.extension.api.model.IssueChangeLogExportRequest request) Change log export
GitChangeLogCommits	changeLogCommits(java.lang.String uuid) Change log commits
net.nemerosa.ontrack.ui.resource.Resources<net.nemerosa.ontrack.extension.issues.export.ExportFormat>	changeLogExportFormats(net.nemerosa.ontrack.model.structure.ID projectId) Change log export, list of formats
GitChangeLogFiles	changeLogFiles(java.lang.String uuid) Change log files
GitChangeLogIssues	changeLogIssues(java.lang.String uuid) Change log issues
net.nemerosa.ontrack.ui.resource.Resource<OntrackGitCommitInfo>	commitInfo(net.nemerosa.ontrack.model.structure.ID branchId, java.lang.String commit) Commit information
net.nemerosa.ontrack.model.Ack	deleteConfiguration(java.lang.String name) Deleting one configuration
org.springframework.http.ResponseEntity<java.lang.String>	diff(net.nemerosa.ontrack.extension.api.model.FileDiffChangeLogRequest request) File diff change log
org.springframework.http.ResponseEntity<java.lang.String>	download(net.nemerosa.ontrack.model.structure.ID branchId, java.lang.String path) Download a path for a branch
BasicGitConfiguration	getConfiguration(java.lang.String name) Gets one configuration
net.nemerosa.ontrack.model.form.Form	getConfigurationForm() Form for a configuration
net.nemerosa.ontrack.ui.resource.Resources<BasicGitConfiguration>	getConfigurations() Gets the configurations
net.nemerosa.ontrack.ui.resource.Resources<net.nemerosa.ontrack.model.support.ConfigurationDescriptor>	getConfigurationsDescriptors() Gets the configuration descriptors
net.nemerosa.ontrack.ui.resource.Resource<net.nemerosa.ontrack.model.extension.ExtensionFeatureDescription>	getDescription()
GitSynchronisationInfo	getProjectGitSyncInfo(net.nemerosa.ontrack.model.structure.ID projectId) Gets the Git synchronisation information.
net.nemerosa.ontrack.ui.resource.Resource<OntrackGitIssueInfo>	issueInfo(net.nemerosa.ontrack.model.structure.ID branchId, java.lang.String issue) Issue information
net.nemerosa.ontrack.model.Ack	launchBuildSync(net.nemerosa.ontrack.model.structure.ID branchId) Launches the build synchronisation for a branch.
BasicGitConfiguration	newConfiguration(BasicGitConfiguration configuration) Creating a configuration
net.nemerosa.ontrack.model.Ack	projectGitSync(net.nemerosa.ontrack.model.structure.ID projectId, GitSynchronisationRequest request) Launching the synchronisation
net.nemerosa.ontrack.model.support.ConnectionResult	testConfiguration(BasicGitConfiguration configuration) Test for a configuration
BasicGitConfiguration	updateConfiguration(java.lang.String name, BasicGitConfiguration configuration) Updating one configuration
net.nemerosa.ontrack.model.form.Form	updateConfigurationForm(java.lang.String name) Update form

Methods inherited from class net.nemerosa.ontrack.ui.controller.AbstractResourceController

resolveExtensionAction, resolveExtensionAction, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

GitController

@Autowired
public GitController(GitExtensionFeature feature,
                                net.nemerosa.ontrack.model.structure.StructureService structureService,
                                GitService gitService,
                                GitConfigurationService configurationService,
                                net.nemerosa.ontrack.extension.issues.IssueServiceRegistry issueServiceRegistry,
                                net.nemerosa.ontrack.model.security.SecurityService securityService)

Method Detail

getDescription

@RequestMapping(value="",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resource<net.nemerosa.ontrack.model.extension.ExtensionFeatureDescription> getDescription()

Specified by:

getDescription in class net.nemerosa.ontrack.extension.support.AbstractExtensionController<GitExtensionFeature>

getConfigurations

@RequestMapping(value="configurations",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resources<BasicGitConfiguration> getConfigurations()

Gets the configurations

getConfigurationsDescriptors

@RequestMapping(value="configurations/descriptors",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resources<net.nemerosa.ontrack.model.support.ConfigurationDescriptor> getConfigurationsDescriptors()

Gets the configuration descriptors

testConfiguration

@RequestMapping(value="configurations/test",
                method=POST)
public net.nemerosa.ontrack.model.support.ConnectionResult testConfiguration(@RequestBody
                                                                                                                                                       BasicGitConfiguration configuration)

Test for a configuration

getConfigurationForm

@RequestMapping(value="configurations/create",
                method=GET)
public net.nemerosa.ontrack.model.form.Form getConfigurationForm()

Form for a configuration

newConfiguration

@RequestMapping(value="configurations/create",
                method=POST)
public BasicGitConfiguration newConfiguration(@RequestBody
                                                                                                                          BasicGitConfiguration configuration)

Creating a configuration

getConfiguration

@RequestMapping(value="configurations/{name:.*}",
                method=GET)
public BasicGitConfiguration getConfiguration(@PathVariable
                                                                                                                            java.lang.String name)

Gets one configuration

deleteConfiguration

@RequestMapping(value="configurations/{name:.*}",
                method=DELETE)
 @ResponseStatus(value=NO_CONTENT)
public net.nemerosa.ontrack.model.Ack deleteConfiguration(@PathVariable
                                                                                                                                                                              java.lang.String name)

Deleting one configuration

updateConfigurationForm

@RequestMapping(value="configurations/{name:.*}/update",
                method=GET)
public net.nemerosa.ontrack.model.form.Form updateConfigurationForm(@PathVariable
                                                                                                                                                         java.lang.String name)

Update form

updateConfiguration

@RequestMapping(value="configurations/{name:.*}/update",
                method=PUT)
public BasicGitConfiguration updateConfiguration(@PathVariable
                                                                                                                                      java.lang.String name,
                                                                                                                                      @RequestBody
                                                                                                                                      BasicGitConfiguration configuration)

Updating one configuration

launchBuildSync

@RequestMapping(value="sync/{branchId}",
                method=POST)
public net.nemerosa.ontrack.model.Ack launchBuildSync(@PathVariable
                                                                                                                            net.nemerosa.ontrack.model.structure.ID branchId)

Launches the build synchronisation for a branch.

changeLog

@RequestMapping(value="changelog",
                method=GET)
public net.nemerosa.ontrack.model.buildfilter.BuildDiff changeLog(net.nemerosa.ontrack.extension.api.model.BuildDiffRequest request)

Change log entry point

changeLogExportFormats

@RequestMapping(value="changelog/export/{projectId}/formats",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resources<net.nemerosa.ontrack.extension.issues.export.ExportFormat> changeLogExportFormats(@PathVariable
                                                                                                                                                                                                                              net.nemerosa.ontrack.model.structure.ID projectId)

Change log export, list of formats

changeLog

@RequestMapping(value="changelog/export",
                method=GET)
public org.springframework.http.ResponseEntity<java.lang.String> changeLog(net.nemerosa.ontrack.extension.api.model.IssueChangeLogExportRequest request)

Change log export

diff

@RequestMapping(value="changelog/diff",
                method=GET)
public org.springframework.http.ResponseEntity<java.lang.String> diff(net.nemerosa.ontrack.extension.api.model.FileDiffChangeLogRequest request)

File diff change log

changeLogCommits

@RequestMapping(value="changelog/{uuid}/commits",
                method=GET)
public GitChangeLogCommits changeLogCommits(@PathVariable
                                                                                                                          java.lang.String uuid)

Change log commits

changeLogIssues

@RequestMapping(value="changelog/{uuid}/issues",
                method=GET)
public GitChangeLogIssues changeLogIssues(@PathVariable
                                                                                                                       java.lang.String uuid)

Change log issues

changeLogFiles

@RequestMapping(value="changelog/{uuid}/files",
                method=GET)
public GitChangeLogFiles changeLogFiles(@PathVariable
                                                                                                                    java.lang.String uuid)

Change log files

issueInfo

@RequestMapping(value="{branchId}/issue/{issue}",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resource<OntrackGitIssueInfo> issueInfo(@PathVariable
                                                                                                                                                              net.nemerosa.ontrack.model.structure.ID branchId,
                                                                                                                                                              @PathVariable
                                                                                                                                                              java.lang.String issue)

Issue information

commitInfo

@RequestMapping(value="{branchId}/commit/{commit}",
                method=GET)
public net.nemerosa.ontrack.ui.resource.Resource<OntrackGitCommitInfo> commitInfo(@PathVariable
                                                                                                                                                                  net.nemerosa.ontrack.model.structure.ID branchId,
                                                                                                                                                                  @PathVariable
                                                                                                                                                                  java.lang.String commit)

Commit information

download

@RequestMapping(value="download/{branchId}")
public org.springframework.http.ResponseEntity<java.lang.String> download(@PathVariable
                                                                                                                       net.nemerosa.ontrack.model.structure.ID branchId,
                                                                                                                       java.lang.String path)

Download a path for a branch

Parameters:

branchId - ID to download a document from

getProjectGitSyncInfo

@RequestMapping(value="project-sync/{projectId}",
                method=GET)
public GitSynchronisationInfo getProjectGitSyncInfo(@PathVariable
                                                                                                                                  net.nemerosa.ontrack.model.structure.ID projectId)

Gets the Git synchronisation information.

Parameters:

projectId - ID of the project

Returns:

Synchronisation information

projectGitSync

@RequestMapping(value="project-sync/{projectId}",
                method=POST)
public net.nemerosa.ontrack.model.Ack projectGitSync(@PathVariable
                                                                                                                                    net.nemerosa.ontrack.model.structure.ID projectId,
                                                                                                                                    @RequestBody
                                                                                                                                    GitSynchronisationRequest request)

Launching the synchronisation