com.esri.geoportal.harvester.agp.AgpOutputBrokerDefinitionAdaptor.java Source code

Introduction

Here is the source code for com.esri.geoportal.harvester.agp.AgpOutputBrokerDefinitionAdaptor.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.agp;

import com.esri.geoportal.commons.utils.SimpleCredentials;
import com.esri.geoportal.harvester.api.base.BrokerDefinitionAdaptor;
import com.esri.geoportal.harvester.api.base.CredentialsDefinitionAdaptor;
import com.esri.geoportal.harvester.api.defs.EntityDefinition;
import com.esri.geoportal.harvester.api.ex.InvalidDefinitionException;
import java.net.MalformedURLException;
import java.net.URL;
import org.apache.commons.lang3.StringUtils;

/**
 * ArcGIS Portal definition adaptor.
 */
/*package*/ class AgpOutputBrokerDefinitionAdaptor extends BrokerDefinitionAdaptor {
    public static final String P_HOST_URL = "agp-host-url";
    public static final String P_FOLDER_ID = "agp-folder-id";
    public static final String P_FOLDER_CLEANUP = "agp-folder-cleanup";

    private final CredentialsDefinitionAdaptor credAdaptor;

    private URL hostUrl;
    private String folderId;
    private boolean cleanup;

    /**
     * Creates instance of the adaptor.
     * @param def broker definition
     * @throws IllegalArgumentException if invalid broker definition
     */
    public AgpOutputBrokerDefinitionAdaptor(EntityDefinition def) throws InvalidDefinitionException {
        super(def);
        this.credAdaptor = new CredentialsDefinitionAdaptor(def);
        if (StringUtils.trimToEmpty(def.getType()).isEmpty()) {
            def.setType(AgpOutputConnector.TYPE);
        } else if (!AgpOutputConnector.TYPE.equals(def.getType())) {
            throw new InvalidDefinitionException("Broker definition doesn't match");
        } else {
            try {
                hostUrl = new URL(get(P_HOST_URL));
            } catch (MalformedURLException ex) {
                throw new InvalidDefinitionException(String.format("Invalid %s: %s", P_HOST_URL, get(P_HOST_URL)),
                        ex);
            }
            folderId = get(P_FOLDER_ID);
            cleanup = Boolean.parseBoolean(get(P_FOLDER_CLEANUP));
        }
    }

    /**
     * Gets host URL.
     * @return host URL
     */
    public URL getHostUrl() {
        return hostUrl;
    }

    /**
     * Sets host URL
     * @param url host URL
     */
    public void setHostUrl(URL url) {
        this.hostUrl = url;
        set(P_HOST_URL, url.toExternalForm());
    }

    /**
     * Gets folder id.
     * @return folder id
     */
    public String getFolderId() {
        return folderId;
    }

    /**
     * Sets folder id.
     * @param folderId folder id 
     */
    public void setFolderId(String folderId) {
        this.folderId = folderId;
        set(P_FOLDER_ID, folderId);
    }

    /**
     * Gets credentials.
     * @return credentials
     */
    public SimpleCredentials getCredentials() {
        return credAdaptor.getCredentials();
    }

    /**
     * Sets credentials.
     * @param cred credentials
     */
    public void setCredentials(SimpleCredentials cred) {
        credAdaptor.setCredentials(cred);
    }

    /**
     * Gets permission to cleanup.
     * @return <code>true</code> if cleanup permitted
     */
    public boolean getCleanup() {
        return cleanup;
    }

    /**
     * Sets permission to cleanup.
     * @param cleanup <code>true</code> to permit cleanup
     */
    public void setCleanup(boolean cleanup) {
        this.cleanup = cleanup;
        set(P_FOLDER_CLEANUP, Boolean.toString(cleanup));
    }

}