org.apache.brooklyn.rest.api.EffectorApi Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.brooklyn.rest.api;

import java.util.List;
import java.util.Map;

import javax.validation.Valid;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
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.MediaType;
import javax.ws.rs.core.Response;

import org.apache.brooklyn.rest.domain.EffectorSummary;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@Path("/applications/{application}/entities/{entity}/effectors")
@Api("Entity Effectors")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface EffectorApi {

    @GET
    @ApiOperation(value = "Fetch the list of effectors",
            response = org.apache.brooklyn.rest.domain.EffectorSummary.class,
            responseContainer = "List")
    @ApiResponses(value = {
            @ApiResponse(code = 404, message = "Could not find application or entity")
    })
    public List list(
            @ApiParam(name = "application", value = "Application name", required = true)
            @PathParam("application") final String application,
            @ApiParam(name = "entity", value = "Entity name", required = true)
            @PathParam("entity") final String entityToken);

    @POST
    @Path("/{effector}")
    @ApiOperation(value = "Trigger an effector",
            notes="Returns the return value (status 200) if it completes, or an activity task ID (status 202) if it times out", response = String.class)
    @ApiResponses(value = {
            @ApiResponse(code = 404, message = "Could not find application, entity or effector")
    })
    @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_FORM_URLENCODED})
    public Response invoke(
            @ApiParam(name = "application", value = "Application ID or name", required = true)
            @PathParam("application") String application,
            
            @ApiParam(name = "entity", value = "Entity ID or name", required = true)
            @PathParam("entity") String entityToken,
            
            @ApiParam(name = "effector", value = "Name of the effector to trigger", required = true)
            @PathParam("effector") String effectorName,
            
            // TODO test timeout; and should it be header, form, or what?
            @ApiParam(name = "timeout", value = "Delay before server should respond with activity task ID rather than result (in millis if no unit specified): " +
                    "'never' (blocking) is default; " +
                    "'0' means 'always' return task activity ID; " +
                    "and e.g. '1000' or '1s' will return a result if available within one second otherwise status 202 and the activity task ID", 
                    required = false, defaultValue = "never")
            @QueryParam("timeout")
            String timeout,
            
            @ApiParam(/* FIXME: giving a `name` in swagger @ApiParam seems wrong as this object is the body, not a named argument */ name = "parameters",
                    value = "Effector parameters (as key value pairs)", required = false)
            @Valid 
            Map parameters);
}