org.springframework.hateoas.config.WebMvcEntityLinksConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-hateoas Show documentation

Library to support implementing representations for hyper-text driven REST web services.

There is a newer version: 2.4.0

/*
 * Copyright 2019-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.hateoas.config;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.hateoas.server.EntityLinks;
import org.springframework.hateoas.server.core.ControllerEntityLinksFactoryBean;
import org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory;
import org.springframework.stereotype.Controller;

/**
 * Spring WebMVC specific bean definitions to support {@link EntityLinks}.
 *
 * @author Greg Turnquist
 * @author Oliver Gierke
 */
@Configuration(proxyBeanMethods = false)
class WebMvcEntityLinksConfiguration extends EntityLinksConfiguration {

	@Bean
	ControllerEntityLinksFactoryBean webMvcEntityLinks(ObjectProvider linkBuilderFactory) {

		ControllerEntityLinksFactoryBean factory = new ControllerEntityLinksFactoryBean();
		factory.setAnnotation(Controller.class);
		factory.setLinkBuilderFactory(linkBuilderFactory.getIfAvailable(WebMvcLinkBuilderFactory::new));

		return factory;
	}
}