Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 7778b89ac9d3c8e891f3a5a154612b44fd934985 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/***************************************************************************
 * Copyright (c) 2004 - 2007 Eike Stepper, Germany.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *    Eike Stepper - initial API and implementation
 **************************************************************************/
package org.eclipse.net4j.internal.util.lifecycle;

import org.eclipse.net4j.internal.util.bundle.OM;
import org.eclipse.net4j.internal.util.event.Notifier;
import org.eclipse.net4j.internal.util.om.trace.ContextTracer;
import org.eclipse.net4j.util.ReflectUtil;
import org.eclipse.net4j.util.lifecycle.ILifecycle;
import org.eclipse.net4j.util.lifecycle.ILifecycleEvent;
import org.eclipse.net4j.util.lifecycle.ILifecycleState;

/**
 * @author Eike Stepper
 */
public class Lifecycle extends Notifier implements ILifecycle.Introspection
{
  public static boolean USE_LABEL = true;

  private static final ContextTracer TRACER = new ContextTracer(OM.DEBUG_LIFECYCLE, Lifecycle.class);

  private static final ContextTracer DUMPER = new ContextTracer(OM.DEBUG_LIFECYCLE_DUMP, Lifecycle.class);

  private static final boolean TRACE_IGNORING = false;

  private ILifecycleState lifecycleState = ILifecycleState.INACTIVE;

  protected Lifecycle()
  {
  }

  public final void activate() throws Exception
  {
    if (lifecycleState == ILifecycleState.INACTIVE)
    {
      if (TRACER.isEnabled())
      {
        TRACER.trace("Activating " + this);//$NON-NLS-1$
      }

      lifecycleState = ILifecycleState.ACTIVATING;
      fireEvent(new LifecycleEvent(this, ILifecycleEvent.Kind.ABOUT_TO_ACTIVATE));
      doBeforeActivate();
      doActivate();

      if (!isDeferredActivation())
      {
        deferredActivate();
      }
    }
    else
    {
      if (TRACE_IGNORING && TRACER.isEnabled())
      {
        TRACER.format("Ignoring activation in state {0} for {1}", lifecycleState, this);//$NON-NLS-1$
      }
    }
  }

  public final Exception deactivate()
  {
    if (lifecycleState == ILifecycleState.ACTIVE || lifecycleState == ILifecycleState.ACTIVATING)
    {
      if (TRACER.isEnabled())
      {
        TRACER.trace("Deactivating " + this);//$NON-NLS-1$
      }

      try
      {
        lifecycleState = ILifecycleState.DEACTIVATING;
        doBeforeDeactivate();
        fireEvent(new LifecycleEvent(this, ILifecycleEvent.Kind.ABOUT_TO_DEACTIVATE));

        if (!isDeferredDeactivation())
        {
          deferredDeactivate();
        }
      }
      catch (Exception ex)
      {
        OM.LOG.error(ex);
        return ex;
      }
      finally
      {
        lifecycleState = ILifecycleState.INACTIVE;
      }
    }
    else
    {
      if (TRACE_IGNORING && TRACER.isEnabled())
      {
        TRACER.format("Ignoring deactivation in state {0} for {1}", lifecycleState, this);//$NON-NLS-1$
      }
    }

    return null;
  }

  public final ILifecycleState getLifecycleState()
  {
    return lifecycleState;
  }

  public final boolean isActive()
  {
    return lifecycleState == ILifecycleState.ACTIVE;
  }

  @Override
  public String toString()
  {
    if (USE_LABEL)
    {
      return ReflectUtil.getLabel(this);
    }

    return super.toString();
  }

  protected final void dump()
  {
    if (DUMPER.isEnabled())
    {
      DUMPER.trace("DUMP" + ReflectUtil.toString(this)); //$NON-NLS-1$
    }
  }

  protected final void checkActive()
  {
    if (lifecycleState != ILifecycleState.ACTIVE)
    {
      throw new IllegalStateException("Not active: " + this);
    }
  }

  protected final void checkInactive()
  {
    if (lifecycleState != ILifecycleState.INACTIVE)
    {
      throw new IllegalStateException("Not inactive: " + this);
    }
  }

  protected final void deferredActivate()
  {
    lifecycleState = ILifecycleState.ACTIVE;
    fireEvent(new LifecycleEvent(this, ILifecycleEvent.Kind.ACTIVATED));
    dump();
  }

  protected final void deferredDeactivate() throws Exception
  {
    doDeactivate();
    fireEvent(new LifecycleEvent(this, ILifecycleEvent.Kind.DEACTIVATED));
  }

  protected boolean isDeferredActivation()
  {
    return false;
  }

  protected boolean isDeferredDeactivation()
  {
    return false;
  }

  protected void doBeforeActivate() throws Exception
  {
  }

  protected void doActivate() throws Exception
  {
  }

  protected void doBeforeDeactivate() throws Exception
  {
  }

  protected void doDeactivate() throws Exception
  {
  }
}

Back to the top