001/*
002 * (C) Copyright 2006-2010 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 *     bstefanescu
018 */
019package org.nuxeo.shell.cmds;
020
021/**
022 * Give a chance to embedded shells to do some customization before shell is started and when exit is required.
023 * <p>
024 * This is currently used by shell applet to correctly handle start and stop.
025 *
026 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
027 */
028public interface InteractiveShellHandler {
029
030    /**
031     * Interactive shell will be started.
032     */
033    void enterInteractiveMode();
034
035    /**
036     * Interactive shell should be disposed. This method should dispose the current session. If no handler is defined
037     * the Java process will exit with the given code (if <= 0 - normal exit, otherwise an exit with given code is
038     * performed). Return true to exit the shell loop, false otherwise.
039     *
040     * @param code
041     */
042    boolean exitInteractiveMode(int code);
043
044}