java/com/google/gerrit/server/config/CanonicalWebUrl.java

// Copyright (C) 2009 The Android Open Source Project
//
// 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.google.gerrit.server.config;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import com.google.inject.BindingAnnotation;
import java.lang.annotation.Retention;

/**
 * Marker on a {@link String} holding the canonical address for this server.
 *
 * <p>Note that the String may be null, if the administrator has not configured the value and we are
 * not in an HTTP request where the URL can be guessed from the request state. Clients must handle
 * such cases explicitly.
 */
@Retention(RUNTIME)
@BindingAnnotation
public @interface CanonicalWebUrl {}