/
ILifecycle.java
84 lines (76 loc) · 2.77 KB
/
ILifecycle.java
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
package org.opennaas.core.resources;
/*
* #%L
* OpenNaaS :: Core :: Resources
* %%
* Copyright (C) 2007 - 2014 Fundació Privada i2CAT, Internet i Innovació a Catalunya
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/lgpl-3.0.html>.
* #L%
*/
public interface ILifecycle {
/**
* Provide a status for the resource instance.
*/
public enum State {
INSTANTIATED, INITIALIZED, ACTIVE, INACTIVE, SHUTDOWN, ERROR
};
/**
* Returns the current resource state
*
* @return state enum object
*/
public State getState();
/**
* Sets the current engine state
*/
public void setState(State state);
/**
* Initializes this component, the status will be INITIALIZED, then will be ACTIVE if enabled.
*
* @throws IncorrectLifecycleStateException
* if this method is not allowed in current state
* @throws ResourceException
* if there is a problem during initialization
*/
public void initialize() throws IncorrectLifecycleStateException, ResourceException, CorruptStateException;
/**
* Activates this component and change state to ACTIVE.
*
* @throws IncorrectLifecycleStateException
* if this method is not allowed in current state
* @throws ResourceException
* if there is a problem during activation
*/
public void activate() throws IncorrectLifecycleStateException, ResourceException, CorruptStateException;
/**
* Deactivate this component and change state to INACTIVE
*
* @throws IncorrectLifecycleStateException
* if this method is not allowed in current state
* @throws ResourceException
* if there is a problem during deactivation
*/
public void deactivate() throws IncorrectLifecycleStateException, ResourceException, CorruptStateException;
/**
* Prepares component for Garbage Collection state will be SHUTDOWN until it is collected.
*
* @throws IncorrectLifecycleStateException
* if this method is not allowed in current state
* @throws ResourceException
* if there is a problem during shutting down
*/
public void shutdown() throws IncorrectLifecycleStateException, ResourceException, CorruptStateException;
}