/*
 * Copyright 2014-2024 the original author or authors.
 *
 * 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
 *
 *      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.springframework.data.rest.webmvc;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

/**
 * Annotation to declare a controller that declares request mappings to be augmented with a base URI in the Spring Data
 * REST configuration.
 *
 * @author Oliver Gierke
 * @author Yves Galante
 */
@Documented
@Component
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.ANNOTATION_TYPE })
public @interface BasePathAwareController {

	/**
	 * The root path to be prepended to all request mappings configured on handler methods.
	 *
	 * @return
	 * @since 3.7.2
	 * @see #path()
	 */
	@AliasFor("path")
	String[] value() default {};

	/**
	 * The root path to be prepended to all request mappings configured on handler methods.
	 *
	 * @return
	 * @since 3.7.2
	 * @see #value()
	 */
	@AliasFor("value")
	String[] path() default {};
}
