Package io.jmix.rest.impl.config

Class RestServicesConfiguration

java.lang.Object

io.jmix.rest.impl.config.RestServicesConfiguration

@Component("rest_RestServicesConfiguration")
public class RestServicesConfiguration
extends Object

Class is used for loading and storing an information about service methods that are available for REST API. information loaded from configuration files defined by the jmix.rest.servicesConfig application property.

Configuration file must define method name and method argument names that will be user for method invocation by the REST API.

Method parameter types can be omitted if the service doesn't contain an overloaded method with the same parameters number. Otherwise, types must be defined.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestServicesConfiguration.RestMethodInfo
static class	RestServicesConfiguration.RestMethodParamInfo
static class	RestServicesConfiguration.RestServiceInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.beans.factory.BeanFactory	beanFactory
protected org.springframework.core.env.Environment	environment
protected boolean	initialized
static final String	JMIX_REST_SERVICES_CONFIG_PROP_NAME
protected JmixModulesClasspathScanner	jmixModulesClasspathScanner
protected ReadWriteLock	lock
protected Resources	resources
protected Map<String,RestServicesConfiguration.RestServiceInfo>	serviceInfosMap

Constructor Summary

Constructors

Constructor	Description
RestServicesConfiguration()

Method Summary

Modifier and Type	Method	Description
protected Method	_findMethod(String serviceName, String methodName, List<RestServicesConfiguration.RestMethodParamInfo> paramInfos)
protected void	checkInitialized()
RestServicesConfiguration.RestMethodInfo	getRestMethodInfo(String serviceName, String methodName, String httpMethod, List<String> methodParamNames)
RestServicesConfiguration.RestServiceInfo	getServiceInfo(String serviceName)
Collection<RestServicesConfiguration.RestServiceInfo>	getServiceInfos()
protected boolean	httpMethodMatches(String httpMethod1, String httpMethod2)
protected void	init()
protected void	loadAnnotations()
protected void	loadConfig()
protected void	loadConfig(org.dom4j.Element rootElem)
protected boolean	paramsMatches(List<RestServicesConfiguration.RestMethodParamInfo> paramInfos, List<String> paramNames)

Methods inherited from class java.lang.Object

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

Field Details

JMIX_REST_SERVICES_CONFIG_PROP_NAME

public static final String JMIX_REST_SERVICES_CONFIG_PROP_NAME

See Also:

• Constant Field Values

serviceInfosMap

protected Map<String,RestServicesConfiguration.RestServiceInfo> serviceInfosMap

initialized

protected volatile boolean initialized

lock

protected ReadWriteLock lock

resources

@Autowired
protected Resources resources

environment

@Autowired
protected org.springframework.core.env.Environment environment

beanFactory

@Autowired
protected org.springframework.beans.factory.BeanFactory beanFactory

jmixModulesClasspathScanner

@Autowired
protected JmixModulesClasspathScanner jmixModulesClasspathScanner

Constructor Details

RestServicesConfiguration

public RestServicesConfiguration()

Method Details

getRestMethodInfo

@Nullable
public RestServicesConfiguration.RestMethodInfo getRestMethodInfo(String serviceName,
 String methodName,
 String httpMethod,
 List<String> methodParamNames)

httpMethodMatches

protected boolean httpMethodMatches(@Nullable
 String httpMethod1,
 @Nullable
 String httpMethod2)

paramsMatches

protected boolean paramsMatches(List<RestServicesConfiguration.RestMethodParamInfo> paramInfos,
 List<String> paramNames)

checkInitialized

protected void checkInitialized()

init

protected void init()

loadConfig

protected void loadConfig()

loadConfig

protected void loadConfig(org.dom4j.Element rootElem)

loadAnnotations

protected void loadAnnotations()

_findMethod

@Nullable
protected Method _findMethod(String serviceName,
 String methodName,
 List<RestServicesConfiguration.RestMethodParamInfo> paramInfos)

getServiceInfos

public Collection<RestServicesConfiguration.RestServiceInfo> getServiceInfos()

getServiceInfo

@Nullable
public RestServicesConfiguration.RestServiceInfo getServiceInfo(String serviceName)