|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InterfaceConfig
Interface configuration holder object.
Implementors must respect the following contract :
- No method return null except for the ones documented or when used as an override template (see Configs.override(InterfaceConfig, InterfaceConfig)
)
- Defaults values must either be taken from interface's defaults constant or from InterfaceContext.getProperties()
's defaults overrides.
- Every methods in the interface must have it's respective MethodConfig
configured.
- Every arguments of every methods in the interface must have it's respective ParamConfig
configured in its respective MethodConfig
object.
MethodConfig
,
ParamConfig
,
InterfaceConfigFactory
Field Summary | |
---|---|
static String |
DEFAULT_CONTEXT_PATH
Default service url fragment applied when non specified. |
static String |
DEFAULT_ENCODING
Default encoding applied when non specified. |
static Class<? extends RequestInterceptor> |
DEFAULT_GLOBAL_INTERCEPTOR
Default request interceptor applied when non specified. |
Method Summary | |
---|---|
String |
getContextPath()
Service base path (eg: /base/service/path). |
String |
getEncoding()
Encoding of the interface. |
String |
getEndPoint()
Server path (eg: http://www.my-end-point.com:8080) |
RequestInterceptor |
getGlobalInterceptor()
Global service request interceptor. |
Class<?> |
getInterface()
|
MethodConfig |
getMethodConfig(Method meth)
|
Method[] |
getMethods()
|
Field Detail |
---|
static final String DEFAULT_ENCODING
getEncoding()
,
Constant Field Valuesstatic final String DEFAULT_CONTEXT_PATH
getContextPath()
,
Constant Field Valuesstatic final Class<? extends RequestInterceptor> DEFAULT_GLOBAL_INTERCEPTOR
getGlobalInterceptor()
Method Detail |
---|
String getEncoding()
String getEndPoint()
String getContextPath()
getEndPoint()
concatenated to this value.
RequestInterceptor getGlobalInterceptor()
For a given request, the call order is :
- InterfaceConfig.requestInterceptor.beforeParamsInjectionHandle(...)
- MethodConfig.requestInterceptor.beforeParamsInjectionHandle(...)
- MethodConfig.requestInterceptor.afterParamsInjectionHandle(...)
- InterfaceConfig.requestInterceptor.afterParamsInjectionHandle(...)
Class<?> getInterface()
Method[] getMethods()
MethodConfig getMethodConfig(Method meth)
meth
- Method to retrieve the config for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |