/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.avalon.framework.service;

import org.apache.avalon.framework.CascadingException;

The exception thrown to indicate a problem with service.
It is usually thrown by ServiceManager or ServiceSelector.
Author:
Avalon Development Team
Version:
$Id: ServiceException.java 506231 2007-02-12 02:36:54Z crossley $/**
 * The exception thrown to indicate a problem with service.
 * It is usually thrown by ServiceManager or ServiceSelector.
 *
 * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
 * @version $Id: ServiceException.java 506231 2007-02-12 02:36:54Z crossley $
 */
public class ServiceException
    extends CascadingException
{
    private final String m_key;

    
Construct a new ServiceException instance.
Params:
message – the exception message
throwable – the throwable
Deprecated:
use the String,String,Throwable version instead/**
     * Construct a new <code>ServiceException</code> instance.
     *
     * @deprecated use the String,String,Throwable version instead
     * @param message the exception message
     * @param throwable the throwable
     */
    public ServiceException( final String message, final Throwable throwable )
    {
        this( null, message, throwable );
    }

    
Construct a new ServiceException instance.
Params:
key – the lookup key
message – the exception message
throwable – the throwable/**
     * Construct a new <code>ServiceException</code> instance.
     *
     * @param key the lookup key
     * @param message the exception message
     * @param throwable the throwable
     */
    public ServiceException( final String key, final String message, final Throwable throwable )
    {
        super( message, throwable );
        m_key = key;
    }

    
Construct a new ServiceException instance.
Params:
message – the exception message
Deprecated:
use the String,String version instead/**
     * Construct a new <code>ServiceException</code> instance.
     *
     * @deprecated use the String,String version instead
     * @param message the exception message
     */
    public ServiceException( final String message )
    {
        this( null, message, null );
    }

    
Construct a new ServiceException instance.
Params:
key – the lookup key
message – the exception message/**
     * Construct a new <code>ServiceException</code> instance.
     *
     * @param key the lookup key
     * @param message the exception message
     */
    public ServiceException( final String key, final String message )
    {
        this( key, message, null );
    }

    
Return the key that caused the exception.
Returns:
the lookup key triggering the exception/**
     * Return the key that caused the exception.
     * @return the lookup key triggering the exception
     */
    public String getKey()
    {
        return m_key;
    }

    
Return the role that caused the exception
Deprecated:
Use getKey() instead
Returns:
the the lookup key triggering the exception/**
     * Return the role that caused the exception
     *
     * @deprecated Use getKey() instead
     * @return the the lookup key triggering the exception
     */
    public String getRole()
    {
        return getKey();
    }

    
Override super's message to add role if applicable.
Returns:
a message./**
     * Override super's message to add role if applicable.
     * @return a message.
     */
    public String getMessage()
    {
        if( m_key == null )
        {
            return super.getMessage();
        }
        else
        {
            return super.getMessage() + " (Key='" + m_key + "')";
        }
    }
}