001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 */
020
021package org.nuxeo.ecm.platform.commandline.executor.api;
022
023/**
024 * Exception indicating that the target command is not available:
025 * <ul>
026 * <li>because it was never registered,
027 * <li>because it was disabled,
028 * <li>because the target command is not installed on the server *.
029 * </ul>
030 *
031 * @author tiry
032 */
033public class CommandNotAvailable extends Exception {
034
035    private static final long serialVersionUID = 1L;
036
037    protected final CommandAvailability availability;
038
039    public CommandNotAvailable(CommandAvailability availability) {
040        this.availability = availability;
041    }
042
043    public String getInstallMessage() {
044        return availability.getInstallMessage();
045    }
046
047    public String getErrorMessage() {
048        return availability.getErrorMessage();
049    }
050
051    /**
052     * @since 5.5
053     */
054    @Override
055    public String getMessage() {
056        String msg = getErrorMessage() != null ? getErrorMessage() + ". " : "";
057        msg += getInstallMessage() != null ? getInstallMessage() + ". " : "";
058        return msg + super.getMessage();
059    }
060
061}