/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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
 *
 *    https://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 org.grails.datastore.mapping.multitenancy

import org.grails.datastore.mapping.multitenancy.exceptions.TenantNotFoundException

/**
 * An interface for applications that implement Multi Tenancy to implement in order to resolve the current identifier
 *
 * @author Graeme Rocher
 * @since 6.0
 */
interface TenantResolver {

    /**
     * <p>Resolves the current tenant identifier. In a Single tenancy setup where each tenant has their own database this would be
     * the name of the {@link org.grails.datastore.mapping.core.connections.ConnectionSource}.</p>
     *
     * <p>In a Multi Tenant setup where a single database is being used amongst multiple tenants this would be the object that is used
     * as the tenantId property for each domain class.</p>
     *
     * @return The tenant identifier
     *
     */
    Serializable resolveTenantIdentifier() throws TenantNotFoundException
}
