Modify JavaDoc

Signed-off-by: SirWayne <dennis.melzer@bosch-si.com>
This commit is contained in:
SirWayne
2016-05-18 14:28:31 +02:00
parent 5bb24c78ad
commit 05615a9e86
24 changed files with 36 additions and 149 deletions

View File

@@ -24,7 +24,7 @@ public class DdiCancel {
* Parameterized constructor. * Parameterized constructor.
* *
* @param id * @param id
* of the {@link CancelAction} * of the cancel action
* @param cancelAction * @param cancelAction
* the action * the action
*/ */

View File

@@ -11,7 +11,7 @@ package org.eclipse.hawkbit.ddi.json.model;
import javax.validation.constraints.NotNull; import javax.validation.constraints.NotNull;
/** /**
* The {@link Action} that has to be stopped by the target. * The action that has to be stopped by the target.
*/ */
public class DdiCancelActionToStop { public class DdiCancelActionToStop {
@@ -22,7 +22,7 @@ public class DdiCancelActionToStop {
* Parameterized constructor. * Parameterized constructor.
* *
* @param stopId * @param stopId
* ID of the {@link Action} to be stoppedW * ID of the action to be stoppedW
*/ */
public DdiCancelActionToStop(final String stopId) { public DdiCancelActionToStop(final String stopId) {
super(); super();

View File

@@ -13,7 +13,7 @@ import java.util.List;
import com.fasterxml.jackson.annotation.JsonValue; import com.fasterxml.jackson.annotation.JsonValue;
/** /**
* Detailed {@link UpdateAction} information. * Detailed update action information.
*/ */
public class DdiDeployment { public class DdiDeployment {
@@ -57,7 +57,7 @@ public class DdiDeployment {
} }
/** /**
* The handling type for the update {@link Action}. * The handling type for the update action.
*/ */
public enum HandlingType { public enum HandlingType {

View File

@@ -15,7 +15,7 @@ import org.springframework.hateoas.ResourceSupport;
import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonProperty;
/** /**
* {@link UpdateAction} resource. * Update action resource.
*/ */
public class DdiDeploymentBase extends ResourceSupport { public class DdiDeploymentBase extends ResourceSupport {
@@ -30,7 +30,7 @@ public class DdiDeploymentBase extends ResourceSupport {
* Constructor. * Constructor.
* *
* @param id * @param id
* of the {@link UpdateAction} * of the update action
* @param deployment * @param deployment
* details. * details.
*/ */

View File

@@ -40,10 +40,9 @@ public interface DdiRootControllerRestApi {
* Returns all artifacts of a given software module and target. * Returns all artifacts of a given software module and target.
* *
* @param targetid * @param targetid
* of the {@link Target} that matches to * of the target that matches to controller id
* {@link Target#getControllerId()}
* @param softwareModuleId * @param softwareModuleId
* of the {@link SoftwareModule} * of the software module
* @return the response * @return the response
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetid}/softwaremodules/{softwareModuleId}/artifacts", produces = { @RequestMapping(method = RequestMethod.GET, value = "/{targetid}/softwaremodules/{softwareModuleId}/artifacts", produces = {
@@ -56,8 +55,7 @@ public interface DdiRootControllerRestApi {
* Root resource for an individual {@link Target}. * Root resource for an individual {@link Target}.
* *
* @param targetid * @param targetid
* of the {@link Target} that matches to * of the target that matches to controller id
* {@link Target#getControllerId()}
* @param request * @param request
* the HTTP request injected by spring * the HTTP request injected by spring
* @return the response * @return the response
@@ -71,11 +69,11 @@ public interface DdiRootControllerRestApi {
* partial (as specified by RFC7233 (Range Requests)) download request. * partial (as specified by RFC7233 (Range Requests)) download request.
* *
* @param targetid * @param targetid
* of the related * of the related target
* @param softwareModuleId * @param softwareModuleId
* of the parent {@link SoftwareModule} * of the parent software module
* @param fileName * @param fileName
* of the related {@link LocalArtifact} * of the related local artifact
* @param response * @param response
* of the servlet * of the servlet
* @param request * @param request
@@ -94,11 +92,11 @@ public interface DdiRootControllerRestApi {
* Handles GET {@link DdiArtifact} MD5 checksum file download request. * Handles GET {@link DdiArtifact} MD5 checksum file download request.
* *
* @param targetid * @param targetid
* of the related * of the related target
* @param softwareModuleId * @param softwareModuleId
* of the parent {@link SoftwareModule} * of the parent software module
* @param fileName * @param fileName
* of the related {@link LocalArtifact} * of the related local artifact
* @param response * @param response
* of the servlet * of the servlet
* @param request * @param request
@@ -114,14 +112,13 @@ public interface DdiRootControllerRestApi {
@PathVariable("fileName") final String fileName); @PathVariable("fileName") final String fileName);
/** /**
* Resource for {@link SoftwareModule} {@link UpdateAction}s. * Resource for software module.
* *
* @param targetid * @param targetid
* of the {@link Target} that matches to * of the target that matches to controller id
* {@link Target#getControllerId()}
* @param actionId * @param actionId
* of the {@link DdiDeploymentBase} that matches to * of the {@link DdiDeploymentBase} that matches to active
* {@link Target#getActiveActions()} * actions.
* @param resource * @param resource
* an hashcode of the resource which indicates if the action has * an hashcode of the resource which indicates if the action has
* been changed, e.g. from 'soft' to 'force' and the eTag needs * been changed, e.g. from 'soft' to 'force' and the eTag needs
@@ -143,8 +140,7 @@ public interface DdiRootControllerRestApi {
* @param feedback * @param feedback
* to provide * to provide
* @param targetid * @param targetid
* of the {@link Target} that matches to * of the target that matches to controller id
* {@link Target#getControllerId()}
* @param actionId * @param actionId
* of the action we have feedback for * of the action we have feedback for
* @param request * @param request
@@ -175,7 +171,7 @@ public interface DdiRootControllerRestApi {
@PathVariable("targetid") final String targetid); @PathVariable("targetid") final String targetid);
/** /**
* {@link RequestMethod.GET} method for the {@link DdiCancel} action. * RequestMethod.GET method for the {@link DdiCancel} action.
* *
* @param targetid * @param targetid
* ID of the calling target * ID of the calling target
@@ -192,8 +188,8 @@ public interface DdiRootControllerRestApi {
@PathVariable("actionId") @NotEmpty final Long actionId); @PathVariable("actionId") @NotEmpty final Long actionId);
/** /**
* {@link RequestMethod.POST} method receiving the {@link DdiActionFeedback} * RequestMethod.POST method receiving the {@link DdiActionFeedback} from
* from the target. * the target.
* *
* @param feedback * @param feedback
* the {@link DdiActionFeedback} from the target. * the {@link DdiActionFeedback} from the target.

View File

@@ -43,9 +43,8 @@ import org.springframework.web.context.WebApplicationContext;
* The {@link DdiArtifactStoreController} of the HawkBit server controller API * The {@link DdiArtifactStoreController} of the HawkBit server controller API
* that is queried by the HawkBit target in order to download artifacts * that is queried by the HawkBit target in order to download artifacts
* independent of their own individual resource. This is offered in addition to * independent of their own individual resource. This is offered in addition to
* the * the {@link DdiRootController#downloadArtifact(String, Long, String)} for
* {@link DdiRootController#downloadArtifact(String, Long, Long, javax.servlet.http.HttpServletResponse)} * legacy controllers that can not be fed with a download URI at runtime.
* for legacy controllers that can not be fed with a download URI at runtime.
*/ */
@RestController @RestController
@Scope(WebApplicationContext.SCOPE_REQUEST) @Scope(WebApplicationContext.SCOPE_REQUEST)

View File

@@ -24,12 +24,12 @@ import com.fasterxml.jackson.annotation.JsonProperty;
public class MgmtAction extends MgmtBaseEntity { public class MgmtAction extends MgmtBaseEntity {
/** /**
* API definition for {@link UpdateAction}. * API definition for update action}.
*/ */
public static final String ACTION_UPDATE = "update"; public static final String ACTION_UPDATE = "update";
/** /**
* API definition for {@link CancelAction}. * API definition for cancel action.
*/ */
public static final String ACTION_CANCEL = "cancel"; public static final String ACTION_CANCEL = "cancel";

View File

@@ -108,11 +108,7 @@ public class MgmtArtifact extends MgmtBaseEntity {
} }
/** /**
* Type maps to either {@link LocalArtifact} or {@link ExternalArtifact}. * Type maps to either local artifact} or external artifact.
*
*
*
*
*/ */
public enum ArtifactType { public enum ArtifactType {
LOCAL("local"), EXTERNAL("external"); LOCAL("local"), EXTERNAL("external");

View File

@@ -11,10 +11,7 @@ package org.eclipse.hawkbit.mgmt.json.model.distributionset;
import com.fasterxml.jackson.annotation.JsonValue; import com.fasterxml.jackson.annotation.JsonValue;
/** /**
* Definition of the {@link ActionType} for the REST management API. * Definition of the Action type for the REST management API.
*
*
*
* *
*/ */
public enum MgmtActionType { public enum MgmtActionType {
@@ -39,9 +36,6 @@ public enum MgmtActionType {
this.name = name; this.name = name;
} }
/**
* @return the name
*/
@JsonValue @JsonValue
public String getName() { public String getName() {
return name; return name;

View File

@@ -24,15 +24,15 @@ import com.fasterxml.jackson.annotation.JsonProperty;
@JsonIgnoreProperties(ignoreUnknown = true) @JsonIgnoreProperties(ignoreUnknown = true)
public class MgmtSoftwareModule extends MgmtNamedEntity { public class MgmtSoftwareModule extends MgmtNamedEntity {
/** /**
* API definition for {@link SoftwareModule.Type#RUNTIME}. * API definition for Software module type#RUNTIME.
*/ */
public static final String SM_RUNTIME = "runtime"; public static final String SM_RUNTIME = "runtime";
/** /**
* API definition for {@link SoftwareModule.Type#OS}. * API definition for for Software module type#OS.
*/ */
public static final String SM_OS = "os"; public static final String SM_OS = "os";
/** /**
* API definition for {@link SoftwareModule.Type#APPLICATION}. * API definition for for Software module type#APPLICATION.
*/ */
public static final String SM_APPLICATION = "application"; public static final String SM_APPLICATION = "application";

View File

@@ -68,8 +68,6 @@ public interface MgmtDistributionSetRestApi {
* *
* @return a single DistributionSet with status OK. * @return a single DistributionSet with status OK.
* *
* @throws EntityNotFoundException
* in case no DistributionSet with the given ID exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{distributionSetId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{distributionSetId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -298,9 +296,6 @@ public interface MgmtDistributionSetRestApi {
* the list of software modules ids to assign * the list of software modules ids to assign
* @return http status * @return http status
* *
* @throws EntityNotFoundException
* in case no distribution set with the given
* {@code distributionSetId} exists.
*/ */
@RequestMapping(method = RequestMethod.POST, value = "/{distributionSetId}/assignedSM", consumes = { @RequestMapping(method = RequestMethod.POST, value = "/{distributionSetId}/assignedSM", consumes = {
MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_JSON_VALUE,
@@ -318,9 +313,6 @@ public interface MgmtDistributionSetRestApi {
* the software module id to get rejected form the distribution * the software module id to get rejected form the distribution
* set * set
* @return status OK if rejection was successful. * @return status OK if rejection was successful.
* @throws EntityNotFoundException
* in case no distribution set with the given
* {@code distributionSetId} exists.
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = "/{distributionSetId}/assignedSM/{softwareModuleId}") @RequestMapping(method = RequestMethod.DELETE, value = "/{distributionSetId}/assignedSM/{softwareModuleId}")
ResponseEntity<Void> deleteAssignSoftwareModules(@PathVariable("distributionSetId") final Long distributionSetId, ResponseEntity<Void> deleteAssignSoftwareModules(@PathVariable("distributionSetId") final Long distributionSetId,
@@ -343,9 +335,6 @@ public interface MgmtDistributionSetRestApi {
* {@code field:direction, field:direction} * {@code field:direction, field:direction}
* @return a list of the assigned software modules of a distribution set * @return a list of the assigned software modules of a distribution set
* with status OK, if none is assigned than {@code null} * with status OK, if none is assigned than {@code null}
* @throws EntityNotFoundException
* in case no distribution set with the given
* {@code distributionSetId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{distributionSetId}/assignedSM", produces = { @RequestMapping(method = RequestMethod.GET, value = "/{distributionSetId}/assignedSM", produces = {
"application/hal+json", MediaType.APPLICATION_JSON_VALUE }) "application/hal+json", MediaType.APPLICATION_JSON_VALUE })

View File

@@ -64,9 +64,6 @@ public interface MgmtDistributionSetTagRestApi {
* the ID of the distribution set tag to retrieve * the ID of the distribution set tag to retrieve
* *
* @return a single distribution set tag with status OK. * @return a single distribution set tag with status OK.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{distributionsetTagId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{distributionsetTagId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -97,9 +94,6 @@ public interface MgmtDistributionSetTagRestApi {
* the the request body to be updated * the the request body to be updated
* @return status OK if update is successful and the updated distribution * @return status OK if update is successful and the updated distribution
* set tag. * set tag.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.PUT, value = "/{distributionsetTagId}", consumes = { "application/hal+json", @RequestMapping(method = RequestMethod.PUT, value = "/{distributionsetTagId}", consumes = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE })
@@ -113,9 +107,6 @@ public interface MgmtDistributionSetTagRestApi {
* @param distributionsetTagId * @param distributionsetTagId
* the ID of the distribution set tag * the ID of the distribution set tag
* @return status OK if delete as successfully. * @return status OK if delete as successfully.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
* *
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = "/{distributionsetTagId}") @RequestMapping(method = RequestMethod.DELETE, value = "/{distributionsetTagId}")
@@ -130,9 +121,6 @@ public interface MgmtDistributionSetTagRestApi {
* the ID of the distribution set tag * the ID of the distribution set tag
* *
* @return the list of assigned distribution sets. * @return the list of assigned distribution sets.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.GET, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING)
ResponseEntity<List<MgmtDistributionSet>> getAssignedDistributionSets( ResponseEntity<List<MgmtDistributionSet>> getAssignedDistributionSets(
@@ -149,9 +137,6 @@ public interface MgmtDistributionSetTagRestApi {
* *
* @return the list of assigned distribution sets and unassigned * @return the list of assigned distribution sets and unassigned
* distribution sets. * distribution sets.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING @RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING
+ "/toggleTagAssignment") + "/toggleTagAssignment")
@@ -168,9 +153,6 @@ public interface MgmtDistributionSetTagRestApi {
* list of distribution sets ids to be assigned * list of distribution sets ids to be assigned
* *
* @return the list of assigned distribution set. * @return the list of assigned distribution set.
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING)
ResponseEntity<List<MgmtDistributionSet>> assignDistributionSets( ResponseEntity<List<MgmtDistributionSet>> assignDistributionSets(
@@ -184,9 +166,6 @@ public interface MgmtDistributionSetTagRestApi {
* @param distributionsetTagId * @param distributionsetTagId
* the ID of the distribution set tag to retrieve * the ID of the distribution set tag to retrieve
* @return http status code * @return http status code
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING)
ResponseEntity<Void> unassignDistributionSets( ResponseEntity<Void> unassignDistributionSets(
@@ -201,9 +180,6 @@ public interface MgmtDistributionSetTagRestApi {
* @param distributionsetId * @param distributionsetId
* the ID of the distribution set to unassign * the ID of the distribution set to unassign
* @return http status code * @return http status code
* @throws EntityNotFoundException
* in case the given {@code distributionsetTagId} doesn't
* exists.
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING @RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.DISTRIBUTIONSET_REQUEST_MAPPING
+ "/{distributionsetId}") + "/{distributionsetId}")

View File

@@ -68,8 +68,6 @@ public interface MgmtDistributionSetTypeRestApi {
* the ID of the module type to retrieve * the ID of the module type to retrieve
* *
* @return a single softwareModule with status OK. * @return a single softwareModule with status OK.
* @throws EntityNotFoundException
* in case no with the given {@code softwareModuleId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{distributionSetTypeId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{distributionSetTypeId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })

View File

@@ -60,8 +60,6 @@ public interface MgmtRolloutRestApi {
* @param rolloutId * @param rolloutId
* the ID of the rollout to retrieve * the ID of the rollout to retrieve
* @return a single rollout with status OK. * @return a single rollout with status OK.
* @throws EntityNotFoundException
* in case no rollout with the given {@code rolloutId} exists.
*/ */
@RequestMapping(value = "/{rolloutId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_JSON_VALUE, @RequestMapping(value = "/{rolloutId}", method = RequestMethod.GET, produces = { MediaType.APPLICATION_JSON_VALUE,
"application/hal+json" }) "application/hal+json" })
@@ -76,7 +74,6 @@ public interface MgmtRolloutRestApi {
* status code 201 with the successfully created rollout. In any * status code 201 with the successfully created rollout. In any
* failure the JsonResponseExceptionHandler is handling the * failure the JsonResponseExceptionHandler is handling the
* response. * response.
* @throws EntityNotFoundException
*/ */
@RequestMapping(method = RequestMethod.POST, consumes = { "application/hal+json", @RequestMapping(method = RequestMethod.POST, consumes = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE })
@@ -89,9 +86,6 @@ public interface MgmtRolloutRestApi {
* the ID of the rollout to be started. * the ID of the rollout to be started.
* @return OK response (200) if rollout could be started. In case of any * @return OK response (200) if rollout could be started. In case of any
* exception the corresponding errors occur. * exception the corresponding errors occur.
* @throws EntityNotFoundException
* @see RolloutManagement#startRollout(Rollout)
* @see ResponseExceptionHandler
*/ */
@RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/start", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/start", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -105,9 +99,6 @@ public interface MgmtRolloutRestApi {
* the ID of the rollout to be paused. * the ID of the rollout to be paused.
* @return OK response (200) if rollout could be paused. In case of any * @return OK response (200) if rollout could be paused. In case of any
* exception the corresponding errors occur. * exception the corresponding errors occur.
* @throws EntityNotFoundException
* @see RolloutManagement#pauseRollout(Rollout)
* @see ResponseExceptionHandler
*/ */
@RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/pause", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/pause", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -120,9 +111,6 @@ public interface MgmtRolloutRestApi {
* the ID of the rollout to be resumed. * the ID of the rollout to be resumed.
* @return OK response (200) if rollout could be resumed. In case of any * @return OK response (200) if rollout could be resumed. In case of any
* exception the corresponding errors occur. * exception the corresponding errors occur.
* @throws EntityNotFoundException
* @see RolloutManagement#resumeRollout(Rollout)
* @see ResponseExceptionHandler
*/ */
@RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/resume", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.POST, value = "/{rolloutId}/resume", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -167,7 +155,6 @@ public interface MgmtRolloutRestApi {
* @param groupId * @param groupId
* the groupId to retrieve the rollout group * the groupId to retrieve the rollout group
* @return the OK response containing the MgmtRolloutGroupResponseBody * @return the OK response containing the MgmtRolloutGroupResponseBody
* @throws EntityNotFoundException
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{rolloutId}/deploygroups/{groupId}", produces = { @RequestMapping(method = RequestMethod.GET, value = "/{rolloutId}/deploygroups/{groupId}", produces = {
MediaType.APPLICATION_JSON_VALUE, "application/hal+json" }) MediaType.APPLICATION_JSON_VALUE, "application/hal+json" })

View File

@@ -143,8 +143,6 @@ public interface MgmtSoftwareModuleRestApi {
* the ID of the module to retrieve * the ID of the module to retrieve
* *
* @return a single softwareModule with status OK. * @return a single softwareModule with status OK.
* @throws EntityNotFoundException
* in case no with the given {@code softwareModuleId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{softwareModuleId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{softwareModuleId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })

View File

@@ -63,8 +63,6 @@ public interface MgmtSoftwareModuleTypeRestApi {
* the ID of the module type to retrieve * the ID of the module type to retrieve
* *
* @return a single softwareModule with status OK. * @return a single softwareModule with status OK.
* @throws EntityNotFoundException
* in case no with the given {@code softwareModuleId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{softwareModuleTypeId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{softwareModuleTypeId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })

View File

@@ -19,7 +19,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestMethod;
/** /**
* {@link SystemManagement} capabilities by REST. * System management capabilities by REST.
* *
*/ */
@RequestMapping(MgmtRestConstants.SYSTEM_ADMIN_MAPPING) @RequestMapping(MgmtRestConstants.SYSTEM_ADMIN_MAPPING)

View File

@@ -38,8 +38,6 @@ public interface MgmtTargetRestApi {
* @param targetId * @param targetId
* the ID of the target to retrieve * the ID of the target to retrieve
* @return a single target with status OK. * @return a single target with status OK.
* @throws EntityNotFoundException
* in case no target with the given {@code targetId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{targetId}", produces = { "application/hal+json",
@@ -127,8 +125,6 @@ public interface MgmtTargetRestApi {
* @param targetId * @param targetId
* the ID of the target to retrieve the attributes. * the ID of the target to retrieve the attributes.
* @return the target attributes as map response with status OK * @return the target attributes as map response with status OK
* @throws EntityNotFoundException
* in case no target with the given {@code targetId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetId}/attributes", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{targetId}/attributes", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -189,10 +185,6 @@ public interface MgmtTargetRestApi {
* @param force * @param force
* optional parameter, which indicates a force cancel * optional parameter, which indicates a force cancel
* @return status no content in case cancellation was successful * @return status no content in case cancellation was successful
* @throws CancelActionNotAllowedException
* if the given action is not active and cannot be canceled.
* @throws EntityNotFoundException
* if the target or the action is not found
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = "/{targetId}/actions/{actionId}") @RequestMapping(method = RequestMethod.DELETE, value = "/{targetId}/actions/{actionId}")
ResponseEntity<Void> cancelAction(@PathVariable("targetId") final String targetId, ResponseEntity<Void> cancelAction(@PathVariable("targetId") final String targetId,
@@ -236,8 +228,6 @@ public interface MgmtTargetRestApi {
* the ID of the target to retrieve the assigned distribution * the ID of the target to retrieve the assigned distribution
* @return the assigned distribution set with status OK, if none is assigned * @return the assigned distribution set with status OK, if none is assigned
* than {@code null} content (e.g. "{}") * than {@code null} content (e.g. "{}")
* @throws EntityNotFoundException
* in case no target with the given {@code targetId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetId}/assignedDS", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{targetId}/assignedDS", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -251,10 +241,6 @@ public interface MgmtTargetRestApi {
* @param dsId * @param dsId
* of the distributionset that is to be assigned * of the distributionset that is to be assigned
* @return http status * @return http status
*
* @throws EntityNotFoundException
* in case no target with the given {@code targetId} exists.
*
*/ */
@RequestMapping(method = RequestMethod.POST, value = "/{targetId}/assignedDS", consumes = { "application/hal+json", @RequestMapping(method = RequestMethod.POST, value = "/{targetId}/assignedDS", consumes = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE })
@@ -269,8 +255,6 @@ public interface MgmtTargetRestApi {
* the ID of the target to retrieve * the ID of the target to retrieve
* @return the assigned installed set with status OK, if none is installed * @return the assigned installed set with status OK, if none is installed
* than {@code null} content (e.g. "{}") * than {@code null} content (e.g. "{}")
* @throws EntityNotFoundException
* in case no target with the given {@code targetId} exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetId}/installedDS", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{targetId}/installedDS", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })

View File

@@ -64,8 +64,6 @@ public interface MgmtTargetTagRestApi {
* the ID of the target tag to retrieve * the ID of the target tag to retrieve
* *
* @return a single target tag with status OK. * @return a single target tag with status OK.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = "/{targetTagId}", produces = { "application/hal+json", @RequestMapping(method = RequestMethod.GET, value = "/{targetTagId}", produces = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE })
@@ -94,8 +92,6 @@ public interface MgmtTargetTagRestApi {
* @param restTargetTagRest * @param restTargetTagRest
* the the request body to be updated * the the request body to be updated
* @return status OK if update is successful and the updated target tag. * @return status OK if update is successful and the updated target tag.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.PUT, value = "/{targetTagId}", consumes = { "application/hal+json", @RequestMapping(method = RequestMethod.PUT, value = "/{targetTagId}", consumes = { "application/hal+json",
MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE }) MediaType.APPLICATION_JSON_VALUE }, produces = { "application/hal+json", MediaType.APPLICATION_JSON_VALUE })
@@ -108,8 +104,6 @@ public interface MgmtTargetTagRestApi {
* @param targetTagId * @param targetTagId
* the ID of the target tag * the ID of the target tag
* @return status OK if delete as successfully. * @return status OK if delete as successfully.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
* *
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = "/{targetTagId}") @RequestMapping(method = RequestMethod.DELETE, value = "/{targetTagId}")
@@ -123,8 +117,6 @@ public interface MgmtTargetTagRestApi {
* the ID of the target tag to retrieve * the ID of the target tag to retrieve
* *
* @return the list of assigned targets. * @return the list of assigned targets.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.GET, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.GET, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING)
ResponseEntity<List<MgmtTarget>> getAssignedTargets(@PathVariable("targetTagId") final Long targetTagId); ResponseEntity<List<MgmtTarget>> getAssignedTargets(@PathVariable("targetTagId") final Long targetTagId);
@@ -139,8 +131,6 @@ public interface MgmtTargetTagRestApi {
* list of target ids to be toggled * list of target ids to be toggled
* *
* @return the list of assigned targets and unassigned targets. * @return the list of assigned targets and unassigned targets.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING @RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING
+ "/toggleTagAssignment") + "/toggleTagAssignment")
@@ -157,8 +147,6 @@ public interface MgmtTargetTagRestApi {
* list of target ids to be assigned * list of target ids to be assigned
* *
* @return the list of assigned targets. * @return the list of assigned targets.
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.POST, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING)
ResponseEntity<List<MgmtTarget>> assignTargets(@PathVariable("targetTagId") final Long targetTagId, ResponseEntity<List<MgmtTarget>> assignTargets(@PathVariable("targetTagId") final Long targetTagId,
@@ -170,8 +158,6 @@ public interface MgmtTargetTagRestApi {
* @param targetTagId * @param targetTagId
* the ID of the target tag to retrieve * the ID of the target tag to retrieve
* @return http status code * @return http status code
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING) @RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING)
ResponseEntity<Void> unassignTargets(@PathVariable("targetTagId") final Long targetTagId); ResponseEntity<Void> unassignTargets(@PathVariable("targetTagId") final Long targetTagId);
@@ -184,8 +170,6 @@ public interface MgmtTargetTagRestApi {
* @param controllerId * @param controllerId
* the ID of the target to unassign * the ID of the target to unassign
* @return http status code * @return http status code
* @throws EntityNotFoundException
* in case the given {@code targetTagId} doesn't exists.
*/ */
@RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING @RequestMapping(method = RequestMethod.DELETE, value = MgmtRestConstants.TARGET_TAG_TAGERTS_REQUEST_MAPPING
+ "/{controllerId}") + "/{controllerId}")

View File

@@ -23,9 +23,6 @@ import org.springframework.stereotype.Controller;
* Annotation to enable {@link ComponentScan} in the resource package to setup * Annotation to enable {@link ComponentScan} in the resource package to setup
* all {@link Controller} annotated classes and setup the REST-Resources for the * all {@link Controller} annotated classes and setup the REST-Resources for the
* Management API. * Management API.
*
*
*
*/ */
@Target(ElementType.TYPE) @Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)

View File

@@ -53,10 +53,6 @@ public class MgmtDownloadArtifactResource implements MgmtDownloadArtifactRestApi
* of the parent SoftwareModule * of the parent SoftwareModule
* @param artifactId * @param artifactId
* of the related LocalArtifact * of the related LocalArtifact
* @param servletResponse
* of the servlet
* @param request
* of the client
* *
* @return responseEntity with status ok if successful * @return responseEntity with status ok if successful
*/ */

View File

@@ -58,8 +58,6 @@ public class MgmtDownloadResource implements MgmtDownloadRestApi {
* *
* @param downloadId * @param downloadId
* the generated download id * the generated download id
* @param response
* of the servlet
* @return {@link ResponseEntity} with status {@link HttpStatus#OK} if * @return {@link ResponseEntity} with status {@link HttpStatus#OK} if
* successful * successful
*/ */

View File

@@ -43,7 +43,7 @@ import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
/** /**
* REST Resource handling for {@link Tag} CRUD operations. * REST Resource handling for tag CRUD operations.
* *
*/ */
@RestController @RestController

View File

@@ -69,7 +69,7 @@ public final class RestResourceConversionHelper {
/** /**
* <p> * <p>
* Write response with target relation and publishes events concerning the * Write response with target relation and publishes events concerning the
* download progress based on given {@link UpdateActionStatus}. * download progress based on given update action status.
* </p> * </p>
* *
* <p> * <p>
@@ -89,9 +89,6 @@ public final class RestResourceConversionHelper {
* @param statusId * @param statusId
* of the UpdateActionStatus * of the UpdateActionStatus
* *
* @throws IOException
* in case of exceptions
*
* @return http code * @return http code
* *
* @see https://tools.ietf.org/html/rfc7233 * @see https://tools.ietf.org/html/rfc7233