Package io.spring.initializr.web.controller

Class ProjectMetadataController

java.lang.Object

io.spring.initializr.web.controller.AbstractMetadataController

io.spring.initializr.web.controller.ProjectMetadataController

@RestController
public class ProjectMetadataController
extends AbstractMetadataController

RestController that exposes metadata and service configuration.

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.http.MediaType	HAL_JSON_CONTENT_TYPE	HAL JSON content type.

Fields inherited from class io.spring.initializr.web.controller.AbstractMetadataController

metadataProvider

Constructor Summary

Constructors

Constructor	Description
ProjectMetadataController(InitializrMetadataProvider metadataProvider, DependencyMetadataProvider dependencyMetadataProvider)

Method Summary

Modifier and Type	Method	Description
InitializrMetadata	config()
org.springframework.http.ResponseEntity<String>	dependenciesV21(String bootVersion)
org.springframework.http.ResponseEntity<String>	dependenciesV22(String bootVersion)
protected org.springframework.http.CacheControl	determineCacheControlFor(InitializrMetadata metadata)	Return the CacheControl response headers to use for the specified metadata.
void	invalidMetadataRequest(jakarta.servlet.http.HttpServletResponse response, InvalidInitializrMetadataException ex)
void	invalidProjectRequest(jakarta.servlet.http.HttpServletResponse response, InvalidProjectRequestException ex)
org.springframework.http.ResponseEntity<String>	serviceCapabilitiesHal()
org.springframework.http.ResponseEntity<String>	serviceCapabilitiesV2()
org.springframework.http.ResponseEntity<String>	serviceCapabilitiesV21()
org.springframework.http.ResponseEntity<String>	serviceCapabilitiesV22()

Methods inherited from class io.spring.initializr.web.controller.AbstractMetadataController

createUniqueId, generateAppUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HAL_JSON_CONTENT_TYPE

public static final org.springframework.http.MediaType HAL_JSON_CONTENT_TYPE

HAL JSON content type.

Constructor Details

ProjectMetadataController

public ProjectMetadataController(InitializrMetadataProvider metadataProvider,
 DependencyMetadataProvider dependencyMetadataProvider)

Method Details

config

@GetMapping(path="/metadata/config",
            produces="application/json")
public InitializrMetadata config()

serviceCapabilitiesHal

@GetMapping(path={"/","/metadata/client"},
            produces="application/hal+json")
public org.springframework.http.ResponseEntity<String> serviceCapabilitiesHal()

serviceCapabilitiesV22

@GetMapping(path={"/","/metadata/client"},
            produces="application/vnd.initializr.v2.2+json")
public org.springframework.http.ResponseEntity<String> serviceCapabilitiesV22()

serviceCapabilitiesV21

@GetMapping(path={"/","/metadata/client"},
            produces={"application/vnd.initializr.v2.1+json","application/json"})
public org.springframework.http.ResponseEntity<String> serviceCapabilitiesV21()

serviceCapabilitiesV2

@GetMapping(path={"/","/metadata/client"},
            produces="application/vnd.initializr.v2+json")
public org.springframework.http.ResponseEntity<String> serviceCapabilitiesV2()

dependenciesV22

@GetMapping(path="/dependencies",
            produces="application/vnd.initializr.v2.2+json")
public org.springframework.http.ResponseEntity<String> dependenciesV22(@RequestParam(required=false)
 String bootVersion)

dependenciesV21

@GetMapping(path="/dependencies",
            produces={"application/vnd.initializr.v2.1+json","application/json"})
public org.springframework.http.ResponseEntity<String> dependenciesV21(@RequestParam(required=false)
 String bootVersion)

invalidMetadataRequest

@ExceptionHandler
public void invalidMetadataRequest(jakarta.servlet.http.HttpServletResponse response,
 InvalidInitializrMetadataException ex)
                            throws IOException

Throws:

IOException

invalidProjectRequest

@ExceptionHandler
public void invalidProjectRequest(jakarta.servlet.http.HttpServletResponse response,
 InvalidProjectRequestException ex)
                           throws IOException

Throws:

IOException

determineCacheControlFor

protected org.springframework.http.CacheControl determineCacheControlFor(InitializrMetadata metadata)

Return the CacheControl response headers to use for the specified metadata. If no cache should be applied CacheControl.empty() can be used.

Parameters:

metadata - the metadata about to be exposed

Returns:

the Cache-Control headers to use