net.officefloor.spring.extension.SpringSupplierExtensionContext 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.frame.api.thread.ThreadSynchroniserFactory;
import net.officefloor.plugin.section.clazz.ManagedObject;

/**
 * Context for a {@link SpringSupplierExtension}.
 * 
 * @author Daniel Sagenschneider
 */
public interface SpringSupplierExtensionContext {

	/**
	 * Obtains the object source from a {@link ManagedObject}.
	 * 
	 * @param             Object type.
	 * @param qualifier  Qualifier. May be null.
	 * @param objectType Object type required.
	 * @return Object from the {@link ManagedObject}.
	 * @throws Exception If fails to source the {@link ManagedObject}.
	 */
	 O getManagedObject(String qualifier, Class objectType) throws Exception;

	/**
	 * Registers a {@link ThreadSynchroniserFactory}.
	 * 
	 * @param threadSynchroniserFactory {@link ThreadSynchroniserFactory}.
	 */
	void addThreadSynchroniser(ThreadSynchroniserFactory threadSynchroniserFactory);

}