com.yeepay.yop.sdk.auth.credentials.provider

接口 YopCredentialsProvider

public interface YopCredentialsProvider

title: Interface for providing YOP credentials.
description: Implementations are free to use any strategy for providing YOP credentials, such as simply providing static credentials that don't change, or more complicated implementations, such as integrating with existing key management systems.
Copyright: Copyright (c) 2017
Company: 易宝支付(YeePay)

从以下版本开始:

17/11/14 17:27

版本:

1.0.0

作者:

menghao.chen

方法概要

限定符和类型	方法和说明
YopCredentials<?>	getCredentials(String appKey, String credentialType) Returns Credentials which the caller can use to authorize an YOP request.
default YopCredentials<?>	getCredentials(String provider, String env, String appKey, String credentialType) 加载指定服务方、环境下的客户端凭证
default String	getDefaultAppKey() 单应用时，用于加载默认配置 多应用时，用于指定默认应用(自定义provider时，须覆盖实现)
default String	getDefaultAppKey(String provider, String env) 获取指定服务方、环境下默认应用
default List<YopCertConfig>	getIsvEncryptKey(String appKey) 已过时。
default List<YopCertConfig>	getIsvEncryptKey(String provider, String env, String appKey) 已过时。
List<CertTypeEnum>	getSupportCertTypes(String appKey) 根据appKey获取应用下可用密钥类型
default List<CertTypeEnum>	getSupportCertTypes(String provider, String env, String appKey) 获取指定服务方、环境、应用下的可用密钥类型

方法详细资料

getCredentials

YopCredentials<?> getCredentials(String appKey,
                                 String credentialType)

Returns Credentials which the caller can use to authorize an YOP request. Each implementation of YOPCredentialsProvider can chose its own strategy for loading credentials. For example, an implementation might load credentials from an existing key managemenYopSignProcessort system, or load new credentials when credentials are rotated.

根据appKey与凭证类型(CertTypeEnum)，加载可用凭证，用于Yop请求的认证 商户可根据自身情况将凭证信息存储在安全的地方，可通过缓存提升性能

参数:

appKey - appKey:应用标识

credentialType - credentialType:凭证类型(CertTypeEnum)

返回:

YOPCredentials which the caller can use to authorize an YOP request.

getCredentials

default YopCredentials<?> getCredentials(String provider,
                                         String env,
                                         String appKey,
                                         String credentialType)

加载指定服务方、环境下的客户端凭证

参数:

provider - 服务方

env - 环境

appKey - 应用

credentialType - 密钥类型

返回:

客户端凭证

getSupportCertTypes

List<CertTypeEnum> getSupportCertTypes(String appKey)

根据appKey获取应用下可用密钥类型

参数:

appKey - 应用标识

返回:

密钥类型列表

getSupportCertTypes

default List<CertTypeEnum> getSupportCertTypes(String provider,
                                               String env,
                                               String appKey)

获取指定服务方、环境、应用下的可用密钥类型

参数:

provider - 服务方

env - 环境

appKey - 应用

返回:

可用密钥类型列表

getDefaultAppKey

default String getDefaultAppKey()

单应用时，用于加载默认配置 多应用时，用于指定默认应用(自定义provider时，须覆盖实现)

返回:

appKey 默认应用

getDefaultAppKey

default String getDefaultAppKey(String provider,
                                String env)

获取指定服务方、环境下默认应用

参数:

provider - 服务方

env - 环境

返回:

默认应用

getIsvEncryptKey

@Deprecated
default List<YopCertConfig> getIsvEncryptKey(String appKey)

已过时。

Returns symmetrical keys for using when decrypt yop certs from remote may be different by appKey may be not only one for retry

参数:

appKey - 应用标识

返回:

加密密钥

getIsvEncryptKey

@Deprecated
default List<YopCertConfig> getIsvEncryptKey(String provider,
                                                         String env,
                                                         String appKey)

已过时。

获取指定服务方、环境、应用的加密密钥列表(老国密)

参数:

provider - 服务方

env - 环境

appKey - 应用

返回:

加密密钥列表