View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif.lifecycle;
17  
18  import java.util.Deque;
19  import java.util.LinkedList;
20  
21  import org.kuali.rice.krad.uif.freemarker.LifecycleRenderingContext;
22  
23  /**
24   * Single-threaded view lifecycle processor implementation.
25   * 
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public class SynchronousViewLifecycleProcessor extends ViewLifecycleProcessorBase {
29  
30      /**
31       * Pending lifecycle phases.
32       */
33      private final Deque<ViewLifecyclePhase> pendingPhases = new LinkedList<ViewLifecyclePhase>();
34  
35      /**
36       * The phase currently active on this lifecycle.
37       */
38      private ViewLifecyclePhase activePhase;
39  
40      /**
41       * The rendering context.
42       */
43      private LifecycleRenderingContext renderingContext;
44  
45      /**
46       * Creates a new synchronous processor for a lifecycle.
47       * 
48       * @param lifecycle The lifecycle to process.
49       */
50      public SynchronousViewLifecycleProcessor(ViewLifecycle lifecycle) {
51          super(lifecycle);
52      }
53  
54      /**
55       * {@inheritDoc}
56       */
57      public LifecycleRenderingContext getRenderingContext() {
58          if (renderingContext == null && ViewLifecycle.isRenderInLifecycle()) {
59              ViewLifecycle lifecycle = getLifecycle();
60              this.renderingContext = new LifecycleRenderingContext(
61                      lifecycle.model, lifecycle.request, lifecycle.response);
62          }
63  
64          return this.renderingContext;
65      }
66  
67      /**
68       * {@inheritDoc}
69       */
70      @Override
71      public ViewLifecyclePhase getActivePhase() {
72          return activePhase;
73      }
74  
75      /**
76       * {@inheritDoc}
77       */
78      @Override
79      void setActivePhase(ViewLifecyclePhase phase) {
80          if (activePhase != null && phase != null) {
81              throw new IllegalStateException("Another phase is already active on this lifecycle thread " + activePhase);
82          }
83  
84          activePhase = phase;
85      }
86  
87      /**
88       * {@inheritDoc}
89       */
90      @Override
91      public void offerPendingPhase(ViewLifecyclePhase pendingPhase) {
92          pendingPhases.offer(pendingPhase);
93      }
94  
95      /**
96       * {@inheritDoc}
97       */
98      @Override
99      public void pushPendingPhase(ViewLifecyclePhase phase) {
100         pendingPhases.push(phase);
101     }
102 
103     /**
104      * {@inheritDoc}
105      */
106     @Override
107     public void performPhase(ViewLifecyclePhase initialPhase) {
108         offerPendingPhase(initialPhase);
109         while (!pendingPhases.isEmpty()) {
110             pendingPhases.poll().run();
111         }
112     }
113 
114 }