com.sun.enterprise.config.serverbeans.AppTenant Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-api Show documentation

The newest version!

/*
 * Copyright (c) 2023 Contributors to the Eclipse Foundation
 * Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.config.serverbeans;

import java.beans.PropertyVetoException;
import java.util.Properties;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;

import static com.sun.enterprise.config.serverbeans.ServerTags.CONTEXT_ROOT;

/**
 * Records information about a tenant provisioned for a given application.
 *
 * @author Tim Quinn
 */
@Configured
public interface AppTenant extends ConfigBeanProxy {

    @Attribute
    String getTenant();

    void setTenant(String tenant) throws PropertyVetoException;

    @Attribute
    String getContextRoot();

    void setContextRoot(String contextRoot) throws PropertyVetoException;

    default Properties getDeployProperties() {
        Properties deploymentProps = new Properties();
        String contextRoot = getContextRoot();
        if (contextRoot != null) {
            deploymentProps.setProperty(CONTEXT_ROOT, contextRoot);
        }
        return deploymentProps;
    }
}