001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.geronimo.gshell.command;
021    
022    /**
023     * Provides the basic interface for commands.
024     *
025     * @version $Rev: 573330 $ $Date: 2007-09-06 11:20:42 -0700 (Thu, 06 Sep 2007) $
026     */
027    public interface Command
028    {
029        /** Standard command success status code. */
030        Result SUCCESS = Result.SUCCESS;
031    
032        /** Standard command failure status code. */
033        Result FAILURE = Result.FAILURE;
034    
035        /**
036         * Initialize the command with its execution context.
037         */
038        void init(CommandContext context);
039    
040        /**
041         * Execute the commands behavior.
042         */
043        Object execute(Object... args) throws Exception;
044    
045        //
046        // Result
047        //
048    
049        enum Result
050        {
051            SUCCESS,
052            FAILURE
053        }
054    }