de.griefed.serverpackcreator.spring.serverpack

Class ServerPackController

java.lang.Object

de.griefed.serverpackcreator.spring.serverpack.ServerPackController

@RestController
 @CrossOrigin(origins="*")
 @RequestMapping(value="/api/v1/packs")
public class ServerPackController
extends java.lang.Object

RestController for everything server pack related, like downloads.
All requests are in /api/v1/packs.

Constructor Summary

Constructors

Constructor and Description
ServerPackController(ServerPackService injectedServerPackService) Constructor responsible for our DI.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<org.springframework.core.io.Resource>	downloadServerPack(int id) GET request for downloading a server pack by the id in the database.
org.springframework.http.ResponseEntity<java.util.List<ServerPackModel>>	getAllServerPacks() GET request for retrieving a list of all available server packs.
org.springframework.http.ResponseEntity<ServerPackModel>	getByFileID(int fileID) GET request for a server pack matching the given CurseForge fileID.
org.springframework.http.ResponseEntity<ServerPackModel>	getByFileID(java.lang.String specific) GET request for retrieving a server pack for a specific CurseForge projectID and fileID.
org.springframework.http.ResponseEntity<java.util.List<ServerPackModel>>	getByProjectID(int projectID) GET request for retrieving a list of server packs by CurseForge projectID.
org.springframework.http.ResponseEntity<java.lang.Object>	voteForServerPack(java.lang.String voting) GET request for voting whether a server pack works or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPackController

@Autowired
public ServerPackController(ServerPackService injectedServerPackService)

Constructor responsible for our DI.

Parameters:

injectedServerPackService - Instance of ServerPackService

Method Detail

downloadServerPack

@GetMapping(value="/download/{id}",
            produces="application/zip")
public org.springframework.http.ResponseEntity<org.springframework.core.io.Resource> downloadServerPack(@PathVariable
                                                                                                                                                                                    int id)

GET request for downloading a server pack by the id in the database.

Parameters:

id - Integer. The id of the server pack in the database.

Returns:

ResponseEntity Resource. Gives the requester the requested file as a download, if it was found.

getByProjectID

@GetMapping(value="project/{projectid}")
public org.springframework.http.ResponseEntity<java.util.List<ServerPackModel>> getByProjectID(@PathVariable(value="projectid")
                                                                                                                                        int projectID)

GET request for retrieving a list of server packs by CurseForge projectID.

Parameters:

projectID - Integer. The id of the CurseForge project.

Returns:

List ServerPackModel. A list of all server packs, if any, with the given CurseForge projectID.

getByFileID

@GetMapping(value="file/{fileid}")
public org.springframework.http.ResponseEntity<ServerPackModel> getByFileID(@PathVariable(value="fileid")
                                                                                                               int fileID)

GET request for a server pack matching the given CurseForge fileID.

Parameters:

fileID - Integer. The fileID of the CurseForge project for which to retrieve the server pack.

Returns:

ServerPackModel. The server pack for the corresponding CurseForge fileID, if it was found.

getAllServerPacks

@GetMapping(value="all")
public org.springframework.http.ResponseEntity<java.util.List<ServerPackModel>> getAllServerPacks()

GET request for retrieving a list of all available server packs.

Returns:

List ServerPackModel. A list of all available server packs on this instance.

getByFileID

@GetMapping(value="specific/{specific}")
public org.springframework.http.ResponseEntity<ServerPackModel> getByFileID(@PathVariable(value="specific")
                                                                                                                     java.lang.String specific)

GET request for retrieving a server pack for a specific CurseForge projectID and fileID.

Parameters:

specific - String. Comma seperated combination of CurseForge projectID and fileID.

Returns:

ServerPackModel. The server pack for the specified CurseForge projectID and fileID, if it was found.

voteForServerPack

@GetMapping(value="vote/{voting}")
public org.springframework.http.ResponseEntity<java.lang.Object> voteForServerPack(@PathVariable(value="voting")
                                                                                                                      java.lang.String voting)

GET request for voting whether a server pack works or not.

Parameters:

voting - String. The vote, consisting of the id of the server pack and whether the vote should be incremented or decremented. Example 42,up or 23,down.

Returns:

ResponseEntity OK/BadRequest/NotFound