tx-control-api/src/main/java/org/osgi/service/transaction/control/ResourceProvider.java

/*
 * Copyright (c) OSGi Alliance (2016). All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.osgi.service.transaction.control;

/**
 * A resource provider is used to provide a scoped resource to the
 * application
 * 
 * @param <T> The type of the scoped resource created by this {@link ResourceProvider}
 */
public interface ResourceProvider<T> {

	/**
	 * Get a resource which will automatically associate with the current 
	 * scope
	 * 
	 * @param txControl The transaction control service to associate with
	 * @return The resource which will participate in the scopes started
	 *         by the provided {@link TransactionControl}
	 * @throws TransactionException if the resource cannot be registered with
	 *             the transaction
	 */
	T getResource(TransactionControl txControl) throws TransactionException;

}