1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.myfaces.orchestra.conversation.annotations;
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 /**
27 * An annotation that can be attached to a class in order to set the orchestra
28 * conversation-name that this bean lives in.
29 * <p>
30 * When a bean declaration (in whatever dependency-injection framework is being
31 * used) specifies that this object is in a conversation scope, and no specific
32 * conversation name is defined, then the class being instantiated is checked
33 * for this annotation.
34 * <p>
35 * This is the annotation equivalent of the spring configuration attribute
36 * <code>orchestra:conversationName</code>.
37 * <p>
38 * Note that this annotation does not support setting of the bean scope at
39 * the same time, as that is something that the dependency framework being
40 * used should provide its own annotations for.
41 */
42 @Target(value = {ElementType.TYPE})
43 @Retention(value = RetentionPolicy.RUNTIME)
44 public @interface ConversationName
45 {
46 String value() default "";
47 }