Package net.officefloor.spring

Class SpringSupplierSource

java.lang.Object

net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

net.officefloor.spring.SpringSupplierSource

All Implemented Interfaces:

SupplierSource

public class SpringSupplierSource
extends AbstractSupplierSource

Spring SupplierSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpringSupplierSource.SpringDependencyFactory	Factory for the creation of the Spring dependencies.
static interface	SpringSupplierSource.SpringLoader<S,E extends Throwable>	Provides the loading of Spring.

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

AbstractSupplierSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIGURATION_CLASS_NAME	Name of PropertyValue for the Spring Boot configuration Class.
static final String	PROPERTY_ACTIVE_PROFILES	PropertyValue to configure active Spring profiles.
static final String	PROPERTY_UNLINK_CONTEXT_PROFILES	PropertyValue to flag whether to unlink Spring profiles to Office profiles.

Constructor Summary

Constructors

Constructor	Description
SpringSupplierSource()

Method Summary

Modifier and Type	Method	Description
static <S, E extends Throwable> S	captureApplicationContext(Consumer<org.springframework.context.ConfigurableApplicationContext> capture, SpringSupplierSource.SpringLoader<S,E> loader)	Allows capturing the ConfigurableApplicationContext.
static OfficeSupplier	configure(OfficeArchitect architect, Class<?> configurationClass, String... additionalPropertyNameValuePairs)	Convenience method for configuring Spring programmatically into an Office.
static org.springframework.context.ConfigurableApplicationContext	forceStartSpring(AvailableType[] availableTypes)	Forces starting Spring.
static <O> O	getManagedObject(String qualifier, Class<? extends O> objectType)	Obtains the bean from OfficeFloor.
protected void	loadSpecification(AbstractSupplierSource.SpecificationContext context)	Loads the SupplierSourceSpecification.
static <S, E extends Throwable> S	runInContext(SpringSupplierSource.SpringLoader<S,E> loader, SpringSupplierSource.SpringDependencyFactory factory)	Runs the Runnable in context for the SpringSupplierSource.SpringDependencyFactory to create additional beans for Spring.
void	supply(SupplierSourceContext context)	Supplies the necessary ManagedObjectSource instances.
void	terminate()	Terminates the supply contract.

Methods inherited from class net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_ACTIVE_PROFILES

public static final String PROPERTY_ACTIVE_PROFILES

PropertyValue to configure active Spring profiles.

See Also:

• Constant Field Values

PROPERTY_UNLINK_CONTEXT_PROFILES

public static final String PROPERTY_UNLINK_CONTEXT_PROFILES

PropertyValue to flag whether to unlink Spring profiles to Office profiles.

See Also:

• Constant Field Values

CONFIGURATION_CLASS_NAME

public static final String CONFIGURATION_CLASS_NAME

Name of PropertyValue for the Spring Boot configuration Class.

See Also:

• Constant Field Values

Constructor Details

SpringSupplierSource

public SpringSupplierSource()

Method Details

getManagedObject

public static <O> O getManagedObject(String qualifier,
 Class<? extends O> objectType)

Obtains the bean from OfficeFloor.

This should be used as follows:

 @Configuration
 public class SomeConfigurationOnScanPath {
 
        @Bean
        public DependencyType officeFloorDependency() {
                return SpringSupplierSource.getManagedObject("qualifier", DependencyType.class);
        }
 }
 

Type Parameters:

O - Object type.

Parameters:

qualifier - Qualifier. May be null.

objectType - Type of object required.

Returns:

Object sourced from an OfficeFloor ManagedObject.

captureApplicationContext

public static <S,
E extends Throwable> S captureApplicationContext(Consumer<org.springframework.context.ConfigurableApplicationContext> capture,
 SpringSupplierSource.SpringLoader<S,E> loader)
                                                           throws E

Allows capturing the ConfigurableApplicationContext.

Typically this is for testing to enable using Spring beans.

Type Parameters:

S - Return type.

E - Throwable type.

Parameters:

capture - Consumer to receive the ConfigurableApplicationContext.

loader - SpringSupplierSource.SpringLoader.

Returns:

Loaded context.

Throws:

E - Possible failure in loading.

runInContext

public static <S,
E extends Throwable> S runInContext(SpringSupplierSource.SpringLoader<S,E> loader,
 SpringSupplierSource.SpringDependencyFactory factory)
                                              throws E

Runs the Runnable in context for the SpringSupplierSource.SpringDependencyFactory to create additional beans for Spring.

Type Parameters:

S - Loaded context.

E - Possible Throwable from loading.

Parameters:

loader - SpringSupplierSource.SpringLoader.

factory - SpringSupplierSource.SpringDependencyFactory to create the additional beans.

Returns:

Loaded context.

Throws:

E - If fails to load.

configure

public static OfficeSupplier configure(OfficeArchitect architect,
 Class<?> configurationClass,
 String... additionalPropertyNameValuePairs)

Convenience method for configuring Spring programmatically into an Office.

Parameters:

architect - OfficeArchitect.

configurationClass - Spring Boot configuration Class.

additionalPropertyNameValuePairs - Additional PropertyValue name/value pairs.

Returns:

OfficeSupplier for the SpringSupplierSource.

forceStartSpring

public static org.springframework.context.ConfigurableApplicationContext forceStartSpring(AvailableType[] availableTypes)
                                                                                   throws Exception

Forces starting Spring.

Parameters:

availableTypes - AvailableType instances.

Returns:

ConfigurableApplicationContext. null if already started.

Throws:

Exception - If fails to start Spring.

loadSpecification

protected void loadSpecification(AbstractSupplierSource.SpecificationContext context)

Description copied from class: AbstractSupplierSource

Loads the SupplierSourceSpecification.

Specified by:

loadSpecification in class AbstractSupplierSource

Parameters:

context - AbstractSupplierSource.SpecificationContext.

supply

public void supply(SupplierSourceContext context)
            throws Exception

Description copied from interface: SupplierSource

Supplies the necessary ManagedObjectSource instances.

Parameters:

context - SupplierSourceContext.

Throws:

Exception - If fails to provide supply of ManagedObjectSource instances.

terminate

public void terminate()

Description copied from interface: SupplierSource

Terminates the supply contract.

This should release all resources required by the supplier.