// Copyright 2018 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.util;

/**
 * A wrapper for {@link com.google.appengine.api.modules.ModulesService} that provides a saner API.
 */
public interface AppEngineServiceUtils {

  /**
   * Returns a host name to use for the given service.
   *
   * <p>Note that this host name will not include a version, so it will always be whatever the live
   * version is at the time that you hit the URL.
   */
  String getServiceHostname(String service);

  /**
   * Returns a host name to use for the given service and current version.
   *
   * <p>Note that this host name will include the current version now at time of URL generation,
   * which will not be the live version in the future.
   */
  String getCurrentVersionHostname(String service);

  /** Returns a host name to use for the given service and version. */
  String getVersionHostname(String service, String version);
}