View Javadoc

    1   package org.apache.turbine.services.avaloncomponent;
    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.avalon.framework.service.ServiceManager;
    23  import org.apache.turbine.services.Service;
    24  import org.apache.turbine.services.TurbineServiceProvider;
    25
    26  /**
    27   * This service allows access to avalon components.
    28   *
    29   * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
    30   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
    31   * @version $Id: AvalonComponentService.java 615328 2008-01-25 20:25:05Z tv $
    32   */
    33  public interface AvalonComponentService
    34          extends Service, ServiceManager, TurbineServiceProvider
    35  {
    36      /** The publically visible name of the service */
    37      String SERVICE_NAME = "AvalonComponentService";
    38
    39      /** Where we write the Avalon Logger messages */
    40      String AVALON_LOG_CATEGORY = "avalon";
    41
    42      /** property specifing file name of the component config file */
    43      String COMPONENT_CONFIG_KEY = "componentConfiguration";
    44
    45      /** property specifing file name of the component config file */
    46      String COMPONENT_CONFIG_VALUE = "/WEB-INF/conf/componentConfiguration.xml";
    47
    48      /** property specifing file name of the component role file */
    49      String COMPONENT_ROLE_KEY = "componentRoles";
    50
    51      /** property specifing file name of the component role file */
    52      String COMPONENT_ROLE_VALUE = "/WEB-INF/conf/roleConfiguration.xml";
    53
    54      /** property for the Components to look up */
    55      String COMPONENT_LOOKUP_KEY = "lookup";
    56
    57      /** Key used in the context for defining the application root */
    58      String COMPONENT_APP_ROOT = "componentAppRoot";
    59  }