1 package org.apache.fulcrum.yaafi.framework.component;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.fulcrum.yaafi.framework.role.RoleEntry;
23
24 /**
25 * This interface defines a service component singleton with
26 * an arbitrary lifecycle.
27 *
28 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
29 */
30
31 public interface ServiceComponent extends ServiceComponentLifecycle
32 {
33 /**
34 * Get the unique name of the service component instance.
35 * @return the name of the service component
36 */
37 String getName();
38
39 /**
40 * Get the shorthand of the service component instance. The
41 * shorthand is usually used to lookup the configuration
42 * entries.
43 * @return the shorthand of the service component
44 */
45 String getShorthand();
46
47 /**
48 * Returns the associates role entry parsed from the role configuration file.
49 * @return the role entry
50 */
51 RoleEntry getRoleEntry();
52 }