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
/**
* $RCSfile$
* $Revision: 626 $
* $Date: 2004-12-05 12:15:18 -0300 (Sun, 05 Dec 2004) $
*
* Copyright (C) 2004-2008 Jive Software. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.openfire.container;
import org.jivesoftware.openfire.XMPPServer;
/**
* A default Module implementation that basically avoids subclasses having to implement the whole
* Module interface.
*
* @author Gaston Dombiak
*/
public class BasicModule implements Module {
/**
* The name of the module
*/
private String name;
/**
* <p>Create a basic module with the given name.</p>
*
* @param moduleName The name for the module or null to use the default
*/
public BasicModule(String moduleName) {
if (moduleName == null) {
this.name = "No name assigned";
}
else {
this.name = moduleName;
}
}
/**
* <p>Obtain the name of the module.</p>
*
* @return The name of the module
*/
public String getName() {
return name;
}
/**
* <p>Initializes the basic module.</p>
* <p>Inheriting classes that choose to override this method MUST
* call this initialize() method before accessing BasicModule resources.</p>
*
* @param server the server hosting this module.
*/
public void initialize(XMPPServer server) {
}
/**
* <p>Starts the basic module.</p>
* <p>Inheriting classes that choose to override this method MUST
* call this start() method before accessing BasicModule resources.</p>
*
* @throws IllegalStateException If start is called before initialize
* successfully returns
*/
public void start() throws IllegalStateException {
}
/**
* <p>Stops the basic module.</p>
* <p>Inheriting classes that choose to override this method MUST
* call this stop() method before accessing BasicModule resources.</p>
*/
public void stop() {
}
/**
* <p>Destroys the module.</p>
* <p>Does nothing in the basic module.</p>
*/
public void destroy() {
}
}