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.spring;
21  
22  /**
23   * Interface which will be used by the {@link PersistenceContextConversationInterceptor}
24   * to configure the spring persistence framework.
25   * <p>
26   * Implementations of this interface are expected to hold a reference to a real
27   * ORM-specific object (eg a JPA EntityManager or a Hibernate Session).
28   */
29  public interface PersistenceContext
30  {
31      /**
32       * Make the underlying object available via the standard APIs for the underlying
33       * real ORM implementation. Typically this involves doing something like binding
34       * the object to the current thread.
35       */
36      public void bind();
37  
38      /**
39       * Unbind the underlying object, so it is no longer available via the standard
40       * APIs for the underlying ORM implementation.
41       */
42      public void unbind();
43  
44      /**
45       * Close the underlying persistence context.
46       */
47      public void close();
48  }