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.model;
023
024import org.nuxeo.runtime.service.TimestampedService;
025
026/**
027 * A Nuxeo Runtime component.
028 * <p>
029 * Components are extensible and adaptable objects and they provide methods to respond to component life cycle events.
030 *
031 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
032 */
033public interface Component extends Extensible, TimestampedService {
034
035    /**
036     * Activates the component.
037     * <p>
038     * This method is called by the runtime when a component is activated.
039     *
040     * @param context the runtime context
041     */
042    void activate(ComponentContext context);
043
044    /**
045     * Deactivates the component.
046     * <p>
047     * This method is called by the runtime when a component is deactivated.
048     *
049     * @param context the runtime context
050     */
051    void deactivate(ComponentContext context);
052
053    /**
054     * The component notification order for {@link #applicationStarted}.
055     * <p>
056     * Components are notified in increasing order. Order 1000 is the default order for components that don't care.
057     * Order 100 is the repository initialization.
058     *
059     * @return the order, 1000 by default
060     * @since 5.6
061     */
062    int getApplicationStartedOrder();
063
064    /**
065     * Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
066     */
067    void applicationStarted(ComponentContext context);
068
069}