net.officefloor.spring.SpringBeanManagedObjectSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of officespring Show documentation
OfficeFloor plug-in for Spring
There is a newer version: 3.40.0
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.spring;

import org.springframework.context.ConfigurableApplicationContext;

import net.officefloor.frame.api.build.Indexed;
import net.officefloor.frame.api.build.None;
import net.officefloor.frame.api.managedobject.CoordinatingManagedObject;
import net.officefloor.frame.api.managedobject.ManagedObject;
import net.officefloor.frame.api.managedobject.ObjectRegistry;
import net.officefloor.frame.api.managedobject.source.ManagedObjectSource;
import net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource;

/**
 * Spring bean {@link ManagedObjectSource}.
 * 
 * @author Daniel Sagenschneider
 */
public class SpringBeanManagedObjectSource extends AbstractManagedObjectSource
		implements ManagedObject, CoordinatingManagedObject {

	/**
	 * Name of the Spring bean.
	 */
	private final String beanName;

	/**
	 * Object type expected from Spring.
	 */
	private final Class objectType;

	/**
	 * Spring {@link ConfigurableApplicationContext}.
	 */
	private final ConfigurableApplicationContext springContext;

	/**
	 * {@link SpringDependency} instances.
	 */
	private final SpringDependency[] springDependencies;

	/**
	 * Instantiate.
	 * 
	 * @param beanName           Name of the Spring bean.
	 * @param objectType         Object type expected from Spring.
	 * @param springContext      Spring {@link ConfigurableApplicationContext}.
	 * @param springDependencies {@link SpringDependency} instances.
	 */
	public SpringBeanManagedObjectSource(String beanName, Class objectType,
			ConfigurableApplicationContext springContext, SpringDependency[] springDependencies) {
		this.beanName = beanName;
		this.objectType = objectType;
		this.springContext = springContext;
		this.springDependencies = springDependencies;
	}

	/*
	 * ===================== ManagedObjectSource ==========================
	 */

	@Override
	protected void loadSpecification(SpecificationContext context) {
		// no specification
	}

	@Override
	@SuppressWarnings({ "unchecked", "rawtypes" })
	protected void loadMetaData(MetaDataContext context) throws Exception {

		// Configure meta-data
		context.setObjectClass(this.objectType);
		context.setManagedObjectClass(this.getClass());

		// Provide extension
		context.addManagedObjectExtension((Class) this.objectType, (mo) -> mo.getObject());

		// Load the dependencies
		for (SpringDependency springDependency : this.springDependencies) {
			context.addDependency(springDependency.getObjectType()).setTypeQualifier(springDependency.getQualifier());
		}
	}

	@Override
	protected ManagedObject getManagedObject() throws Throwable {
		return this;
	}

	/*
	 * ================= CoordinatingManagedObject ========================
	 */

	@Override
	public void loadObjects(ObjectRegistry registry) throws Throwable {
		// objects via supplier thread local
	}

	/*
	 * ======================== ManagedObject ==============================
	 */

	@Override
	public Object getObject() throws Throwable {
		return this.springContext.getBean(this.beanName);
	}

}