org.opentravel.otm.forum2016.am.CreateAPIDocumentOperation.java Source code

Introduction

Here is the source code for org.opentravel.otm.forum2016.am.CreateAPIDocumentOperation.java

Source

/**
 * Copyright (C) 2016 OpenTravel Alliance (info@opentravel.org)
 *
 * 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.opentravel.otm.forum2016.am;

import java.io.IOException;
import java.util.Map;

import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.opentravel.otm.forum2016.APIPublisherConfig;

import com.google.gson.Gson;

/**
 * Creates a document that is associated with an API.
 * 
 * @author S. Livezey
 */
public class CreateAPIDocumentOperation extends RESTClientOperation<APIDocument> {

    private String apiId;
    private APIDocument document;

    /**
     * Constructor that assigns the factory that created this operation.
     * 
     * @param factory  the factory that created this operation
     */
    public CreateAPIDocumentOperation(APIOperationFactory factory) {
        super(factory);
    }

    /**
     * @see org.opentravel.otm.forum2016.am.RESTClientOperation#execute()
     */
    @Override
    public APIDocument execute() throws IOException {
        HttpPost request = new HttpPost(
                APIPublisherConfig.getWSO2PublisherApiBaseUrl() + "/" + apiId + "/documents");

        request.setHeader("Content-Type", "application/json");
        request.setEntity(new StringEntity(new Gson().toJson(document.toJson())));
        return execute(request);
    }

    /**
     * @see org.opentravel.otm.forum2016.am.RESTClientOperation#unmarshallResponse(org.apache.http.HttpResponse)
     */
    @SuppressWarnings("unchecked")
    @Override
    protected APIDocument unmarshallResponse(HttpResponse response) throws IOException {
        Map<String, Object> jsonDocDetails = gson.fromJson(readPayload(response), Map.class);
        return new APIDocument(jsonDocDetails);
    }

    /**
     * @see org.opentravel.otm.forum2016.am.RESTClientOperation#getSecurityScope()
     */
    @Override
    protected String getSecurityScope() {
        return "apim:api_create";
    }

    /**
     * Returns the value of the 'apiId' field.
     *
     * @return String
     */
    public String getApiId() {
        return apiId;
    }

    /**
     * Assigns the value of the 'apiId' field.
     *
     * @param apiId  the field value to assign
     */
    public void setApiId(String apiId) {
        this.apiId = apiId;
    }

    /**
     * Returns the value of the 'document' field.
     *
     * @return APIDocument
     */
    public APIDocument getDocument() {
        return document;
    }

    /**
     * Assigns the value of the 'document' field.
     *
     * @param document  the field value to assign
     */
    public void setDocument(APIDocument document) {
        this.document = document;
    }

}