com.marklogic.appdeployer.command.forests.ForestNamingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ml-app-deployer Show documentation

Java client for the MarkLogic REST Management API and for deploying applications to MarkLogic

There is a newer version: 5.0.0

/*
 * Copyright (c) 2023 MarkLogic Corporation
 *
 * 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.marklogic.appdeployer.command.forests;

import com.marklogic.appdeployer.AppConfig;

public interface ForestNamingStrategy {

	/**
	 * @param databaseName
	 * @param forestNumber Keeps track of the total number of primary forests being created for the given database
	 * @param appConfig
	 * @return
	 */
	String getForestName(String databaseName, int forestNumber, AppConfig appConfig);

	/**
	 * @param databaseName
	 * @param forestName
	 * @param forestReplicaNumber Keeps track of the total number of replica forests being created for the given
	 *                             forest
	 * @param appConfig
	 * @return
	 */
	String getReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig);

}