com.flyfish.oauth.client.OAuth2SsoClient Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.0.7

package com.flyfish.oauth.client;

import com.flyfish.oauth.configuration.OAuth2SsoProperties;
import com.flyfish.oauth.configuration.OAuth2SsoUserService;
import com.flyfish.oauth.configuration.SSOSessionConverter;

/**
 * 开放统一认证客户端
 *
 * @author wangyu
 */
public interface OAuth2SsoClient {

    /**
     * 初始化方法，通知相关组件加载
     */
    void init();

    /**
     * 设置用户信息Service，用于上报给中心授权服务器
     *
     * @param userInfoService 用户信息服务
     */
    void setUserInfoService(OAuth2SsoUserService userInfoService);

    /**
     * 获取相关客户端属性
     *
     * @return 相关客户端属性
     */
    OAuth2SsoProperties getProperties();

    /**
     * 配置相关客户端属性
     *
     * @param properties 属性
     */
    void setProperties(OAuth2SsoProperties properties);

    /**
     * 获取 Session转化器
     *
     * @return Session转化器
     */
     SSOSessionConverter getSessionConverter();

    /**
     * 设置Session转化器，转化统一用户信息到系统需要的session信息
     *
     * @param sessionConverter 转换器
     */
    void setSessionConverter(SSOSessionConverter sessionConverter);

    /**
     * 获取用户信息Service
     *
     * @return 用户信息Service
     */
     OAuth2SsoUserService getUserService();
}