Package net.officefloor.spring.starter.rest

Class OfficeFloorRestSpringBootStarter

java.lang.Object

net.officefloor.spring.starter.rest.OfficeFloorRestSpringBootStarter

public class OfficeFloorRestSpringBootStarter
extends Object

Handles starting OfficeFloor.

Constructor Summary

Constructors

Constructor	Description
OfficeFloorRestSpringBootStarter(OfficeFloorRestProperties properties, org.springframework.context.ConfigurableApplicationContext applicationContext, com.fasterxml.jackson.databind.ObjectMapper mapper)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the OfficeFloor on shutdown.
HttpServletOfficeFloorBridge	getBridge()	Obtains the HttpServletOfficeFloorBridge.
io.swagger.v3.oas.models.OpenAPI	getOpenApi()	Obtains the OpenAPI.
List<OfficeFloorRestEndpoint>	getRestEndpoints()	Obtains the OfficeFloorRestEndpoint instances.
void	startOfficeFloor()	Ensures OfficeFloor is started.

Methods inherited from class java.lang.Object

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

Constructor Details

OfficeFloorRestSpringBootStarter

public OfficeFloorRestSpringBootStarter(OfficeFloorRestProperties properties,
 org.springframework.context.ConfigurableApplicationContext applicationContext,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Instantiate.

Parameters:

properties - OfficeFloorRestProperties.

applicationContext - ConfigurableApplicationContext.

mapper - ObjectMapper.

Method Details

destroy

@PreDestroy
public void destroy()
             throws Exception

Destroys the OfficeFloor on shutdown.

Throws:

Exception - If fails to close.

startOfficeFloor

public void startOfficeFloor()
                      throws Exception

Ensures OfficeFloor is started.

Throws:

Exception - If fails to start the OfficeFloor.

getBridge

public HttpServletOfficeFloorBridge getBridge()

Obtains the HttpServletOfficeFloorBridge.

Returns:

HttpServletOfficeFloorBridge.

getRestEndpoints

public List<OfficeFloorRestEndpoint> getRestEndpoints()

Obtains the OfficeFloorRestEndpoint instances.

Returns:

OfficeFloorRestEndpoint instances.

getOpenApi

public io.swagger.v3.oas.models.OpenAPI getOpenApi()

Obtains the OpenAPI.

Returns:

OpenAPI.