com.esri.geoportal.harvester.api.base.BotsBrokerDefinitionAdaptor.java Source code

Introduction

Here is the source code for com.esri.geoportal.harvester.api.base.BotsBrokerDefinitionAdaptor.java

Source

/*
 * Copyright 2016 Esri, Inc..
 *
 * 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.esri.geoportal.harvester.api.base;

import com.esri.geoportal.commons.robots.BotsConfig;
import com.esri.geoportal.commons.robots.BotsConfigImpl;
import com.esri.geoportal.commons.robots.BotsMode;
import com.esri.geoportal.harvester.api.defs.EntityDefinition;
import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;

/**
 * Bots properties adaptor.
 */
public final class BotsBrokerDefinitionAdaptor extends BrokerDefinitionAdaptor {
    public static final String P_BOTS_AGENT = "bots-config-agent";
    public static final String P_BOTS_ENABLED = "bots-config-enabled";
    public static final String P_BOTS_OVERRIDE = "bots-config-override";
    public static final String P_BOTS_MODE = "bots-mode";

    /**
     * Creates instance of the adaptor.
     * @param def broker definition
     */
    public BotsBrokerDefinitionAdaptor(EntityDefinition def) {
        super(def);
    }

    /**
     * Gets bots mode.
     *
     * @return bots mode
     */
    public BotsMode getBotsMode() {
        String sBootMode = get(P_BOTS_MODE);
        return BotsMode.parseMode(sBootMode);
    }

    /**
     * Sets bots mode.
     *
     * @param botsMode bots mode
     */
    public void setBotsMode(BotsMode botsMode) {
        set(P_BOTS_MODE, botsMode.name());
    }

    /**
     * Gets bots config.
     *
     * @return bots config
     */
    public BotsConfig getBotsConfig() {
        return new BotsConfigImpl(StringUtils.defaultIfBlank(get(P_BOTS_AGENT), BotsConfig.DEFAULT.getUserAgent()),
                BooleanUtils.toBoolean(StringUtils.defaultIfBlank(get(P_BOTS_ENABLED),
                        Boolean.toString(BotsConfig.DEFAULT.isEnabled()))),
                BooleanUtils.toBoolean(StringUtils.defaultIfBlank(get(P_BOTS_OVERRIDE),
                        Boolean.toString(BotsConfig.DEFAULT.isOverride()))));
    }

    /**
     * Sets bots config.
     *
     * @param botsConfig bots config
     */
    public void setBotsConfig(BotsConfig botsConfig) {
        set(P_BOTS_AGENT, botsConfig.getUserAgent());
        set(P_BOTS_ENABLED, Boolean.toString(botsConfig.isEnabled()));
        set(P_BOTS_OVERRIDE, Boolean.toString(botsConfig.isOverride()));
    }

    @Override
    public String toString() {
        return String.format("%s/%s", getBotsConfig(), getBotsMode());
    }
}