com.alipay.sofa.runtime.spi.component.Component Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.alipay.sofa.runtime.spi.component;

import com.alipay.sofa.runtime.api.ServiceRuntimeException;

/**
 * 
 * SOFA Component Interface.
 * Component Lifecycle:
 * 
 *                  [UNREGISTERED]
 *                      |   ▲
 *           register   │   │   unregister
 *                      |   |
 *                   [REGISTERED]
 *                      |   ▲
 *           resolve    │   │   unresolve
 *                      |   |
 *                    [RESOLVED]
 *                      |   ▲
 *                 ┌────┘   └────┐
 *                 │             │
 *        activate |             ▲ deactivate
 *                 │             │
 *                 └───┐    ┌────┘
 *                          |
 *                   [ACTIVATED]
 * 
 *
 * @author xuanbei 18/2/28
 */
public interface Component {

    /**
     * Register component.
     */
    void register();

    /**
     * Unregister component.
     */
    void unregister() throws ServiceRuntimeException;

    /**
     * Resolve component.
     *
     * @return success or not
     */
    boolean resolve();

    /**
     * Unresolve component.
     */
    void unresolve() throws ServiceRuntimeException;

    /**
     * Activate component.
     *
     * @throws ServiceRuntimeException
     */
    void activate() throws ServiceRuntimeException;

    /**
     * deactivate component
     *
     * @throws ServiceRuntimeException
     */
    void deactivate() throws ServiceRuntimeException;

    /**
     * Create an exception to describe error.
     *
     * @throws ServiceRuntimeException
     */
    void exception(Exception e) throws ServiceRuntimeException;
}