com.alibaba.nacos.auth

类 AbstractProtocolAuthService<R>

java.lang.Object

com.alibaba.nacos.auth.AbstractProtocolAuthService<R>

所有已实现的接口:

ProtocolAuthService<R>

直接已知子类:

GrpcProtocolAuthService, HttpProtocolAuthService

public abstract class AbstractProtocolAuthService<R>
extends Object
implements ProtocolAuthService<R>

Abstract protocol auth service.

Implement #validateIdentity and #validateAuthority method template.

作者:

xiweng.yy

字段概要

字段

限定符和类型	字段和说明
protected AuthConfigs	authConfigs

构造器概要

构造器

限定符	构造器和说明
protected	AbstractProtocolAuthService(AuthConfigs authConfigs)

方法概要

限定符和类型	方法和说明
boolean	enableAuth(Secured secured) Judgement whether enable auth feature according to secured information.
protected Resource	parseSpecifiedResource(Secured secured) Get resource from secured annotation specified resource.
protected Resource	useSpecifiedParserToParse(Secured secured, R request) Parse resource by specified resource parser.
boolean	validateAuthority(IdentityContext identityContext, Permission permission) Validate identity whether had permission for the resource and action.
boolean	validateIdentity(IdentityContext identityContext, Resource resource) Validate identity whether is legal.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.alibaba.nacos.auth.ProtocolAuthService

initialize, parseIdentity, parseResource

字段详细资料

authConfigs

protected final AuthConfigs authConfigs

构造器详细资料

AbstractProtocolAuthService

protected AbstractProtocolAuthService(AuthConfigs authConfigs)

方法详细资料

enableAuth

public boolean enableAuth(Secured secured)

从接口复制的说明: ProtocolAuthService

Judgement whether enable auth feature according to secured information.

configuration authEnabled in AuthConfigs is the main switch. If authEnabled is false, this method and other follow methods should not be called. This method is only for plugin to judge whether auth this Secured. For example, plugins can only auth for write action or only for naming type request.

指定者:

enableAuth 在接口中 ProtocolAuthService<R>

参数:

secured - secured information

返回:

true if enable auth, otherwise false

validateIdentity

public boolean validateIdentity(IdentityContext identityContext,
                                Resource resource)
                         throws AccessException

从接口复制的说明: ProtocolAuthService

Validate identity whether is legal.

指定者:

validateIdentity 在接口中 ProtocolAuthService<R>

参数:

identityContext - identity context

resource - resource

返回:

true if legal, otherwise false

抛出:

AccessException - exception during validating

validateAuthority

public boolean validateAuthority(IdentityContext identityContext,
                                 Permission permission)
                          throws AccessException

从接口复制的说明: ProtocolAuthService

Validate identity whether had permission for the resource and action.

指定者:

validateAuthority 在接口中 ProtocolAuthService<R>

参数:

identityContext - identity context

permission - permission include resource and action

返回:

true if legal, otherwise false

抛出:

AccessException - exception during validating

parseSpecifiedResource

protected Resource parseSpecifiedResource(Secured secured)

Get resource from secured annotation specified resource.

参数:

secured - secured annotation

返回:

resource

useSpecifiedParserToParse

protected Resource useSpecifiedParserToParse(Secured secured,
                                             R request)

Parse resource by specified resource parser.

参数:

secured - secured annotation

request - request

返回:

resource