package org.ff4j.web.api.resources;
/*
* #%L
* ff4j-web
* %%
* Copyright (C) 2013 - 2014 Ff4J
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import javax.annotation.security.RolesAllowed;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import org.ff4j.core.Feature;
import org.ff4j.core.FeatureStore;
import org.ff4j.exception.FeatureNotFoundException;
import org.ff4j.web.api.FF4jWebConstants;
import org.ff4j.utils.json.FeatureJsonParser;
/**
* Represent a feature as WebResource.
*
* @author <a href="mailto:cedrick.lunven@gmail.com">Cedrick LUNVEN</a>
*/
public class FeatureResource implements FF4jWebConstants {
/** current uri of the resource. */
@Context
private UriInfo uriInfo;
/** current http request. */
@Context
private Request request;
/** Reference to ff4j. */
private FeatureStore store;
/** Current Feature identifier. */
private String id;
/**
* Defaut constructor.
*/
public FeatureResource() {}
/**
* Constructor by Parent resource
*
* @param uriInfo
* current uriInfo
* @param request
* current request
*/
public FeatureResource(UriInfo uriInfo, Request request, String id, FeatureStore pstore) {
this.uriInfo = uriInfo;
this.request = request;
this.id = id;
this.store = pstore;
}
/**
* Allows to retrieve feature by its id.
*
* @param featId
* target feature identifier
* @return feature is exist
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@RolesAllowed({ROLE_READ})
public Response read() {
// if cannot be null due to state diagram (will list)
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
} else {
return Response.ok(getStore().read(id).toJson()).build();
}
}
/**
* Create the feature if not exist or update it
*
* @param headers
* current request header
* @param data
* feature serialized as JSON
* @return 204 or 201
*/
@PUT
@RolesAllowed({ROLE_WRITE})
public Response upsertFeature(@Context HttpHeaders headers, byte[] data) {
Feature feat = FeatureJsonParser.parseFeature(new String(data));
if (!getStore().exist(feat.getUid())) {
getStore().create(feat);
String location = String.format("%s/%s", uriInfo.getAbsolutePath().toString(), id);
return Response.status(Response.Status.CREATED).header(LOCATION, location).entity(id).build();
}
getStore().update(feat);
return Response.status(Response.Status.NO_CONTENT).build();
}
/**
* Delete feature by its id.
*
* @return delete by its id.
*/
@DELETE
@RolesAllowed({ROLE_WRITE})
public Response deleteFeature() {
if (id == null || "".equals(id)) {
return Response.status(Response.Status.BAD_REQUEST)
.entity("Invalid URL : Must be '/features/{id}' with {id} not null nor empty").build();
}
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
} else {
getStore().delete(id);
return Response.status(Response.Status.NO_CONTENT).build();
}
}
/**
* Convenient method to update partially the feature: Here enabling
*
* @return http response.
*/
@POST
@Path(OPERATION_ENABLE)
@RolesAllowed({ROLE_WRITE})
public Response operationEnable() {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
getStore().enable(id);
return Response.noContent().build();
}
/**
* Convenient method to update partially the feature: Here disabling
*
* @return http response.
*/
@POST
@Path(OPERATION_DISABLE)
@RolesAllowed({ROLE_WRITE})
public Response operationDisable() {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
getStore().disable(id);
return Response.noContent().build();
}
/**
* Convenient method to update partially the feature: Here grant a role
*
* @return http response.
*/
@POST
@Path(OPERATION_GRANTROLE)
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@RolesAllowed({ROLE_WRITE})
public Response operationGrantRole(MultivaluedMap<String, String> formParams) {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
if (!formParams.containsKey(POST_PARAMNAME_ROLENAME)) {
return Response.status(Response.Status.BAD_REQUEST).entity(POST_PARAMNAME_ROLENAME + " is a required POST parameter")
.build();
}
String roleName = formParams.getFirst(POST_PARAMNAME_ROLENAME);
getStore().grantRoleOnFeature(id, roleName);
return Response.noContent().build();
}
/**
* Convenient method to update partially the feature: Here removing a role
*
* @return http response.
*/
@POST
@Path(OPERATION_REMOVEROLE)
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@RolesAllowed({ROLE_WRITE})
public Response operationRemoveRole(MultivaluedMap<String, String> formParams) {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
if (!formParams.containsKey(POST_PARAMNAME_ROLENAME)) {
return Response.status(Response.Status.BAD_REQUEST).entity(POST_PARAMNAME_ROLENAME + " is a required POST parameter")
.build();
}
String roleName = formParams.getFirst(POST_PARAMNAME_ROLENAME);
getStore().removeRoleFromFeature(id, roleName);
return Response.noContent().build();
}
/**
* Convenient method to update partially the feature: Adding to a group
*
* @return http response.
*/
@POST
@Path(OPERATION_ADDGROUP)
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@RolesAllowed({ROLE_WRITE})
public Response operationAddGroup(MultivaluedMap<String, String> formParams) {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
if (!formParams.containsKey(POST_PARAMNAME_GROUPNAME)) {
return Response.status(Response.Status.BAD_REQUEST)
.entity(POST_PARAMNAME_GROUPNAME + " is a required POST parameter")
.build();
}
String groupName = formParams.getFirst(POST_PARAMNAME_GROUPNAME);
getStore().addToGroup(id, groupName);
return Response.noContent().build();
}
/**
* Convenient method to update partially the feature: Removing from a group
*
* @return http response.
*/
@POST
@Path(OPERATION_REMOVEGROUP)
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
@RolesAllowed({ROLE_WRITE})
public Response operationRemoveGroup(MultivaluedMap<String, String> formParams) {
if (!getStore().exist(id)) {
return Response.status(Response.Status.NOT_FOUND).entity(new FeatureNotFoundException(id).getMessage()).build();
}
if (!formParams.containsKey(POST_PARAMNAME_GROUPNAME)) {
return Response.status(Response.Status.BAD_REQUEST)
.entity(POST_PARAMNAME_GROUPNAME + " is a required POST parameter")
.build();
}
String groupName = formParams.getFirst(POST_PARAMNAME_GROUPNAME);
getStore().removeFromGroup(id, groupName);
return Response.noContent().build();
}
/**
* Getter accessor for attribute 'store'.
*
* @return current value of 'store'
*/
public FeatureStore getStore() {
return store;
}
}