com.aliyun.openservices.ons.api.Admin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ons-client-ext Show documentation

There is a newer version: 1.9.3.Final

package com.aliyun.openservices.ons.api;

import java.util.Properties;

/**
 * 管理类接口
 */
public interface Admin {
    /**
     * 检查服务是否已经启动.
     *
     * @return true如果服务已启动; 其它情况返回false
     * @see Admin#isClosed()
     */
    boolean isStarted();

    /**
     * 检查服务是否已经关闭
     *
     * @return true如果服务已关闭; 其它情况返回false
     * @see Admin#isStarted()
     */
    boolean isClosed();

    /**
     * 启动服务
     */
    void start();

    /**
     * 更新凭据 (AccessKey/SecretKey/SecurityToken/ONSChannel)
     * 动态更新访问凭据
     * @param credentialProperties STSToken相关的信息
     */
    void updateCredential(Properties credentialProperties);

    /**
     * 关闭服务
     */
    void shutdown();
}