com.ibm.watson.apis.conversation_enhanced.rest.SetupResource.java Source code

Introduction

Here is the source code for com.ibm.watson.apis.conversation_enhanced.rest.SetupResource.java

Source

/**
 * (C) Copyright IBM Corp. 2016. All Rights Reserved.
 * 
 * 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 com.ibm.watson.apis.conversation_enhanced.rest;

import java.text.MessageFormat;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import com.google.gson.JsonObject;
import com.ibm.watson.apis.conversation_enhanced.listener.ServletContextListener;
import com.ibm.watson.apis.conversation_enhanced.utils.Constants;
import com.ibm.watson.apis.conversation_enhanced.utils.Messages;

/**
 * The SetupResource is used to fetch the configuration file with the WorkspaceId from the env file
 * and the setup configuration stage that the application is currently in. The API endpoint points
 * to '/rest/setup'
 * 
 */
@Path("setup")
public class SetupResource {
    private static final Logger logger = LogManager.getLogger(SetupResource.class.getName());

    /**
     * Method to fetch config JSON object and also the workspace_id.
     * 
     * @return response
     */
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Response getConfig() {
        String workspace_id = System.getenv(Constants.WORKSPACE_ID); //$NON-NLS-1$
        logger.debug(MessageFormat.format(Messages.getString("SetupResource.WORKSPACE_ID_IS"), workspace_id));

        JsonObject config = new JsonObject();
        config.addProperty(Constants.SETUP_STATUS_MESSAGE, Messages.getString("SetupResource.SETUP_STATUS_MSG")); //$NON-NLS-1$ //$NON-NLS-2$
        config.addProperty(Constants.SETUP_STEP, "0"); //$NON-NLS-1$ //$NON-NLS-2$
        config.addProperty(Constants.SETUP_STATE, Constants.NOT_READY); //$NON-NLS-1$ //$NON-NLS-2$
        config.addProperty(Constants.SETUP_PHASE, Messages.getString("SetupResource.PHASE_ERROR")); //$NON-NLS-1$ //$NON-NLS-2$
        config.addProperty(Constants.SETUP_MESSAGE, Messages.getString("SetupResource.ERROR_CHECK_LOGS")); //$NON-NLS-1$ //$NON-NLS-2$

        // Fetch the updated config JSON object from the servlet listener
        config = new ServletContextListener().getJsonConfig();
        config.addProperty(Constants.SETUP_STATUS_MESSAGE, Messages.getString("SetupResource.SETUP_STATUS_MSG")); //$NON-NLS-1$ //$NON-NLS-2$
        logger.debug(Messages.getString("SetupResource.CONFIG_STATUS") + config);

        // The following checks for the workspace_id after the Retrieve and
        // Rank service is ready for the user. This is done so that when the initial setup is being
        // done, the user can setup the Conversation service Workspace and provide it's id.
        if (config.get(Constants.SETUP_STEP).getAsInt() == 3
                && config.get(Constants.SETUP_STATE).getAsString().equalsIgnoreCase(Constants.READY)) {
            if (StringUtils.isNotBlank(workspace_id)) {
                config.addProperty(Constants.WORKSPACE_ID, workspace_id); //$NON-NLS-1$
            } else {
                config.addProperty(Constants.SETUP_STEP, "0"); //$NON-NLS-1$ //$NON-NLS-2$
                config.addProperty(Constants.SETUP_STATE, Constants.NOT_READY); //$NON-NLS-1$ //$NON-NLS-2$
                config.addProperty(Constants.SETUP_PHASE, Messages.getString("SetupResource.PHASE_ERROR")); //$NON-NLS-1$ //$NON-NLS-2$
                config.addProperty(Constants.SETUP_MESSAGE, Messages.getString("SetupResource.WORKSPACE_ID_ERROR")); //$NON-NLS-1$ //$NON-NLS-2$
            }
        }

        return Response.ok(config.getAsJsonObject().toString().trim()).type(MediaType.APPLICATION_JSON)
                .header("Cache-Control", "no-cache").build();
    }

}