de.cinovo.cloudconductor.api.interfaces.IService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudconductor-api Show documentation

Server to manage deployment environments

There is a newer version: 3.12

package de.cinovo.cloudconductor.api.interfaces;

/*
 * #%L
 * cloudconductor-api
 * %%
 * Copyright (C) 2013 - 2014 Cinovo AG
 * %%
 * 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 java.util.Map;

import javax.annotation.security.RolesAllowed;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import de.cinovo.cloudconductor.api.MediaType;
import de.cinovo.cloudconductor.api.model.Service;

/**
 * Copyright 2017 Cinovo AG

 * 

 *
 * @author psigloch
 */
@Path("/service")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface IService {
	
	/**
	 * @return set of service objects
	 */
	@GET
	@RolesAllowed({"VIEW_CONFIGURATIONS", "EDIT_CONFIGURATIONS"})
	Service[] get();
	
	/**
	 * @param service the service name
	 * @return the api object
	 */
	@GET
	@Path("/{service}")
	@RolesAllowed({"VIEW_CONFIGURATIONS", "EDIT_CONFIGURATIONS"})
	Service get(@PathParam("service") String service);
	
	/**
	 * @param apiObject the service object
	 */
	@PUT
	@RolesAllowed({"EDIT_CONFIGURATIONS"})
	void save(Service apiObject);
	
	/**
	 * @param service the service name
	 */
	@DELETE
	@Path("/{service}")
	@RolesAllowed({"EDIT_CONFIGURATIONS"})
	void delete(@PathParam("service") String service);
	
	/**
	 * @param service the service name
	 * @return map of template-package pairs
	 */
	@GET
	@Path("/{service}/usage")
	@Produces(MediaType.APPLICATION_JSON)
	@RolesAllowed({"VIEW_CONFIGURATIONS", "EDIT_CONFIGURATIONS"})
	Map getUsage(@PathParam("service") String service);
}