Package org.craftercms.studio.controller.rest.v2

Class RepositoryManagementController

java.lang.Object

org.craftercms.studio.controller.rest.v2.RepositoryManagementController

@Validated
@RestController
@RequestMapping("/api/2/repository")
public class RepositoryManagementController
extends Object

Constructor Summary

Constructors

Constructor	Description
RepositoryManagementController(RepositoryManagementService repositoryManagementService)

Method Summary

Modifier and Type	Method	Description
Result	addRemote(javax.servlet.http.HttpServletResponse response, @Valid RemoteRepository remoteRepository)
ResultOne<RepositoryStatus>	cancelFailedPull(@Valid CancelFailedPullRequest cancelFailedPullRequest)
ResultOne<RepositoryStatus>	commitConflictResolution(@Valid CommitResolutionRequest commitResolutionRequest)
ResultOne<DiffConflictedFile>	getDiffForConflictedFile(String siteId, String path)
ResultOne<RepositoryStatus>	getRepositoryStatus(String siteId)
ResultOne<Boolean>	isRepositoryCorrupted(String siteId, GitRepositories repositoryType)
ResultList<RemoteRepositoryInfo>	listRemotes(String siteId)
ResultOne<MergeResult>	pullFromRemote(@Valid PullFromRemoteRequest pullFromRemoteRequest)
Result	pushToRemote(javax.servlet.http.HttpServletResponse response, @Valid PushToRemoteRequest pushToRemoteRequest)
Result	rebuildDatabase(@Valid RebuildDatabaseRequest rebuildDatabaseRequest)
Result	removeRemote(javax.servlet.http.HttpServletResponse response, @Valid RemoveRemoteRequest removeRemoteRequest)
Result	repairCorruptedRepository(@Valid RepairRepositoryRequest request)
ResultOne<RepositoryStatus>	resolveConflict(@Valid ResolveConflictRequest resolveConflictRequest)
Result	unlockRepository(@Valid UnlockRepositoryRequest unlockRepositoryRequest)

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryManagementController

@ConstructorProperties("repositoryManagementService")
public RepositoryManagementController(RepositoryManagementService repositoryManagementService)

Method Detail

addRemote

@ResponseStatus(CREATED)
@PostMapping("/add_remote")
public Result addRemote(javax.servlet.http.HttpServletResponse response,
                        @Valid @RequestBody
                        @Valid RemoteRepository remoteRepository)
                 throws ServiceLayerException,
                        InvalidRemoteUrlException,
                        RemoteRepositoryNotFoundException

Throws:

ServiceLayerException

InvalidRemoteUrlException

RemoteRepositoryNotFoundException

listRemotes

@GetMapping(value="/list_remotes",
            produces="application/json")
public ResultList<RemoteRepositoryInfo> listRemotes(@RequestParam(name="siteId")
                                                    String siteId)
                                             throws ServiceLayerException

Throws:

ServiceLayerException

pullFromRemote

@PostMapping("/pull_from_remote")
public ResultOne<MergeResult> pullFromRemote(@Valid @RequestBody
                                             @Valid PullFromRemoteRequest pullFromRemoteRequest)
                                      throws InvalidRemoteUrlException,
                                             ServiceLayerException,
                                             InvalidRemoteRepositoryCredentialsException,
                                             RemoteRepositoryNotFoundException

Throws:

InvalidRemoteUrlException

ServiceLayerException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

pushToRemote

@PostMapping("/push_to_remote")
public Result pushToRemote(javax.servlet.http.HttpServletResponse response,
                           @Valid @RequestBody
                           @Valid PushToRemoteRequest pushToRemoteRequest)
                    throws InvalidRemoteUrlException,
                           ServiceLayerException,
                           InvalidRemoteRepositoryCredentialsException,
                           RemoteRepositoryNotFoundException

Throws:

InvalidRemoteUrlException

ServiceLayerException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

rebuildDatabase

@PostMapping("/rebuild_database")
public Result rebuildDatabase(@Valid @RequestBody
                              @Valid RebuildDatabaseRequest rebuildDatabaseRequest)
                       throws SiteNotFoundException

Throws:

SiteNotFoundException

removeRemote

@PostMapping("/remove_remote")
public Result removeRemote(javax.servlet.http.HttpServletResponse response,
                           @Valid @RequestBody
                           @Valid RemoveRemoteRequest removeRemoteRequest)
                    throws SiteNotFoundException,
                           RemoteNotRemovableException

Throws:

SiteNotFoundException

RemoteNotRemovableException

getRepositoryStatus

@GetMapping("/status")
public ResultOne<RepositoryStatus> getRepositoryStatus(@RequestParam("siteId")
                                                       String siteId)
                                                throws ServiceLayerException

Throws:

ServiceLayerException

resolveConflict

@PostMapping("/resolve_conflict")
public ResultOne<RepositoryStatus> resolveConflict(@Valid @RequestBody
                                                   @Valid ResolveConflictRequest resolveConflictRequest)
                                            throws ServiceLayerException

Throws:

ServiceLayerException

getDiffForConflictedFile

@GetMapping("/diff_conflicted_file")
public ResultOne<DiffConflictedFile> getDiffForConflictedFile(@RequestParam("siteId")
                                                              String siteId,
                                                              @RequestParam("path")
                                                              String path)
                                                       throws ServiceLayerException

Throws:

ServiceLayerException

commitConflictResolution

@PostMapping("/commit_resolution")
public ResultOne<RepositoryStatus> commitConflictResolution(@Valid @RequestBody
                                                            @Valid CommitResolutionRequest commitResolutionRequest)
                                                     throws ServiceLayerException

Throws:

ServiceLayerException

cancelFailedPull

@PostMapping("/cancel_failed_pull")
public ResultOne<RepositoryStatus> cancelFailedPull(@Valid @RequestBody
                                                    @Valid CancelFailedPullRequest cancelFailedPullRequest)
                                             throws ServiceLayerException

Throws:

ServiceLayerException

unlockRepository

@PostMapping("/unlock")
public Result unlockRepository(@Valid @RequestBody
                               @Valid UnlockRepositoryRequest unlockRepositoryRequest)
                        throws SiteNotFoundException

Throws:

SiteNotFoundException

isRepositoryCorrupted

@GetMapping("/corrupted")
public ResultOne<Boolean> isRepositoryCorrupted(@RequestParam(required=false)
                                                String siteId,
                                                @RequestParam
                                                GitRepositories repositoryType)
                                         throws ServiceLayerException

Throws:

ServiceLayerException

repairCorruptedRepository

@PostMapping("/repair")
public Result repairCorruptedRepository(@Valid @RequestBody
                                        @Valid RepairRepositoryRequest request)
                                 throws ServiceLayerException

Throws:

ServiceLayerException