Package net.officefloor.spring.starter.rest

Class SpringBootOfficeFloorSource

java.lang.Object

net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

net.officefloor.spring.starter.rest.SpringBootOfficeFloorSource

All Implemented Interfaces:

OfficeFloorSource

public class SpringBootOfficeFloorSource
extends AbstractOfficeFloorSource

AbstractOfficeFloorSource for Spring Boot.

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

AbstractOfficeFloorSource.SpecificationContext

Constructor Summary

Constructors

Constructor	Description
SpringBootOfficeFloorSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper, List<OfficeFloorRestEndpoint> restEndpoints, org.springframework.context.ConfigurableApplicationContext applicationContext, io.swagger.v3.oas.models.OpenAPI openApi)

Method Summary

Modifier and Type	Method	Description
protected void	loadSpecification(AbstractOfficeFloorSource.SpecificationContext specificationContext)	Loads the OfficeFloorSourceSpecification.
void	sourceOfficeFloor(OfficeFloorDeployer officeFloorDeployer, OfficeFloorSourceContext officeFloorSourceContext)	Sources the OfficeFloor by deploying it via the input OfficeFloorDeployer.
void	specifyConfigurationProperties(RequiredProperties requiredProperties, OfficeFloorSourceContext officeFloorSourceContext)	Obtains from the OfficeFloorSource any additional Property instances required to source the OfficeFloor after interrogating the configuration.

Methods inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

getSpecification

Methods inherited from class java.lang.Object

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

Constructor Details

SpringBootOfficeFloorSource

public SpringBootOfficeFloorSource(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 List<OfficeFloorRestEndpoint> restEndpoints,
 org.springframework.context.ConfigurableApplicationContext applicationContext,
 io.swagger.v3.oas.models.OpenAPI openApi)

Parameters:

objectMapper - ObjectMapper.

restEndpoints - REST endpoints.

applicationContext - ConfigurableApplicationContext.

openApi - OpenAPI.

Method Details

loadSpecification

protected void loadSpecification(AbstractOfficeFloorSource.SpecificationContext specificationContext)

Description copied from class: AbstractOfficeFloorSource

Loads the OfficeFloorSourceSpecification.

Specified by:

loadSpecification in class AbstractOfficeFloorSource

Parameters:

specificationContext - AbstractOfficeFloorSource.SpecificationContext.

specifyConfigurationProperties

public void specifyConfigurationProperties(RequiredProperties requiredProperties,
 OfficeFloorSourceContext officeFloorSourceContext)
                                    throws Exception

Description copied from interface: OfficeFloorSource

Obtains from the OfficeFloorSource any additional Property instances required to source the OfficeFloor after interrogating the configuration.

This method is a separate initial step from the OfficeFloorSource.sourceOfficeFloor(OfficeFloorDeployer, OfficeFloorSourceContext) method to enable specifying any required Property instances once the necessary ConfigurationItem instances have been interrogated.

Typically this allows environment specific properties to be defined externally so that deployment configuration need not be repeated per environment. In other words, one set of deployment configuration with properties providing the differences between the environments.

This also enables sensitive properties, such as passwords, to not be contained in deployment configuration but within a "secure" location.

Parameters:

requiredProperties - Populated by the OfficeFloorSource with any additional Property instances required to source the OfficeFloor.

officeFloorSourceContext - OfficeFloorSourceContext populated with Property instances as per the OfficeFloorSourceSpecification.

Throws:

Exception - If fails to initialise the OfficeFloorSource.

sourceOfficeFloor

public void sourceOfficeFloor(OfficeFloorDeployer officeFloorDeployer,
 OfficeFloorSourceContext officeFloorSourceContext)
                       throws Exception

Description copied from interface: OfficeFloorSource

Sources the OfficeFloor by deploying it via the input OfficeFloorDeployer.

Parameters:

officeFloorDeployer - OfficeFloorDeployer to deploy the OfficeFloor.

officeFloorSourceContext - OfficeFloorSourceContext populated with the Property instances as per the OfficeFloorSourceSpecification and RequiredProperties. Should there be a name clash between the two, the RequiredProperties Property will be used.

Throws:

Exception - If fails to source the OfficeFloor.