de.griefed.serverpackcreator.spring.curseforge

Class CurseService

java.lang.Object

de.griefed.serverpackcreator.spring.curseforge.CurseService

@Service
public class CurseService
extends java.lang.Object

CurseForge service for working with, retrieving, sending, generating, handling everything related to server packs/modpacks which make use of CurseForge or are made using CurseForge and their API.

Constructor Summary

Constructors

Constructor and Description
CurseService(ConfigurationHandler injectedConfigurationHandler, NotificationResponse injectedNotificationResponse, ApplicationProperties injectedApplicationProperties, ServerPackService injectedServerPackService, TaskSubmitter injectedTaskSubmitter) Constructor responsible for our DI.

Method Summary

Modifier and Type	Method and Description
java.lang.String	createFromCurseModpack(int projectID, int fileID) Check a passed CurseForge project and file ID combination.
java.lang.String	regenerateFromCurseModpack(java.lang.String modpack) Regenerates server pack for the given CurseForge project and file ID. Requires de.griefed.serverpackcreator.spring.cursecontroller.regenerate.enabled=true, otherwise a message is returned telling the requester that regeneration is disabled on this instance of ServerPackCreator.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurseService

@Autowired
public CurseService(ConfigurationHandler injectedConfigurationHandler,
                               NotificationResponse injectedNotificationResponse,
                               ApplicationProperties injectedApplicationProperties,
                               ServerPackService injectedServerPackService,
                               TaskSubmitter injectedTaskSubmitter)

Constructor responsible for our DI.

Parameters:

injectedConfigurationHandler - Instance of ConfigurationHandler.

injectedNotificationResponse - Instance of NotificationResponse.

injectedApplicationProperties - Instance of ApplicationProperties.

injectedServerPackService - Instance of ServerPackService.

injectedTaskSubmitter - Instance of TaskSubmitter.

Method Detail

createFromCurseModpack

public java.lang.String createFromCurseModpack(int projectID,
                                               int fileID)
                                        throws com.therandomlabs.curseapi.CurseException

Check a passed CurseForge project and file ID combination. Checks whether a server pack is already for the given combination and then checks their status and returns it wrapped in a NotificationResponse. If a server pack is not available for the given combination, a scan task is sent to TaskSubmitter.scanCurseProject(String) with the given CurseForge project and file ID combination.

Parameters:

projectID - Integer. CurseForge projectID.

fileID - Integer. CurseForge fileID.

Returns:

String. Returns a NotificationResponse with some information about the requested project and file, as well as the status, which is either of Status 0: Already exists, Status 1: OK, generating or Status 2: Error occurred.

Throws:

com.therandomlabs.curseapi.CurseException - Exception thrown if an error occurs during the acquisition of information from CurseForge.

regenerateFromCurseModpack

public java.lang.String regenerateFromCurseModpack(java.lang.String modpack)

Regenerates server pack for the given CurseForge project and file ID.
Requires de.griefed.serverpackcreator.spring.cursecontroller.regenerate.enabled=true, otherwise a message is returned telling the requester that regeneration is disabled on this instance of ServerPackCreator.

Parameters:

modpack - CurseForge projectID and fileID combination.

Returns:

String. Returns a NotificationResponse.curseResponse(String, int, String, int, String, String) telling the requester the status of their request.