ActorServices.java

/* Copyright 2014 MITRE Corporation
 *
 * 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.
 */
package org.mitre.provenance.services;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.mitre.provenance.PLUSException;
import org.mitre.provenance.client.AbstractProvenanceClient;
import org.mitre.provenance.client.LocalProvenanceClient;
import org.mitre.provenance.plusobject.PLUSActor;

import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;

/**
 * Actor services exposes RESTful services that allow users to interact with actors in the PLUS system.
 * @author moxious
 */
@Path("/actor")
@Api(value = "/actor", description = "Actors who are involved in provenance")
public class ActorServices {
	@Path("/{aid:.*}")
	@GET
	@Produces(MediaType.APPLICATION_JSON)
	@ApiOperation(value = "Get information about an actor", notes="", response=HashMap.class)
	@ApiResponses(value = {
	  @ApiResponse(code = 404, message = "Actor doesn't exist or can't be found")	  
	})			
	public Response getActor(@Context HttpServletRequest req,
			@ApiParam(value = "The ID of the actor", required=true) @PathParam("aid") String actorID) { 				
		try { 
			AbstractProvenanceClient client = new LocalProvenanceClient(ServiceUtility.getUser(req));
			PLUSActor a = client.actorExists(actorID);		
			if(a == null) return ServiceUtility.NOT_FOUND("No such actor " + actorID);		
			Map<String,Object> map = a.getStorableProperties();			
			return ServiceUtility.OK(map);
		} catch(PLUSException exc) { 
			exc.printStackTrace();
			return ServiceUtility.ERROR("Unable to fetch actor " + actorID + " please consult the systems administrator");
		} // End catch
	} // End getActor
	
	@Path("/name/{name:.*}")
	@GET
	@Produces(MediaType.APPLICATION_JSON)
	@ApiOperation(value = "Get information about an actor by name", notes="", response=HashMap.class)
	@ApiResponses(value = {
	  @ApiResponse(code = 404, message = "Actor doesn't exist or can't be found")	  
	})			
	public Response getActorByName(@Context HttpServletRequest req,
			@ApiParam(value = "The name of the actor", required=true) @PathParam("name") String actorName) { 				
		try { 
			AbstractProvenanceClient client = new LocalProvenanceClient(ServiceUtility.getUser(req));
			PLUSActor a = client.actorExistsByName(actorName);		
			if(a == null) return ServiceUtility.NOT_FOUND("No such actor named " + actorName);		
			Map<String,Object> map = a.getStorableProperties();			
			return ServiceUtility.OK(map);
		} catch(PLUSException exc) { 
			exc.printStackTrace();
			return ServiceUtility.ERROR("Unable to fetch actor by name " + actorName + " please consult the systems administrator");
		} // End catch
	} // End getActorByName	
} // End ActorServices