org.apache.juneau.rest.jaxrs

Annotation Type JuneauProvider

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
public @interface JuneauProvider

Annotations applicable to subclasses of BaseProvider.

Description

Used to associate serializers, parsers, filters, and properties with instances of BaseProvider.

See Also:

• Overview > juneau-rest-server-jaxrs

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	beanFilters Provider-level bean filters.
String[]	flags Shortcut for setting properties() of boolean types.
Class<? extends Parser>[]	parsers Specifies a list of Parser classes to add to the list of parsers available for this provider.
Class<?>[]	pojoSwaps Provider-level POJO swaps.
Property[]	properties Provider-level properties.
Class<? extends Serializer>[]	serializers Specifies a list of Serializer classes to add to the list of serializers available for this provider.

Element Detail

beanFilters

public abstract Class<?>[] beanFilters

Provider-level bean filters.

These filters are applied to all serializers and parsers being used by the provider.

If the specified class is an instance of BeanFilterBuilder, then a filter built from that builder is added. Any other classes are wrapped in a InterfaceBeanFilterBuilder to indicate that subclasses should be treated as the specified class type.

Default:

{}

pojoSwaps

public abstract Class<?>[] pojoSwaps

Provider-level POJO swaps.

These POJO swaps are applied to all serializers and parsers being used by the provider.

If the specified class is an instance of PojoSwap, then that swap is added. Any other classes are wrapped in a SurrogateSwap.

Default:

{}

properties

public abstract Property[] properties

Provider-level properties.

Any of the following property names can be specified:

• RestContext
• BeanContext
• Serializer
• Parser
• JsonSerializer
• XmlSerializer
• XmlParser

Property values will be converted to the appropriate type.

These properties can be augmented/overridden through the @RestMethod.properties() annotation on the REST method.

Default:

{}

flags

public abstract String[] flags

Shortcut for setting properties() of boolean types.

Setting a flag is the equivalent to setting the same property to "true".

Default:

{}

serializers

public abstract Class<? extends Serializer>[] serializers

Specifies a list of Serializer classes to add to the list of serializers available for this provider.

This annotation can only be used on Serializer classes that have no-arg constructors.

Default:

{}

parsers

public abstract Class<? extends Parser>[] parsers

Specifies a list of Parser classes to add to the list of parsers available for this provider.

This annotation can only be used on Parser classes that have no-arg constructors.

Default:

{}