net.officefloor.spring.extension.SpringSupplierExtension 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.extension;

import net.officefloor.spring.SpringSupplierSource;

/**
 * Extension to {@link SpringSupplierSource}.
 * 
 * @author Daniel Sagenschneider
 */
public interface SpringSupplierExtension {

	/**
	 * 
	 * Invoked before Spring is loaded.
	 * 

	 * This allows initial setup to be undertaken. It also allows capturing
	 * information on the current {@link Thread} as Spring loads.
	 * 
	 * @param context {@link SpringSupplierExtensionContext}.
	 * @throws Exception If fails to setup.
	 */
	default void beforeSpringLoad(SpringSupplierExtensionContext context) throws Exception {
		// does nothing by default
	}

	/**
	 * 

	 * Invoked after Spring is loaded.
	 * 
	 * Allows processing captured information.
	 * 
	 * @param context {@link SpringSupplierExtensionContext}.
	 * @throws Exception If fails to complete extension configuration.
	 */
	default void afterSpringLoad(SpringSupplierExtensionContext context) throws Exception {
		// does nothing by default
	}

	/**
	 * Invoked for each registered Spring bean to further decorate integration.
	 * 
	 * @param context {@link SpringBeanDecoratorContext}.
	 * @throws Exception If fails to decorate the Spring Bean.
	 */
	default void decorateSpringBean(SpringBeanDecoratorContext context) throws Exception {
		// does nothing by default
	}

}