001    package org.apache.fulcrum.yaafi.framework.component;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.fulcrum.yaafi.framework.role.RoleEntry;
023    
024    /**
025     * This interface defines a service component singleton with
026     * an arbitrary lifecycle.
027     *
028     * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
029     */
030    
031    public interface ServiceComponent extends ServiceComponentLifecycle
032    {
033        /**
034         * Get the unique name of the service component instance.
035         * @return the name of the service component
036         */
037        String getName();
038    
039        /**
040         * Get the shorthand of the service component instance. The
041         * shorthand is usually used to lookup the configuration
042         * entries.
043         * @return the shorthand of the service component
044         */
045        String getShorthand();
046    
047        /**
048         * Returns the associates role entry parsed from the role configuration file.
049         * @return the role entry
050         */
051        RoleEntry getRoleEntry();
052    }