View Javadoc

    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;
    21
    22  /**
    23   * An object that is able to bind an arbitrary object to a specific conversation.
    24   * <p>
    25   * Only code that extends Orchestra to support new dependency-injection frameworks should need
    26   * to implement this interface.
    27   *
    28   * @since 1.3
    29   */
    30  public interface ConversationBinder
    31  {
    32      /**
    33       * Return a proxy object that "binds" the specified instance to a specific conversation.
    34       * <p>
    35       * Whenever a method is executed on the returned proxy the conversation is "entered" before the method
    36       * is invoked on the actual instance, as if the specified instance were a bean that was defined
    37       * in the dependency-injection framework as belonging to the conversation.
    38       * <p>
    39       * This interface is expected to be used only via calls to Conversation.bind(Object).
    40       * <p>
    41       * The proxy object returned has a "direct" binding to the conversation. This makes calls to the
    42       * instance relatively quick, but also means that the proxy object becomes "stale" if the
    43       * conversation becomes invalid.
    44       */
    45      Object bind(Object instance);
    46  }