package org.gcube.gcat.rest.administration; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.DefaultValue; import javax.ws.rs.GET; //import javax.ws.rs.NotAuthorizedException; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.Response; import javax.xml.ws.WebServiceException; //import org.gcube.common.authorization.control.annotations.AuthorizationControl; import org.gcube.gcat.annotation.PATCH; import org.gcube.gcat.annotation.PURGE; import org.gcube.gcat.api.GCatConstants; //import org.gcube.gcat.api.roles.Role; import org.gcube.gcat.persistence.ckan.CKANOrganization; import org.gcube.gcat.rest.REST; import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * This concept is mutated by Ckan which is used as underling technology to persist items. * * Only Catalogue-Admins or above are able to invoke non-safe methods. * * @author Luca Frosini (ISTI - CNR) */ @Path(Organization.ORGANIZATIONS) @ResourceGroup("Administration APIs") @ResourceLabel("Organization APIs") public class Organization extends REST implements org.gcube.gcat.api.interfaces.Organization { public static final String ORGANIZATION_ID_PARAMETER = "ORGANIZATION_ID"; public Organization() { super(ORGANIZATIONS, ORGANIZATION_ID_PARAMETER, CKANOrganization.class); } /* * Not used as REST method, implemented to respect {@link org.gcube.gcat.api.interfaces.Item} interface */ @Override public int count() throws WebServiceException { CKANOrganization ckan = getInstance(); return ckan.count(); } @GET @Produces(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) // @AuthorizationControl(allowedRoles={Role.CATALOGUE_EDITOR, Role.CATALOGUE_ADMIN, Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public String list(@QueryParam(GCatConstants.LIMIT_QUERY_PARAMETER) @DefaultValue("10") int limit, @QueryParam(GCatConstants.OFFSET_QUERY_PARAMETER) @DefaultValue("0") int offset, @QueryParam(GCatConstants.COUNT_QUERY_PARAMETER) @DefaultValue("false") Boolean countOnly) { if(countOnly) { int count = count(); return createCountJson(count); }else { return list(limit, offset); } } /* * Not used as REST method, implemented to respect {@link org.gcube.gcat.api.interfaces.Item} interface */ @Override public String list(@QueryParam(GCatConstants.LIMIT_QUERY_PARAMETER) @DefaultValue("10") int limit, @QueryParam(GCatConstants.OFFSET_QUERY_PARAMETER) @DefaultValue("0") int offset) { return super.list(limit, offset); } /** * An Organization is mainly described by the following attributes (* indicate mandatory attributes): * *
* *
name* (string)
*
* the name of the organization, a string between 2 and 100 characters long, * containing only lowercase alphanumeric characters, '-' and '_' ; *
* *
id (string)
*
the id of the organization;
* *
title (string)
*
the title of the organization;
* *
description (string)
*
the description of the organization;
* *
image_url (string)
*
the URL to an image to be displayed on the organization's page;
* *
state (string, default: 'active')
*
* the current state of the organization, e.g. 'active' or 'deleted', * only active organizations show up in search results and other lists of organizations, * this parameter will be ignored if you are not authorized * to change the state of the organization; *
* *
extras (list of dataset extra dictionaries)
*
* the organization's extras, extras are arbitrary (key: value) * metadata that can be added to organizations, * each extra dictionary should have keys 'key' (a string), * 'value' (a string), and optionally 'deleted'. *
* *
*/ @POST @Consumes(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Produces(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Override // @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public Response create(String json) { return super.create(json); } @GET @Path("/{" + ORGANIZATION_ID_PARAMETER + "}") @Produces(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Override // @AuthorizationControl(allowedRoles={Role.CATALOGUE_EDITOR, Role.CATALOGUE_ADMIN, Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public String read(@PathParam(ORGANIZATION_ID_PARAMETER) String id) { return super.read(id); } @PUT @Path("/{" + ORGANIZATION_ID_PARAMETER + "}") @Consumes(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Produces(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Override // @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public String update(@PathParam(ORGANIZATION_ID_PARAMETER) String id, String json) { return super.update(id, json); } @PATCH @Path("/{" + ORGANIZATION_ID_PARAMETER + "}") @Consumes(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Produces(GCatConstants.APPLICATION_JSON_CHARSET_UTF_8) @Override // @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public String patch(@PathParam(ORGANIZATION_ID_PARAMETER) String id, String json) { return super.patch(id, json); } @DELETE @Path("/{" + ORGANIZATION_ID_PARAMETER + "}") @Override // @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public Response delete(@PathParam(ORGANIZATION_ID_PARAMETER) String id, @QueryParam(GCatConstants.PURGE_QUERY_PARAMETER) @DefaultValue("false") Boolean purge) { return super.delete(id, purge); } @PURGE @Path("/{" + ORGANIZATION_ID_PARAMETER + "}") // @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class) public Response purge(@PathParam(ORGANIZATION_ID_PARAMETER) String id) { return super.purge(id); } }