1 package org.apache.fulcrum.yaafi.framework.component;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
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 }