org.apache.shenyu.client.core.register.registrar

Class AbstractApiDocRegistrar

java.lang.Object

org.apache.shenyu.client.core.register.registrar.AbstractApiRegistrar<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>

org.apache.shenyu.client.core.register.registrar.AbstractApiDocRegistrar

All Implemented Interfaces:

ApiRegistrar

Direct Known Subclasses:

HttpApiDocRegistrar, NoHttpApiDocRegistrar

public abstract class AbstractApiDocRegistrar
extends AbstractApiRegistrar<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractApiDocRegistrar.HttpApiSpecificInfo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractApiDocRegistrar(ShenyuClientRegisterEventPublisher publisher, ClientRegisterConfig clientRegisterConfig)

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractApiDocRegistrar.HttpApiSpecificInfo	doParse(ApiBean.ApiDefinition apiDefinition)
protected java.lang.Boolean	match(ApiBean.ApiDefinition apiDefinition) Determines whether the apiDefinition can be registered.
protected java.lang.Boolean	match(ApiBean apiBean) Determines whether apiDefinitions of apiBean can be filtered.
protected java.util.List<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>	parse(ApiBean.ApiDefinition apiDefinition) Parses the apiDefinition as a registrable objects.

Methods inherited from class org.apache.shenyu.client.core.register.registrar.AbstractApiRegistrar

preMatch, preParse, register

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.shenyu.client.core.register.registrar.ApiRegistrar

register, registerDataType

Constructor Detail

AbstractApiDocRegistrar

protected AbstractApiDocRegistrar(ShenyuClientRegisterEventPublisher publisher,
                                  ClientRegisterConfig clientRegisterConfig)

Method Detail

match

protected java.lang.Boolean match(ApiBean apiBean)

Description copied from class: AbstractApiRegistrar

Determines whether apiDefinitions of apiBean can be filtered.

Specified by:

match in class AbstractApiRegistrar<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>

Parameters:

apiBean - apiBean to be registered

Returns:

true or false

match

protected java.lang.Boolean match(ApiBean.ApiDefinition apiDefinition)

Description copied from class: AbstractApiRegistrar

Determines whether the apiDefinition can be registered.

Specified by:

match in class AbstractApiRegistrar<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>

Parameters:

apiDefinition - apiDefinition to be registered

Returns:

true or false

parse

protected java.util.List<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO> parse(ApiBean.ApiDefinition apiDefinition)

Description copied from class: AbstractApiRegistrar

Parses the apiDefinition as a registrable objects.

Specified by:

parse in class AbstractApiRegistrar<org.apache.shenyu.register.common.dto.ApiDocRegisterDTO>

Parameters:

apiDefinition - apiDefinition to be parsed

Returns:

doParse

protected abstract AbstractApiDocRegistrar.HttpApiSpecificInfo doParse(ApiBean.ApiDefinition apiDefinition)