org.apache.sling.validation.model.spi

Interface ValidationModelProvider

@ProviderType
public interface ValidationModelProvider

All providers of ValidationModels must implement this interface. Caching of validation models should be implemented in the provider itself, because the providers are asked potentially multiple times for each ValidationService.getValidationModel(org.apache.sling.api.resource.Resource, boolean) or ValidationService.getValidationModel(String, String, boolean) call.

Method Summary

Modifier and Type	Method and Description
java.util.List<ValidationModel>	getValidationModels(java.lang.String relativeResourceType) Retrieves the models responsible for validating the given resourceType.

Method Detail

getValidationModels

@Nonnull
java.util.List<ValidationModel> getValidationModels(@Nonnull
                                                             java.lang.String relativeResourceType)
                                                      throws java.lang.IllegalStateException

Retrieves the models responsible for validating the given resourceType.

Parameters:

relativeResourceType - the relative resource (relative to one of the resource resolver's search paths)

Returns:

a List of ValidationModels. Never null, but might be empty collection in case no model for the given resource type could be found. The order which model gets active is mostly determined by ValidationModel.getApplicablePaths() (longest path match wins) but in case there are multiple models having the same applicable path, the order being returned here is considered (i.e. the first one is taken).

Throws:

java.lang.IllegalStateException - in case a validation model was found but it is invalid