Annotation Interface ImportHttpServices

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Repeatable(ImportHttpServices.Container.class)
@Import(org.springframework.web.service.registry.ImportHttpServiceRegistrar.class)
public @interface ImportHttpServices

Annotation to declare HTTP Service types (interfaces with @HttpExchange methods) for which to create client proxies, and have those proxies registered as beans.

This is a repeatable annotation that is expected on @Configuration classes. Each annotation is associated with an HttpServiceGroup identified by name through the group() attribute.

The HTTP Services for each group can be listed via types(), or detected via basePackageClasses() or basePackages().

An application can autowire HTTP Service proxy beans, or autowire the HttpServiceProxyRegistry from which to obtain proxies.

Since:

7.0

Author:

Olga Maciaszek-Sharma, Rossen Stoyanchev

See Also:

• ImportHttpServices.Container
• AbstractHttpServiceRegistrar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	ImportHttpServices.Container	Container annotation that is necessary for the repeatable @ImportHttpServices annotation, but does not need to be declared in application code.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	basePackageClasses	Detect HTTP Services in the packages of the specified classes, looking for interfaces with type or method HttpExchange annotations.
String[]	basePackages	Variant of basePackageClasses() with a list of packages specified by package name.
HttpServiceGroup.ClientType	clientType	Specify the type of client to use for the group.
String	group	The name of the HTTP Service group.
Class<?>[]	types	A list of HTTP Service types to include in the group.
Class<?>[]	value	An alias for types().

Element Details

value

@AliasFor("types")
Class<?>[] value

An alias for types().

Default:

{}

types

@AliasFor("value")
Class<?>[] types

A list of HTTP Service types to include in the group.

Default:

{}

group

String group

The name of the HTTP Service group.

If not specified, declared HTTP Services are grouped under the HttpServiceGroup.DEFAULT_GROUP_NAME.

Default:

"default"

basePackageClasses

Class<?>[] basePackageClasses

Detect HTTP Services in the packages of the specified classes, looking for interfaces with type or method HttpExchange annotations.

The performed scan, however, filters out interfaces annotated with HttpServiceClient that are instead supported by AbstractClientHttpServiceRegistrar.

Default:

{}

basePackages

String[] basePackages

Variant of basePackageClasses() with a list of packages specified by package name.

Default:

{}

clientType

HttpServiceGroup.ClientType clientType

Specify the type of client to use for the group.

By default, this is HttpServiceGroup.ClientType.UNSPECIFIED in which case RestClient is used, but this default can be changed via AbstractHttpServiceRegistrar.setDefaultClientType(org.springframework.web.service.registry.HttpServiceGroup.ClientType).

Default:

UNSPECIFIED