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 * $Id$
020 */
021
022package org.nuxeo.runtime;
023
024/**
025 * A runtime extension is a service that is started by the runtime when it starts using the runtime service context.
026 * <p>
027 * Runtime Extensions may be used to add new functionality to the runtime service.
028 *
029 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
030 */
031public interface RuntimeExtension {
032
033    /**
034     * Starts the runtime extension.
035     * <p>
036     * The current runtime is available as <code>Runtime.getRuntime()</code>.
037     */
038    void start();
039
040    /**
041     * Stops the runtime extension.
042     * <p>
043     * The current runtime is available as <code>Runtime.getRuntime()</code>.
044     */
045    void stop();
046
047}