org.openbaton.nfvo.api.RestVNFFG.java Source code

Introduction

Here is the source code for org.openbaton.nfvo.api.RestVNFFG.java

Source

/*
 * Copyright (c) 2015 Fraunhofer FOKUS
 *
 * 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.openbaton.nfvo.api;

import org.openbaton.catalogue.mano.descriptor.VNFForwardingGraphDescriptor;
import org.openbaton.nfvo.core.interfaces.VNFFGManagement;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@RestController
@RequestMapping("/api/v1//vnf-forwarding-graphs")
public class RestVNFFG {

    //   TODO add log prints
    //   private Logger log = LoggerFactory.getLogger(this.getClass());

    @Autowired
    @Qualifier("VNFFGManagement")
    private VNFFGManagement vnffgManagement;

    /**
     * Adds a new VNF software VNFFG to the vnfForwardingGraphDescriptor repository
     *
     * @param vnfForwardingGraphDescriptor : VNFFG to add
     * @return vnfForwardingGraphDescriptor: The vnfForwardingGraphDescriptor filled with values from
     * the core
     */
    @RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseStatus(HttpStatus.CREATED)
    public VNFForwardingGraphDescriptor create(
            @RequestBody @Valid VNFForwardingGraphDescriptor vnfForwardingGraphDescriptor) {
        return vnffgManagement.add(vnfForwardingGraphDescriptor);
    }

    /**
     * Removes the VNF software VNFFG from the VNFFG repository
     *
     * @param id : The VNFFG's id to be deleted
     */
    @RequestMapping(value = "{id}", method = RequestMethod.DELETE)
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void delete(@PathVariable("id") String id) {
        vnffgManagement.delete(id);
    }

    /**
     * Returns the list of the VNFFGs available
     *
     * @return List<VNFForwardingGraphDescriptor>: The list of VNFFGs available
     */
    @RequestMapping(method = RequestMethod.GET)
    public Iterable<VNFForwardingGraphDescriptor> findAll() {
        return vnffgManagement.query();
    }

    /**
     * Returns the VNFFG selected by id
     *
     * @param id : The id of the VNFFG
     * @return vnfForwardingGraphDescriptor: The VNFFG selected
     */
    @RequestMapping(value = "{id}", method = RequestMethod.GET)
    public VNFForwardingGraphDescriptor findById(@PathVariable("id") String id) {

        return vnffgManagement.query(id);
    }

    /**
     * Updates the VNF software vnfForwardingGraphDescriptor
     *
     * @param vnfForwardingGraphDescriptor : the VNF software vnfForwardingGraphDescriptor to be
     * updated
     * @param id : the id of VNF software vnfForwardingGraphDescriptor
     * @return networkServiceDescriptor: the VNF software vnfForwardingGraphDescriptor updated
     */
    @RequestMapping(value = "{id}", method = RequestMethod.PUT, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseStatus(HttpStatus.ACCEPTED)
    public VNFForwardingGraphDescriptor update(
            @RequestBody @Valid VNFForwardingGraphDescriptor vnfForwardingGraphDescriptor,
            @PathVariable("id") String id) {
        return vnffgManagement.update(vnfForwardingGraphDescriptor, id);
    }
}