MessageMarkingConfiguration.java

package com.epam.wilma.service.configuration;

/*==========================================================================
 Copyright 2013-2017 EPAM Systems

 This file is part of Wilma.

 Wilma is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 Wilma is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with Wilma.  If not, see <http://www.gnu.org/licenses/>.
 ===========================================================================*/

import com.epam.wilma.service.domain.MessageMarkingStatus;
import com.epam.wilma.service.domain.WilmaServiceConfig;
import com.epam.wilma.service.http.WilmaHttpClient;
import org.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Collects the message marking related commands.
 *
 * @author Tamas_Kohegyi
 *
 */
public class MessageMarkingConfiguration extends AbstractConfiguration {
    private static final Logger LOG = LoggerFactory.getLogger(MessageMarkingConfiguration.class);

    private static final String STATUS_GETTER_URL_POSTFIX = "config/public/messagemarking/status";
    private static final String STATUS_SETTER_URL_POSTFIX_FORMAT = "config/admin/messagemarking/%s";

    /**
     * Constructor.
     *
     * @param config the Wilma server configuration
     */
    public MessageMarkingConfiguration(WilmaServiceConfig config) {
        super(config);
    }

    /**
     * Constructor.
     *
     * @param config the Wilma server configuration
     * @param client the Wilma HTTP client
     */
    public MessageMarkingConfiguration(WilmaServiceConfig config, WilmaHttpClient client) {
        super(config, client);
    }

    /**
     * Gets the message marking status.
     *
     * @return message marking status in JSONObject
     */
    public MessageMarkingStatus getMessageMarkingStatus() {
        LOG.debug("Call message marking status API.");
        MessageMarkingStatus status = null;

        JSONObject o = getterRequest(STATUS_GETTER_URL_POSTFIX);
        if (o != null) {
            Boolean messageMarking = (Boolean) o.get("messageMarking");

            if (messageMarking) {
                status = MessageMarkingStatus.ON;
            } else {
                status = MessageMarkingStatus.OFF;
            }
        }
        return status;
    }

    /**
     * Sets the message marking status.
     *
     * @param control the new message marking status
     * @return <tt>true</tt> if the request is successful, otherwise return <tt>false</tt>
     */
    public boolean setMessageMarkingStatus(MessageMarkingStatus control) {
        LOG.debug("Call message marking setter API with value: " + control);

        String postfix = String.format(STATUS_SETTER_URL_POSTFIX_FORMAT, control.toString().toLowerCase());
        return setterRequest(postfix);
    }

}