1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
package org.mule.lifecycle; |
11 | |
|
12 | |
import org.mule.api.lifecycle.Disposable; |
13 | |
import org.mule.api.lifecycle.Initialisable; |
14 | |
import org.mule.api.lifecycle.LifecycleCallback; |
15 | |
import org.mule.api.lifecycle.LifecycleException; |
16 | |
import org.mule.api.lifecycle.LifecycleManager; |
17 | |
import org.mule.api.lifecycle.LifecycleState; |
18 | |
import org.mule.api.lifecycle.Startable; |
19 | |
import org.mule.api.lifecycle.Stoppable; |
20 | |
import org.mule.lifecycle.phases.NotInLifecyclePhase; |
21 | |
|
22 | |
import java.util.HashSet; |
23 | |
import java.util.LinkedHashSet; |
24 | |
import java.util.Set; |
25 | |
import java.util.TreeMap; |
26 | |
|
27 | |
import org.apache.commons.logging.Log; |
28 | |
import org.apache.commons.logging.LogFactory; |
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
public abstract class AbstractLifecycleManager<O> implements LifecycleManager |
39 | |
{ |
40 | |
|
41 | |
|
42 | |
|
43 | |
|
44 | 0 | protected transient final Log logger = LogFactory.getLog(AbstractLifecycleManager.class); |
45 | |
|
46 | |
protected String lifecycleManagerId; |
47 | 0 | protected String currentPhase = NotInLifecyclePhase.PHASE_NAME; |
48 | 0 | protected String executingPhase = null; |
49 | 0 | private Set<String> directTransitions = new HashSet<String>(); |
50 | 0 | protected Set<String> phaseNames = new LinkedHashSet<String>(4); |
51 | 0 | protected Set<String> completedPhases = new LinkedHashSet<String>(4); |
52 | |
protected O object; |
53 | |
protected LifecycleState state; |
54 | |
|
55 | 0 | private TreeMap<String, LifecycleCallback> callbacks = new TreeMap<String, LifecycleCallback>(); |
56 | |
|
57 | |
|
58 | |
public AbstractLifecycleManager(String id, O object) |
59 | 0 | { |
60 | 0 | lifecycleManagerId = id; |
61 | 0 | this.object = object; |
62 | 0 | state = createLifecycleState(); |
63 | |
|
64 | 0 | currentPhase = NotInLifecyclePhase.PHASE_NAME; |
65 | 0 | completedPhases.add(currentPhase); |
66 | 0 | registerTransitions(); |
67 | 0 | } |
68 | |
|
69 | |
protected abstract void registerTransitions(); |
70 | |
|
71 | |
public void registerLifecycleCallback(String phaseName, LifecycleCallback<O> callback) |
72 | |
{ |
73 | 0 | callbacks.put(phaseName, callback); |
74 | 0 | } |
75 | |
|
76 | |
protected LifecycleState createLifecycleState() |
77 | |
{ |
78 | 0 | return new DefaultLifecycleState(this); |
79 | |
} |
80 | |
|
81 | |
protected void addDirectTransition(String phase1, String phase2) |
82 | |
{ |
83 | 0 | directTransitions.add(phase1 + "-" + phase2); |
84 | 0 | phaseNames.add(phase1); |
85 | 0 | phaseNames.add(phase2); |
86 | 0 | } |
87 | |
|
88 | |
public void checkPhase(String name) throws IllegalStateException |
89 | |
{ |
90 | 0 | if (executingPhase != null) |
91 | |
{ |
92 | 0 | if (name.equalsIgnoreCase(executingPhase)) |
93 | |
{ |
94 | 0 | throw new IllegalStateException("Phase '" + name + "' is already currently being executed"); |
95 | |
} |
96 | |
else |
97 | |
{ |
98 | 0 | throw new IllegalStateException("Cannot fire phase '" + name + "', currently executing lifecycle phase: " + executingPhase); |
99 | |
} |
100 | |
} |
101 | |
|
102 | 0 | if (name.equalsIgnoreCase(currentPhase)) |
103 | |
{ |
104 | 0 | throw new IllegalStateException("Already in lifecycle phase '" + name + "', cannot fire the same phase twice"); |
105 | |
} |
106 | |
|
107 | |
|
108 | 0 | if (!phaseNames.contains(name)) |
109 | |
{ |
110 | 0 | throw new IllegalStateException("Phase does not exist: " + name); |
111 | |
} |
112 | |
else |
113 | |
{ |
114 | 0 | if (isDirectTransition(name)) |
115 | |
{ |
116 | 0 | return; |
117 | |
} |
118 | |
|
119 | 0 | throw new IllegalStateException("Lifecycle Manager '" + lifecycleManagerId + "' phase '" + currentPhase + "' does not support phase '" + name + "'"); |
120 | |
} |
121 | |
} |
122 | |
|
123 | |
public O getLifecycleObject() |
124 | |
{ |
125 | 0 | return object; |
126 | |
} |
127 | |
|
128 | |
public void fireLifecycle(String phase) throws LifecycleException |
129 | |
{ |
130 | 0 | checkPhase(phase); |
131 | 0 | invokePhase(phase, object, callbacks.get(phase)); |
132 | 0 | } |
133 | |
|
134 | |
protected void invokePhase(String phase, Object object, LifecycleCallback callback) throws LifecycleException |
135 | |
{ |
136 | |
try |
137 | |
{ |
138 | 0 | setExecutingPhase(phase); |
139 | 0 | callback.onTransition(phase, object); |
140 | 0 | setCurrentPhase(phase); |
141 | |
} |
142 | 0 | catch (LifecycleException e) |
143 | |
{ |
144 | 0 | throw e; |
145 | |
} |
146 | 0 | catch (Exception e) |
147 | |
{ |
148 | 0 | throw new LifecycleException(e, object); |
149 | |
} |
150 | |
finally |
151 | |
{ |
152 | 0 | setExecutingPhase(null); |
153 | 0 | } |
154 | |
|
155 | 0 | } |
156 | |
|
157 | |
public boolean isDirectTransition(String destinationPhase) |
158 | |
{ |
159 | 0 | return isDirectTransition(getCurrentPhase(), destinationPhase); |
160 | |
} |
161 | |
|
162 | |
protected boolean isDirectTransition(String startPhase, String endPhase) |
163 | |
{ |
164 | 0 | String key = startPhase + "-" + endPhase; |
165 | 0 | return directTransitions.contains(key); |
166 | |
} |
167 | |
|
168 | |
public String getCurrentPhase() |
169 | |
{ |
170 | 0 | return currentPhase; |
171 | |
} |
172 | |
|
173 | |
protected void setCurrentPhase(String currentPhase) |
174 | |
{ |
175 | 0 | this.currentPhase = currentPhase; |
176 | 0 | completedPhases.add(currentPhase); |
177 | |
|
178 | 0 | if (currentPhase.equals(Stoppable.PHASE_NAME)) |
179 | |
{ |
180 | 0 | completedPhases.remove(Startable.PHASE_NAME); |
181 | |
} |
182 | 0 | else if (currentPhase.equals(Disposable.PHASE_NAME)) |
183 | |
{ |
184 | 0 | completedPhases.remove(Initialisable.PHASE_NAME); |
185 | |
} |
186 | |
|
187 | 0 | notifyTransition(currentPhase); |
188 | |
|
189 | 0 | } |
190 | |
|
191 | |
public String getExecutingPhase() |
192 | |
{ |
193 | 0 | return executingPhase; |
194 | |
} |
195 | |
|
196 | |
protected void setExecutingPhase(String executingPhase) |
197 | |
{ |
198 | 0 | this.executingPhase = executingPhase; |
199 | 0 | } |
200 | |
|
201 | |
|
202 | |
|
203 | |
|
204 | |
|
205 | |
|
206 | |
|
207 | |
|
208 | |
protected void notifyTransition(String currentPhase) |
209 | |
{ |
210 | |
|
211 | 0 | } |
212 | |
|
213 | |
public void reset() |
214 | |
{ |
215 | 0 | completedPhases.clear(); |
216 | 0 | setExecutingPhase(null); |
217 | 0 | setCurrentPhase(NOT_IN_LIFECYCLE_PHASE.getName()); |
218 | 0 | completedPhases.add(getCurrentPhase()); |
219 | 0 | } |
220 | |
|
221 | |
public boolean isPhaseComplete(String phaseName) |
222 | |
{ |
223 | 0 | return completedPhases.contains(phaseName); |
224 | |
} |
225 | |
|
226 | |
public LifecycleState getState() |
227 | |
{ |
228 | 0 | return state; |
229 | |
} |
230 | |
|
231 | |
|
232 | |
} |