de.griefed.serverpackcreator.spring.zip

Class ZipController

java.lang.Object

de.griefed.serverpackcreator.spring.zip.ZipController

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

RestController responsible for handling ZIP-archive uploads and server pack generation from the very same.

Constructor Summary

Constructors

Constructor and Description
ZipController(ZipService injectedZipService, ConfigurationHandler injectedConfigurationHandler, NotificationResponse injectedNotificationResponse) Constructor responsible for DI.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<java.lang.String>	handleFileUpload(org.springframework.web.multipart.MultipartFile file) Upload a file and check whether it is a ServerPackCreator valid ZIP-archive.
org.springframework.http.ResponseEntity<java.lang.String>	requestGenerationFromZip(java.lang.String zipName, java.lang.String clientMods, java.lang.String minecraftVersion, java.lang.String modLoader, java.lang.String modLoaderVersion, boolean installModloaderServer) Request the generation of a server pack from a previously uploaded ZIP-archive, which passed validation checks, and from a barebones configuration, including: clientMods minecraftVersion modLoader modLoaderVersion installModloaderServer

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipController

@Autowired
public ZipController(ZipService injectedZipService,
                                ConfigurationHandler injectedConfigurationHandler,
                                NotificationResponse injectedNotificationResponse)

Constructor responsible for DI.

Parameters:

injectedZipService - Instance of ZipService.

injectedConfigurationHandler - Instance of ConfigurationHandler.

injectedNotificationResponse - Instance of NotificationResponse.

Method Detail

handleFileUpload

@PostMapping(value="/upload")
public org.springframework.http.ResponseEntity<java.lang.String> handleFileUpload(@RequestParam(value="file")
                                                                                                                org.springframework.web.multipart.MultipartFile file)
                                                                                                         throws java.io.IOException

Upload a file and check whether it is a ServerPackCreator valid ZIP-archive.

Parameters:

file - MultipartFile The file uploaded to ServerPackCreator.

Returns:

String List. A list on encountered errors, if any.

Throws:

java.io.IOException - if an errors occurred saving or reading the file.

requestGenerationFromZip

@GetMapping(value="/{zipName}&{clientMods}&{minecraftVersion}&{modLoader}&{modLoaderVersion}&{installModloaderServer}")
public org.springframework.http.ResponseEntity<java.lang.String> requestGenerationFromZip(@PathVariable(value="zipName")
                                                                                                                                                                                                                  java.lang.String zipName,
                                                                                                                                                                                                                  @PathVariable(value="clientMods")
                                                                                                                                                                                                                  java.lang.String clientMods,
                                                                                                                                                                                                                  @PathVariable(value="minecraftVersion")
                                                                                                                                                                                                                  java.lang.String minecraftVersion,
                                                                                                                                                                                                                  @PathVariable(value="modLoader")
                                                                                                                                                                                                                  java.lang.String modLoader,
                                                                                                                                                                                                                  @PathVariable(value="modLoaderVersion")
                                                                                                                                                                                                                  java.lang.String modLoaderVersion,
                                                                                                                                                                                                                  @PathVariable(value="installModloaderServer")
                                                                                                                                                                                                                  boolean installModloaderServer)

Request the generation of a server pack from a previously uploaded ZIP-archive, which passed validation checks, and from a barebones configuration, including:
clientMods
minecraftVersion
modLoader
modLoaderVersion
installModloaderServer

Parameters:

zipName - String The name of the previously uploaded ZIP-archive.

clientMods - String A comma separated list of clientside-only mods to exclude from the server pack.

minecraftVersion - String The Minecraft version the modpack, and therefor the server pack, uses.

modLoader - String The modloader the modpack, and therefor the server pack, uses.

modLoaderVersion - String The modloader version the modpack, and therefor the server pack, uses.

installModloaderServer - Boolean Whether to install the modloader server in the server pack.

Returns:

NotificationResponse with information about the result.