com.haulmont.restapi.config

Class RestServicesConfiguration

java.lang.Object

com.haulmont.restapi.config.RestServicesConfiguration

@Component(value="cuba_RestServicesConfiguration")
public class RestServicesConfiguration
extends java.lang.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 cuba.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 and Description
static class	RestServicesConfiguration.RestMethodInfo
static class	RestServicesConfiguration.RestMethodParamInfo
static class	RestServicesConfiguration.RestServiceInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUBA_REST_SERVICES_CONFIG_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
RestServicesConfiguration()

Method Summary

Modifier and Type	Method and Description
RestServicesConfiguration.RestMethodInfo	getRestMethodInfo(java.lang.String serviceName, java.lang.String methodName, java.util.List<java.lang.String> methodParamNames)
RestServicesConfiguration.RestServiceInfo	getServiceInfo(java.lang.String serviceName)
java.util.Collection<RestServicesConfiguration.RestServiceInfo>	getServiceInfos()
java.lang.reflect.Method	getServiceMethod(java.lang.String serviceName, java.lang.String methodName, java.util.List<java.lang.String> methodParamNames) Deprecated. the method will be removed in one of next releases. Use getRestMethodInfo(String, String, List) instead

Methods inherited from class java.lang.Object

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

Field Detail

CUBA_REST_SERVICES_CONFIG_PROP_NAME

public static final java.lang.String CUBA_REST_SERVICES_CONFIG_PROP_NAME

See Also:

Constant Field Values

Constructor Detail

RestServicesConfiguration

public RestServicesConfiguration()

Method Detail

getServiceMethod

@Nullable
 @Deprecated
public java.lang.reflect.Method getServiceMethod(java.lang.String serviceName,
                                                                        java.lang.String methodName,
                                                                        java.util.List<java.lang.String> methodParamNames)

Deprecated. the method will be removed in one of next releases. Use getRestMethodInfo(String, String, List) instead

getRestMethodInfo

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

getServiceInfos

public java.util.Collection<RestServicesConfiguration.RestServiceInfo> getServiceInfos()

getServiceInfo

@Nullable
public RestServicesConfiguration.RestServiceInfo getServiceInfo(java.lang.String serviceName)