Skip to content

Commit

Permalink
Lint Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@fdaugan
fdaugan committed Feb 24, 2024
1 parent 9c031c2 commit 3b81203
Showing 1 changed file with 20 additions and 38 deletions.
58 changes: 20 additions & 38 deletions plugin-core/src/main/java/org/ligoj/app/resource/subscription/SubscriptionResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public static Subscription toEntity(final SubscriptionEditionVo vo, final Projec
*
* @param id The subscription identifier.
* @return secured associated parameters values. Key of returned map is the identifier of
* {@link org.ligoj.app.model.Parameter}
* {@link org.ligoj.app.model.Parameter}
*/
@GET
@Path("{id:\\d+}")
Expand Down Expand Up @@ -133,7 +133,7 @@ public ConfigurationVo getConfiguration(@PathParam("id") final int id) throws Ex
*
* @param id The subscription identifier.
* @return all associated parameters values. Key of returned map is the identifier of
* {@link org.ligoj.app.model.Parameter}
* {@link org.ligoj.app.model.Parameter}
*/
@org.springframework.transaction.annotation.Transactional(readOnly = true)
public Map<String, String> getParameters(final int id) {
Expand All @@ -147,7 +147,7 @@ public Map<String, String> getParameters(final int id) {
*
* @param id The subscription identifier.
* @return all associated parameters values. Key of returned map is the identifier of
* {@link org.ligoj.app.model.Parameter}
* {@link org.ligoj.app.model.Parameter}
*/
@org.springframework.transaction.annotation.Transactional(readOnly = true)
public Map<String, String> getParametersNoCheck(final int id) {
Expand Down Expand Up @@ -198,8 +198,7 @@ public int create(final SubscriptionEditionVo vo) throws Exception {
* @throws Exception When the link/create fails. Managed at upper level.
*/
private void delegateToPlugin(final SubscriptionEditionVo vo, final Subscription entity) throws Exception {
for (var p = locator.getResource(vo.getNode()); p != null; p = locator
.getResource(locator.getParent(p.getKey()))) {
for (var p = locator.getResource(vo.getNode()); p != null; p = locator.getResource(locator.getParent(p.getKey()))) {
if (vo.getMode() == SubscriptionMode.CREATE) {
// Create mode
p.create(entity.getId());
Expand Down Expand Up @@ -230,8 +229,7 @@ private List<Parameter> checkInputParameters(final SubscriptionEditionVo vo) {
*/
private Node checkManagedNodeForSubscription(final String node) {
// Check the node can be subscribed by the principal user
final var entity = Optional.ofNullable(nodeRepository.findOneForSubscription(node, securityHelper.getLogin()))
.orElseThrow(() -> new ValidationJsonException("node", BusinessException.KEY_UNKNOWN_ID, "0", node));
final var entity = Optional.ofNullable(nodeRepository.findOneForSubscription(node, securityHelper.getLogin())).orElseThrow(() -> new ValidationJsonException("node", BusinessException.KEY_UNKNOWN_ID, "0", node));

// Check the node accept subscription
if (entity.getMode() == SubscriptionMode.NONE) {
Expand All @@ -247,20 +245,15 @@ private Node checkManagedNodeForSubscription(final String node) {
* @param acceptedParameters The accepted parameters.
* @param mode The related mode.
*/
protected void checkMandatoryParameters(final List<ParameterValueCreateVo> parameters,
final List<Parameter> acceptedParameters, final SubscriptionMode mode) {
protected void checkMandatoryParameters(final List<ParameterValueCreateVo> parameters, final List<Parameter> acceptedParameters, final SubscriptionMode mode) {
// Check each mandatory parameter for the current mode
acceptedParameters.stream()
.filter(parameter -> (parameter.getMode() == mode || parameter.getMode() == SubscriptionMode.ALL)
&& parameter.isMandatory())
.forEach(parameter -> checkMandatoryParameter(parameters, parameter));
acceptedParameters.stream().filter(parameter -> (parameter.getMode() == mode || parameter.getMode() == SubscriptionMode.ALL) && parameter.isMandatory()).forEach(parameter -> checkMandatoryParameter(parameters, parameter));
}

/**
* Check mandatory parameter is provided.
*/
private void checkMandatoryParameter(final Collection<ParameterValueCreateVo> parameters,
final Persistable<String> parameter) {
private void checkMandatoryParameter(final Collection<ParameterValueCreateVo> parameters, final Persistable<String> parameter) {
// This parameter must exist
if (parameters.stream().noneMatch(value -> value.getParameter().equals(parameter.getId()))) {
// Missing mandatory parameter
Expand Down Expand Up @@ -291,8 +284,7 @@ public void delete(@PathParam("id") final int id) throws Exception {
*/
@Path("{id:\\d+}/{deleteRemoteData}")
@DELETE
public void delete(@PathParam("id") final int id, @PathParam("deleteRemoteData") final boolean deleteRemoteData)
throws Exception {
public void delete(@PathParam("id") final int id, @PathParam("deleteRemoteData") final boolean deleteRemoteData) throws Exception {
final var entity = checkVisible(id);
checkManagedProject(entity.getProject().getId());

Expand All @@ -306,8 +298,7 @@ public void delete(@PathParam("id") final int id, @PathParam("deleteRemoteData")
}

@Override
protected void delete(final ServicePlugin plugin, final Integer id, final boolean deleteRemoteData)
throws Exception {
protected void delete(final ServicePlugin plugin, final Integer id, final boolean deleteRemoteData) throws Exception {
plugin.delete(id, deleteRemoteData);
}

Expand Down Expand Up @@ -349,8 +340,8 @@ public Subscription checkVisible(final Integer id) {
}

/**
* Return all subscriptions and related nodes. Very light data are returned there since a lot of subscriptions
* there. Parameters values are not fetch.
* Return all subscriptions and related nodes. Very light data is returned there due the large number of subscriptions.
* Parameters values are not fetch.
*
* @return Status of each subscription of each project and each node.
*/
Expand Down Expand Up @@ -383,20 +374,17 @@ public SubscriptionListVo findAll() {
/**
* Extract the distinct nodes from the subscriptions.
*/
private Map<String, SubscribedNodeVo> toNodes(final Map<String, NodeVo> nodes,
final Collection<SubscriptionLightVo> subscriptions) {
private Map<String, SubscribedNodeVo> toNodes(final Map<String, NodeVo> nodes, final Collection<SubscriptionLightVo> subscriptions) {
final var filteredNodes = new TreeMap<String, SubscribedNodeVo>();
// Add the related node of each subscription
subscriptions.stream().map(SubscriptionLightVo::getNode).map(nodes::get)
.forEach(n -> addNodeAsNeeded(filteredNodes, nodes, n));
subscriptions.stream().map(SubscriptionLightVo::getNode).map(nodes::get).forEach(n -> addNodeAsNeeded(filteredNodes, nodes, n));
return filteredNodes;
}

/**
* Convert the subscriptions result set to {@link SubscriptionLightVo}
*/
private Collection<SubscriptionLightVo> toSubscriptions(final List<Object[]> subscriptions,
final Map<Integer, SubscribingProjectVo> projects) {
private Collection<SubscriptionLightVo> toSubscriptions(final List<Object[]> subscriptions, final Map<Integer, SubscribingProjectVo> projects) {
// Prepare the subscriptions container with project name ordering
return subscriptions.stream().filter(rs -> projects.containsKey(rs[1])).map(rs -> {
// Build the subscription data
Expand All @@ -405,10 +393,7 @@ private Collection<SubscriptionLightVo> toSubscriptions(final List<Object[]> sub
vo.setProject((Integer) rs[1]);
vo.setNode((String) rs[2]);
return vo;
}).collect(
() -> new TreeSet<>((o1, o2) -> (projects.get(o1.getProject()).getName() + "," + o1.getId())
.compareToIgnoreCase(projects.get(o2.getProject()).getName() + "," + o2.getId())),
TreeSet::add, TreeSet::addAll);
}).collect(() -> new TreeSet<>((o1, o2) -> (projects.get(o1.getProject()).getName() + "," + o1.getId()).compareToIgnoreCase(projects.get(o2.getProject()).getName() + "," + o2.getId())), TreeSet::add, TreeSet::addAll);
}

/**
Expand All @@ -430,8 +415,7 @@ private Map<Integer, SubscribingProjectVo> toProjects(final List<Object[]> proje
/**
* Add a node to the filtered nodes, and also add recursively the parent.
*/
private void addNodeAsNeeded(final Map<String, SubscribedNodeVo> filteredNodes, final Map<String, NodeVo> allNodes,
final NodeVo node) {
private void addNodeAsNeeded(final Map<String, SubscribedNodeVo> filteredNodes, final Map<String, NodeVo> allNodes, final NodeVo node) {
if (!filteredNodes.containsKey(node.getId())) {

// Build the node wrapper
Expand Down Expand Up @@ -464,8 +448,7 @@ private void addNodeAsNeeded(final Map<String, SubscribedNodeVo> filteredNodes,
@GET
@org.springframework.transaction.annotation.Transactional(readOnly = true)
public Map<Integer, EventVo> getStatusByProject(@PathParam("project") final int project) {
return eventRepository.findLastEvents(project).stream().map(EventResource::toVo)
.collect(Collectors.toMap(EventVo::getSubscription, Function.identity()));
return eventRepository.findLastEvents(project).stream().map(EventResource::toVo).collect(Collectors.toMap(EventVo::getSubscription, Function.identity()));
}

/**
Expand All @@ -491,8 +474,7 @@ public SubscriptionStatusWithData refreshStatus(@PathParam("id") final int id) {
@Path("status/refresh")
@GET
public Map<Integer, SubscriptionStatusWithData> refreshStatuses(@QueryParam("id") final Set<Integer> ids) {
return ids.stream().map(this::refreshStatus)
.collect(Collectors.toMap(SubscriptionStatusWithData::getId, Function.identity()));
return ids.stream().map(this::refreshStatus).collect(Collectors.toMap(SubscriptionStatusWithData::getId, Function.identity()));
}

/**
Expand All @@ -512,7 +494,7 @@ private SubscriptionStatusWithData refreshSubscription(final Subscription subscr
return statusWithData;
}

@SuppressWarnings({ "unchecked", "rawtypes" })
@SuppressWarnings({"unchecked", "rawtypes"})
@Override
protected Class<? extends LongTaskRunner<?, ?, ?, Integer, ?, AbstractLockedResource<Subscription, Integer>>> getLongTaskRunnerClass() {
return (Class) LongTaskRunnerSubscription.class;
Expand Down

0 comments on commit 3b81203

Please sign in to comment.