Package edu.ucsb.cs156.frontiers.controllers

Class RepositoryController

java.lang.Object

edu.ucsb.cs156.frontiers.controllers.ApiController

edu.ucsb.cs156.frontiers.controllers.RepositoryController

@RestController
@RequestMapping("/api/repos")
public class RepositoryController
extends ApiController

Constructor Summary

Constructors

Constructor	Description
RepositoryController()

Method Summary

Modifier and Type	Method	Description
Job	createRepos(Long courseId, String repoPrefix, Optional<Boolean> isPrivate, RepositoryPermissions permissions, RepositoryCreationOption creationOption)	Fires a job that creates a repo for every RosterStudent with a linked user with a GitHub account.
Job	createTeamRepos(Long courseId, String repoPrefix, Optional<Boolean> isPrivate, RepositoryPermissions permissions)	Fires a job that creates team repos shared by all TeamMembers of each Team in a Course .

Methods inherited from class edu.ucsb.cs156.frontiers.controllers.ApiController

doesCurrentUserHaveRole, genericMessage, getCurrentUser, handleEntityNotFoundException, handleIllegalArgument, handleNoLinkedOrgException, handleUnsupportedOperation, handleValidationException, isCurrentUserAdmin

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryController

public RepositoryController()

Method Details

createRepos

@PostMapping("/createRepos")
@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
public Job createRepos(@RequestParam
 Long courseId,
 @RequestParam
 String repoPrefix,
 @RequestParam
 Optional<Boolean> isPrivate,
 @RequestParam
 RepositoryPermissions permissions,
 @RequestParam(required=false,defaultValue="STUDENTS_ONLY")
 RepositoryCreationOption creationOption)

Fires a job that creates a repo for every RosterStudent with a linked user with a GitHub account.

Parameters:

courseId - ID of course to create repos for

repoPrefix - each repo created will begin with this prefix, followed by a dash and the student's GitHub username

isPrivate - determines whether the repository being created is private

Returns:

the Job started to create the repos.

createTeamRepos

@PostMapping("/createTeamRepos")
@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
public Job createTeamRepos(@RequestParam
 Long courseId,
 @RequestParam
 String repoPrefix,
 @RequestParam
 Optional<Boolean> isPrivate,
 @RequestParam
 RepositoryPermissions permissions)

Fires a job that creates team repos shared by all TeamMembers of each Team in a Course .

Parameters:

courseId - ID of course to create team repos for

repoPrefix - each team repo created will begin with this prefix, followed by a dash and the team's name

isPrivate - determines whether the repository being created is private

Returns:

the Job started to create the repos.