ListDelegatedNewsResource.java
/*
* Copyright (C) 2000 - 2026 Silverpeas
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* As a special exception to the terms and conditions of version 3.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* Open Source Software ("FLOSS") applications as described in Silverpeas's
* FLOSS exception. You should have received a copy of the text describing
* the FLOSS exception, and it is also available here:
* "https://www.silverpeas.org/legal/floss_exception.html"
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package org.silverpeas.components.delegatednews.web;
import org.silverpeas.components.delegatednews.DelegatedNewsRuntimeException;
import org.silverpeas.components.delegatednews.model.DelegatedNews;
import org.silverpeas.components.delegatednews.service.DelegatedNewsService;
import org.silverpeas.core.admin.user.model.SilverpeasRole;
import org.silverpeas.core.annotation.WebService;
import org.silverpeas.core.web.rs.RESTWebService;
import org.silverpeas.core.web.rs.annotation.Authorized;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response.Status;
import java.util.List;
/**
* A REST Web resource representing a given delegated news. It is a web service that provides an
* access to a delegated news referenced by its URL.
*/
@WebService
@Path(ListDelegatedNewsResource.PATH + "/{instanceId}")
@Authorized
public class ListDelegatedNewsResource extends RESTWebService {
static final String PATH = "delegatednews";
@Inject
private DelegatedNewsService delegatednewsService;
@PathParam("instanceId")
private String instanceId;
/**
* Gets a business service on delegatedNews.
* @return a delegatedNews service instance.
*/
protected DelegatedNewsService getDelegatedNewsService() {
return this.delegatednewsService;
}
@Override
protected String getResourceBasePath() {
return PATH;
}
@Override
public String getComponentId() {
return this.instanceId;
}
/**
* Updates order or delete the delegatedNews from the JSON representation. If the user isn't
* authenticated, a 401 HTTP code is returned. If the user isn't authorized to save the delegated
* news, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is
* returned.
* @param newDelegatedNews an array of delegated news to update order or to delete
* @return the new list of delegated news after update or delete
*/
@PUT
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public DelegatedNewsEntity[] updateDelegatedNews(final DelegatedNewsEntity[] newDelegatedNews) {
checkIsManager();
DelegatedNewsEntity[] tabResult = new DelegatedNewsEntity[newDelegatedNews.length];
List<DelegatedNews> initialListDelegatedNews = getDelegatedNewsService().getAllDelegatedNews();
try {
if (initialListDelegatedNews.size() == newDelegatedNews.length) {// Update Order
tabResult = updateOrder(newDelegatedNews);
} else if (initialListDelegatedNews.size() > newDelegatedNews.length) {// Delete
deleteList(newDelegatedNews, initialListDelegatedNews);
tabResult = newDelegatedNews;
}
} catch (DelegatedNewsRuntimeException ex) {
throw new WebApplicationException(ex, Status.NOT_FOUND);
} catch (Exception ex) {
throw new WebApplicationException(ex, Status.SERVICE_UNAVAILABLE);
}
return tabResult;
}
/**
* Checks the user manages the delegated news, their modification and their deletion being
* reserved to the managers of this application. The authorization performed by the REST
* framework only validates the access to the component instance, whatever the role played in it,
* so it isn't enough here.
*/
void checkIsManager() {
final SilverpeasRole role = getHighestUserRole();
if (role == null || !role.isGreaterThanOrEquals(SilverpeasRole.ADMIN)) {
throw new WebApplicationException(Status.FORBIDDEN);
}
}
private void deleteList(final DelegatedNewsEntity[] newDelegatedNews,
List<DelegatedNews> initialListDelegatedNews) {
boolean found;
for (DelegatedNews delegatedNews : initialListDelegatedNews) {
String pubId = delegatedNews.getPubId();
found = false;
for (DelegatedNewsEntity delegatedNewsEntity : newDelegatedNews) {
// the new tab of DelegatedNewsEntity without the delegated news deleted
if (pubId.equals(delegatedNewsEntity.getPubId())) {
found = true;
break;
}
}
if (!found) {
getDelegatedNewsService().deleteDelegatedNews(pubId); // delete the delegatedNews
}
}
}
private DelegatedNewsEntity[] updateOrder(final DelegatedNewsEntity[] newDelegatedNews) {
DelegatedNewsEntity[] tabResult = new DelegatedNewsEntity[newDelegatedNews.length];
int order = 0;
for (DelegatedNewsEntity delegatedNewsEntity : newDelegatedNews) {
// the tab of DelegatedNewsEntity is in the new order
DelegatedNews delegatedNews = delegatedNewsEntity.toDelegatedNews();
DelegatedNews delegatedNewsUpdated =
getDelegatedNewsService().updateOrderDelegatedNews(delegatedNews.getPubId(), order);
tabResult[order] = DelegatedNewsEntity.fromDelegatedNews(delegatedNewsUpdated);
order++;
}
return tabResult;
}
}