/*
* Copyright (c) 2008, Edward Yakop. 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.qi4j.library.unitofwork;
import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.METHOD;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
/**
* Annotation to denote the unit of work propagation.
*
* <p/>
* Usage example:
* <pre>
* <code>
*
* @Concerns( UnitOfWorkConcern.class )
* public class MyBusinessServiceMixin implements BusinessService
* {
* @Structure UnitOfWorkFactory uowf;
*
* @UnitOfWorkPropagation
* public void myBusinessMethod()
* {
* // Must invoke current unit of work.
* UnitOfWork uow = uowf.currentUnitOfWork();
*
* // Perform business logic
* }
* }
* </code>
* </pre>
*
* @author edward.yakop@gmail.com
* @since 0.2.0
*/
@Retention( RUNTIME )
@Target( METHOD )
@Inherited
@Documented
public @interface UnitOfWorkPropagation
{
Propagation value() default Propagation.REQUIRED;
UsecasePropagation usecasePropagation() default UsecasePropagation.PROPAGATE;
enum UsecasePropagation
{
PROPAGATE,
DEFAULT
}
enum Propagation
{
/**
* Default propagation behavior.
* Behavior: <br>
* If no current transaction: creates a new transaction <br>
* If there is a current transaction: use the current transaction.
*/
REQUIRED,
/**
* Behavior: <br>
* If no current transaction: throw an exception <br>
* If there is a current transaction: use the current transaction.
*/
MANDATORY,
/**
* Behavior: <br>
* If no current transaction: creates a new transaction <br>
* If there is a current transaction: suspend the current transaction and create a new transaction.
*/
REQUIRES_NEW,
/**
* Behavior: <br>
* If no current transaction: creates a new transaction <br>
* If there is a current transaction: create a nested transaction.
*/
REQUIRES_NESTED,
}
}