Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractRepositoryEventListener<T> - Class in org.springframework.data.rest.core.event
-
Abstract class that listens for generic
RepositoryEvent
s and dispatches them to a specific method based on the event type. - AbstractRepositoryEventListener() - Constructor for class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
- addProjection(Class<?>) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Adds the given projection type to the configuration.
- addProjection(Class<?>, Class<?>...) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Adds a projection type for the given source types.
- addProjection(Class<?>, String, Class<?>...) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Adds the given projection type for the given source types under the given name.
- addResourceHandlers(ResourceHandlerRegistry) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- addResourceMappingFor(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- addResourceMappings(Map<String, ResourceMapping>) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- addTo(HttpHeaders) - Method in class org.springframework.data.rest.webmvc.support.ETag
-
Adds the current
ETag
to the given headers. - addToCache(Class<?>, ResourceMetadata) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
-
Adds the given
ResourceMetadata
to the cache. - addValidator(String, Validator) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
-
Add a
Validator
that will be triggered on the given event. - AfterCreateEvent - Class in org.springframework.data.rest.core.event
-
Event that is emitted after a new entity is saved.
- AfterCreateEvent(Object) - Constructor for class org.springframework.data.rest.core.event.AfterCreateEvent
- AfterDeleteEvent - Class in org.springframework.data.rest.core.event
-
Emitted after the entity is deleted from the repository.
- AfterDeleteEvent(Object) - Constructor for class org.springframework.data.rest.core.event.AfterDeleteEvent
- AfterLinkDeleteEvent - Class in org.springframework.data.rest.core.event
-
Emitted after a link to a related object is deleted from the parent.
- AfterLinkDeleteEvent(Object, Object) - Constructor for class org.springframework.data.rest.core.event.AfterLinkDeleteEvent
- AfterLinkSaveEvent - Class in org.springframework.data.rest.core.event
-
Emitted after saving a linked object to its parent in the repository.
- AfterLinkSaveEvent(Object, Object) - Constructor for class org.springframework.data.rest.core.event.AfterLinkSaveEvent
- afterPropertiesSet() - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerAdapter
- AfterSaveEvent - Class in org.springframework.data.rest.core.event
-
Emitted after a save to the repository.
- AfterSaveEvent(Object) - Constructor for class org.springframework.data.rest.core.event.AfterSaveEvent
- AggregateReferenceResolvingModule - Class in org.springframework.data.rest.webmvc.json
-
Jackson module to enable aggregate reference resolution for non-aggregate root types.
- AggregateReferenceResolvingModule(UriToEntityConverter, ResourceMappings) - Constructor for class org.springframework.data.rest.webmvc.json.AggregateReferenceResolvingModule
-
Creates a new
AggregateReferenceResolvingModule
using the givenUriToEntityConverter
andResourceMappings
. - ALL - Enum constant in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Considers all repositories.
- ALL - Static variable in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
- allowsPutForCreation() - Method in interface org.springframework.data.rest.core.mapping.SupportedHttpMethods
-
Returns whether
HttpMethod.PUT
requests are supported for item resource creation. - allowsPutForCreation() - Method in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
- allowsPutForCreation(Class<?>) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
-
Returns whether PUT requests can be used to create new instances of the given domain type.
- allowsPutForCreation(ResourceMetadata) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
-
Returns whether PUT requests can be used to create new instances for the type backing the given
ResourceMetadata
. - AlpsController - Class in org.springframework.data.rest.webmvc.alps
-
Controller exposing semantic documentation for the resources exposed using the Application Level Profile Semantics format.
- AlpsController(RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.webmvc.alps.AlpsController
-
Creates a new
AlpsController
for the givenResourceMappings
. - alpsConverter(Repositories, PersistentEntities, RepositoryEntityLinks, EnumTranslator, Associations, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- alpsEnabled() - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Returns whether the ALPS resources are exposed.
- alpsJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- AlpsJsonHttpMessageConverter - Class in org.springframework.data.rest.webmvc.alps
- AlpsJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter) - Constructor for class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
-
Creates a new
AlpsJsonHttpMessageConverter
for the givenConverter
. - and(HttpMethod...) - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
-
Returns a new
HttpMethods
with the givenHttpMethod
s added. - andThen(ComposableFilter<PropertyAwareResourceMapping, ConfigurableHttpMethods>) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AssociationResourceHttpMethodsFilter
- ANNOTATED - Enum constant in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Considers repositories that are annotated with
RepositoryRestResource
orRestResource
and don't have theexported
flag not set to false. - annotatedEventHandlerInvoker() - Static method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- AnnotatedEventHandlerInvoker - Class in org.springframework.data.rest.core.event
-
Component to discover annotated repository event handlers and trigger them on
ApplicationEvent
s. - AnnotatedEventHandlerInvoker() - Constructor for class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
- AnnotationBasedResourceDescription - Class in org.springframework.data.rest.core.mapping
-
A
ResourceDescription
that is customized based on aDescription
annotation. - AnnotationBasedResourceDescription(Class<?>, ResourceDescription) - Constructor for class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
- AnnotationBasedResourceDescription(Description, ResourceDescription) - Constructor for class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
-
Creates a new
AnnotationBasedResourceDescription
for the givenDescription
and fallback. - appendPath(Path) - Method in class org.springframework.data.rest.webmvc.BaseUri
- apply(List<T>, Class<T>) - Method in class org.springframework.data.rest.webmvc.json.patch.Patch
-
Applies the Patch to a given List of objects.
- apply(T, Class<T>) - Method in class org.springframework.data.rest.webmvc.json.patch.Patch
-
Applies the Patch to a given Object graph.
- asAssociation() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Turns the current
JsonSchema.JsonSchemaProperty
into an association. - associationLinks(RepositoryResourceMappings, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- Associations - Class in org.springframework.data.rest.webmvc.mapping
-
A value object to for
Link
s representing associations. - Associations(ResourceMappings, RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.webmvc.mapping.Associations
- AssociationUriResolvingDeserializerModifier(PersistentEntities, Associations, UriToEntityConverter, RepositoryInvokerFactory) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.AssociationUriResolvingDeserializerModifier
- asText(Enum<?>) - Method in class org.springframework.data.rest.webmvc.json.EnumTranslator
-
Resolves the given enum value into a
String
consulting the configuredMessageSourceAccessor
potentially falling back to the default translation if configured. - auditableBeanWrapperFactory(PersistentEntities) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
B
- BackendId - Annotation Interface in org.springframework.data.rest.webmvc.support
-
Annotation to bind the backend id of an entity.
- BackendIdConverter - Interface in org.springframework.data.rest.webmvc.spi
-
SPI to allow the customization of how entity ids are exposed in URIs generated.
- BackendIdConverter.DefaultIdConverter - Enum Class in org.springframework.data.rest.webmvc.spi
-
The default
BackendIdConverter
that will simply use ids as they are. - backendIdConverterRegistry(List<BackendIdConverter>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- backendIdHandlerMethodArgumentResolver(PluginRegistry<BackendIdConverter, Class<?>>, ResourceMetadataHandlerMethodArgumentResolver, BaseUri) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- BackendIdHandlerMethodArgumentResolver - Class in org.springframework.data.rest.webmvc.support
-
HandlerMethodArgumentResolver
to resolve entity ids for injection int handler method arguments annotated withBackendId
. - BackendIdHandlerMethodArgumentResolver(PluginRegistry<BackendIdConverter, Class<?>>, ResourceMetadataHandlerMethodArgumentResolver, BaseUri) - Constructor for class org.springframework.data.rest.webmvc.support.BackendIdHandlerMethodArgumentResolver
-
Creates a new
BackendIdHandlerMethodArgumentResolver
for the givenBackendIdConverter
s andResourceMetadataHandlerMethodArgumentResolver
. - BasePathAwareController - Annotation Interface in org.springframework.data.rest.webmvc
-
Annotation to declare a controller that declares request mappings to be augmented with a base URI in the Spring Data REST configuration.
- BasePathAwareHandlerMapping - Class in org.springframework.data.rest.webmvc
-
A
RequestMappingHandlerMapping
that augments the request mappings - BasePathAwareHandlerMapping(RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
-
Creates a new
BasePathAwareHandlerMapping
using the givenRepositoryRestConfiguration
. - baseUri(RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- BaseUri - Class in org.springframework.data.rest.webmvc
-
Value object to be able to extract the lookup path within a configured base URI that forms a URI namespace.
- BaseUri(String) - Constructor for class org.springframework.data.rest.webmvc.BaseUri
-
Creates a new
BaseUri
with the given URI as base. - BaseUri(URI) - Constructor for class org.springframework.data.rest.webmvc.BaseUri
-
Creates a new
BaseUri
with the given URI as base. - basicObjectMapper() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- beforeBodyWrite(Object, MethodParameter, MediaType, Class<? extends HttpMessageConverter<?>>, ServerHttpRequest, ServerHttpResponse) - Method in class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
- BeforeCreateEvent - Class in org.springframework.data.rest.core.event
-
Event emitted before an entity is saved for the first time.
- BeforeCreateEvent(Object) - Constructor for class org.springframework.data.rest.core.event.BeforeCreateEvent
- BeforeDeleteEvent - Class in org.springframework.data.rest.core.event
-
Emitted before an entity is deleted from the repository.
- BeforeDeleteEvent(Object) - Constructor for class org.springframework.data.rest.core.event.BeforeDeleteEvent
- BeforeLinkDeleteEvent - Class in org.springframework.data.rest.core.event
-
Emitted before a link to a related object is deleted from the parent.
- BeforeLinkDeleteEvent(Object, Object) - Constructor for class org.springframework.data.rest.core.event.BeforeLinkDeleteEvent
- BeforeLinkSaveEvent - Class in org.springframework.data.rest.core.event
-
Emitted before a linked object is saved to the repository.
- BeforeLinkSaveEvent(Object, Object) - Constructor for class org.springframework.data.rest.core.event.BeforeLinkSaveEvent
- BeforeSaveEvent - Class in org.springframework.data.rest.core.event
-
Emitted before an entity is saved into the repository.
- BeforeSaveEvent(Object) - Constructor for class org.springframework.data.rest.core.event.BeforeSaveEvent
- BindContext - Interface in org.springframework.data.rest.webmvc.json.patch
-
Contextual mapping for he translation of JSON Pointer segments into property references on persistent types.
- BindContextFactory - Interface in org.springframework.data.rest.webmvc.json
-
Factory to create
BindContext
instances. - build() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
-
Finally creates the
PersistentEntityResource
instance. - build(Object, PersistentEntity<?, ?>) - Static method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Creates a new
PersistentEntityResource.Builder
to createPersistentEntityResource
s eventually. - buildNested() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
- butWithout(HttpMethod...) - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
-
Returns a new
HttpMethods
instance with the givenHttpMethod
s removed.
C
- canRead(Class<?>, MediaType) - Method in class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
- canRead(Type, Class<?>, MediaType) - Method in class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
- canWrite(Class<?>, MediaType) - Method in class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
- canWrite(Type, Class<?>, MediaType) - Method in class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
- COLLECTION - Enum constant in enum class org.springframework.data.rest.core.mapping.ResourceType
- collectionResourceDescription() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
The description of the collection resource.
- CollectionResourceMapping - Interface in org.springframework.data.rest.core.mapping
-
A custom resource mapping for collection resources.
- collectionResourceRel() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
The rel value to use when generating links to the collection resource.
- ConfigurableHttpMethods - Class in org.springframework.data.rest.core.mapping
-
HttpMethods
that expose methods to create differentConfigurableHttpMethods
. - configureConversionService(ConfigurableConversionService) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Override this method to add your own converters.
- configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Configure the
ExceptionHandlerExceptionResolver
. - configureHttpMessageConverters(List<HttpMessageConverter<?>>) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Configure the available
HttpMessageConverter
s by adding your own. - configureJacksonObjectMapper(ObjectMapper) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Configure the Jackson
ObjectMapper
directly. - configureObjectMapper(ObjectMapper) - Static method in class org.springframework.data.rest.webmvc.json.Jackson2DatatypeHelper
- configureRepositoryRestConfiguration(RepositoryRestConfiguration, CorsRegistry) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Override this method to add additional configuration.
- configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Override this method to add validators manually.
- ConstraintViolationExceptionMessage - Class in org.springframework.data.rest.webmvc.support
- ConstraintViolationExceptionMessage(ConstraintViolationException, MessageSource, Locale) - Constructor for class org.springframework.data.rest.webmvc.support.ConstraintViolationExceptionMessage
- ConstraintViolationMessage - Class in org.springframework.data.rest.webmvc.support
-
A helper class to encapsulate
ConstraintViolation
errors. - ConstraintViolationMessage(ConstraintViolation<?>, MessageSource, Locale) - Constructor for class org.springframework.data.rest.webmvc.support.ConstraintViolationMessage
- contains(HttpMethod) - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
- contains(HttpMethod) - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
-
Returns whether the given
HttpMethod
is contained in the currentHttpMethods
. - ControllerUtils - Class in org.springframework.data.rest.webmvc
- ControllerUtils() - Constructor for class org.springframework.data.rest.webmvc.ControllerUtils
- convert(JsonNode) - Method in class org.springframework.data.rest.webmvc.json.patch.JsonPatchPatchConverter
-
Constructs a
Patch
object given a JsonNode. - convert(Class<?>) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter
-
Converts the given type into a
JsonSchema
instance. - convert(Object, TypeDescriptor, TypeDescriptor) - Method in class org.springframework.data.rest.core.UriToEntityConverter
- convert(Object, TypeDescriptor, TypeDescriptor) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter
- convert(String) - Method in enum class org.springframework.data.rest.core.StringToLdapNameConverter
- convert(RootResourceInformation) - Method in class org.springframework.data.rest.webmvc.alps.RootResourceInformationToAlpsDescriptorConverter
- convert(T) - Method in interface org.springframework.data.rest.webmvc.json.patch.PatchConverter
-
Convert a patch document representation to a
Patch
. - CorsConfigurationAware - Interface in org.springframework.data.rest.webmvc.config
-
Components that are aware of CORS configuration.
- createContextual(DeserializationContext, BeanProperty) - Method in class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingDeserializer
- createNewInstance(UriComponents, List<Affordance>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- createSelfLinkFor(Class<?>, Object) - Method in class org.springframework.data.rest.core.support.DefaultSelfLinkProvider
- createSelfLinkFor(Class<?>, Object) - Method in interface org.springframework.data.rest.core.support.SelfLinkProvider
-
Returns the self link for the entity of the given type and the given reference.
- createSelfLinkFor(Object) - Method in class org.springframework.data.rest.core.support.DefaultSelfLinkProvider
- createSelfLinkFor(Object) - Method in interface org.springframework.data.rest.core.support.SelfLinkProvider
-
Returns the self link for the given entity instance.
- CrudMethodsSupportedHttpMethods - Class in org.springframework.data.rest.core.mapping
-
SupportedHttpMethods
that are determined by aCrudMethods
instance. - CrudMethodsSupportedHttpMethods(CrudMethods, boolean) - Constructor for class org.springframework.data.rest.core.mapping.CrudMethodsSupportedHttpMethods
-
Creates a new
CrudMethodsSupportedHttpMethods
for the givenCrudMethods
. - customize(JsonSchema.JsonSchemaProperty, TypeInformation<?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingSerializer
- customize(JsonSchema.JsonSchemaProperty, TypeInformation<?>) - Method in interface org.springframework.data.rest.webmvc.json.JsonSchemaPropertyCustomizer
-
Returns the customized
JsonSchema.JsonSchemaProperty
based on the given one and the given type. - customize(ProducesRequestCondition) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
-
Customize the given
ProducesRequestCondition
. - customize(ProducesRequestCondition) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- customizeAuditableBeanWrapperFactory(AuditableBeanWrapperFactory) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Customize the
AuditableBeanWrapperFactory
to be used. - customizeLinkCollector(LinkCollector) - Method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Customize the
LinkCollector
to be used. - customizeResources(ResourceHandlerRegistry, RepositoryRestConfiguration) - Method in interface org.springframework.data.rest.webmvc.config.StaticResourceProvider
-
Customize the given
ResourceHandlerRegistry
.
D
- DATE_TIME - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- DEFAULT - Enum constant in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Exposes public interfaces or ones explicitly annotated with
RepositoryRestResource
. - DEFAULT_ALLOWED_METHODS - Static variable in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- DEFAULT_KEY_PREFIX - Static variable in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- DEFAULT_MEDIA_TYPE - Static variable in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- defaultConversionService(PersistentEntities, RepositoryInvokerFactory, Repositories) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- DefaultedPageable - Class in org.springframework.data.rest.webmvc.support
-
Value object to capture a
Pageable
as well whether it is the default one configured. - DefaultedPageable(Pageable, boolean) - Constructor for class org.springframework.data.rest.webmvc.support.DefaultedPageable
- DefaultedPageableHandlerMethodArgumentResolver - Class in org.springframework.data.rest.webmvc.support
-
HandlerMethodArgumentResolver
to resolveDefaultedPageable
if requested. - DefaultedPageableHandlerMethodArgumentResolver(PageableHandlerMethodArgumentResolver) - Constructor for class org.springframework.data.rest.webmvc.support.DefaultedPageableHandlerMethodArgumentResolver
-
Creates a new
DefaultedPageableHandlerMethodArgumentResolver
delegating to the givenPageableHandlerMethodArgumentResolver
. - DefaultExcerptProjector - Class in org.springframework.data.rest.webmvc.support
-
DefaultedPageable
implementation ofExcerptProjector
that uses the givenProjectionFactory
and considers the givenResourceMappings
. - DefaultExcerptProjector(ProjectionFactory, ResourceMappings) - Constructor for class org.springframework.data.rest.webmvc.support.DefaultExcerptProjector
- defaultFor(LinkRelation) - Static method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- defaultFor(LinkRelation, Class<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
- defaultFor(LinkRelation, String, Class<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
- defaultFor(LinkRelation, PersistentProperty<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
- DefaultLinkCollector - Class in org.springframework.data.rest.webmvc.mapping
-
A service to collect all standard links that need to be added to a certain object.
- DefaultLinkCollector(PersistentEntities, SelfLinkProvider, Associations) - Constructor for class org.springframework.data.rest.webmvc.mapping.DefaultLinkCollector
-
Creates a new
DefaultLinkCollector
for the givenPersistentEntities
,SelfLinkProvider
andAssociations
. - defaultMessageConverters(TypeConstrainedMappingJackson2HttpMessageConverter, TypeConstrainedMappingJackson2HttpMessageConverter, TypeConstrainedMappingJackson2HttpMessageConverter, AlpsJsonHttpMessageConverter, UriListHttpMessageConverter, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- defaultMethodArgumentResolvers(SelfLinkProvider, PersistentEntityResourceHandlerMethodArgumentResolver, RootResourceInformationHandlerMethodArgumentResolver) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- DefaultSelfLinkProvider - Class in org.springframework.data.rest.core.support
-
Default implementation of SelfLinkProvider that uses an
EntityLinks
instance to create self links. - DefaultSelfLinkProvider(PersistentEntities, EntityLinks, List<? extends EntityLookup<?>>, ConversionService) - Constructor for class org.springframework.data.rest.core.support.DefaultSelfLinkProvider
- Definitions() - Constructor for class org.springframework.data.rest.webmvc.json.JsonSchema.Definitions
- description - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- description() - Element in annotation interface org.springframework.data.rest.core.annotation.RestResource
-
The description of the collection resource.
- Description - Annotation Interface in org.springframework.data.rest.core.annotation
-
Annotation to describe semantics of a resource.
- deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingDeserializer
- deserialize(JsonParser, DeserializationContext) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.UriStringDeserializer
- deserializeWithType(JsonParser, DeserializationContext, TypeDeserializer) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.UriStringDeserializer
-
Deserialize by ignoring the
TypeDeserializer
, as URIs will either resolve to null or a concrete instance anyway. - disable(HttpMethod...) - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
-
Disables the given
HttpMethod
s. - disableDefaultExposure() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Disables the default exposure of repositories entirely.
- disablePatchOnItemResources() - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
-
Disables the support for
HttpMethod.PATCH
for item resources. - disablePutForCreation() - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
- disablePutForCreation() - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer
-
Disables the ability to create new item resources via
HttpMethod.PUT
. - disablePutOnItemResources() - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
-
Disables the support for
HttpMethod.PUT
for item resources. - DomainClassResolver - Class in org.springframework.data.rest.webmvc.support
-
Resolves a domain class from a web request.
- DomainObjectReader - Class in org.springframework.data.rest.webmvc.json
-
Component to apply an
ObjectNode
to an existing domain object. - DomainObjectReader(PersistentEntities, Associations) - Constructor for class org.springframework.data.rest.webmvc.json.DomainObjectReader
E
- EMAIL - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- EmbeddedResourcesAssembler - Class in org.springframework.data.rest.webmvc
- EmbeddedResourcesAssembler(PersistentEntities, Associations, ExcerptProjector) - Constructor for class org.springframework.data.rest.webmvc.EmbeddedResourcesAssembler
- enable(HttpMethod...) - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
-
Enables the given
HttpMethod
s. - entitiesToResources(Iterable<Object>, PersistentEntityResourceAssembler, Class<?>) - Method in class org.springframework.data.rest.webmvc.RepositoryController
- entitiesToResources(Page<Object>, PersistentEntityResourceAssembler, Class<?>, Optional<Link>) - Method in class org.springframework.data.rest.webmvc.RepositoryController
- entityLinks(ObjectFactory<HateoasPageableHandlerMethodArgumentResolver>, Repositories, RepositoryResourceMappings, PluginRegistry<BackendIdConverter, Class<?>>, RepositoryRestConfiguration, ObjectFactory<HateoasSortHandlerMethodArgumentResolver>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
A special
EntityLinks
implementation that takes repository and current configuration into account when generating links. - EntityLookup<T> - Interface in org.springframework.data.rest.core.support
-
SPI to customize which property of an entity is used as unique identifier and how the entity instance is looked up from the backend.
- EntityLookupRegistrar - Interface in org.springframework.data.rest.core.config
-
Configuration interfaces to ease the configuration of custom
EntityLookup
s for repositories. - EntityLookupRegistrar.IdMappingRegistrar<T,
R extends Repository<T, ?>> - Interface in org.springframework.data.rest.core.config - EntityLookupRegistrar.LookupRegistrar<T,
ID, R extends Repository<T, ?>> - Interface in org.springframework.data.rest.core.config - EntityLookupRegistrar.LookupRegistrar.Lookup<R extends Repository<? extends Object,
?>, ID> - Interface in org.springframework.data.rest.core.config - EntityLookupSupport<T> - Class in org.springframework.data.rest.core.support
-
EntityLookup
implementation base class to derive the supported domain type from the generics signature. - EntityLookupSupport() - Constructor for class org.springframework.data.rest.core.support.EntityLookupSupport
-
Creates a new
EntityLookupSupport
instance discovering the supported type from the generics signature. - EnumProperty(String, String, Class<?>, String, boolean) - Constructor for class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- EnumProperty(String, String, List<String>, String, boolean) - Constructor for class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- EnumTranslatingDeserializer(EnumTranslator) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingDeserializer
-
Creates a new
JacksonSerializers.EnumTranslatingDeserializer
using the givenEnumTranslator
. - EnumTranslatingDeserializer(EnumTranslator, BeanProperty) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingDeserializer
-
Creates a new
JacksonSerializers.EnumTranslatingDeserializer
using the givenEnumTranslator
andBeanProperty
. - EnumTranslatingSerializer(EnumTranslator) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingSerializer
-
Creates a new
JacksonSerializers.EnumTranslatingSerializer
using the givenEnumTranslator
. - EnumTranslationConfiguration - Interface in org.springframework.data.rest.core.config
-
Configuration options for enum value translation.
- enumTranslator(MessageResolver) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- EnumTranslator - Class in org.springframework.data.rest.webmvc.json
-
Configuration to tweak enum serialization.
- EnumTranslator(MessageResolver) - Constructor for class org.springframework.data.rest.webmvc.json.EnumTranslator
-
Creates a new
EnumTranslator
using the givenMessageSourceAccessor
. - equals(Object) - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
- equals(Object) - Method in class org.springframework.data.rest.core.Path
- equals(Object) - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
- equals(Object) - Method in class org.springframework.data.rest.webmvc.support.ETag
- equals(Object) - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- ETag - Class in org.springframework.data.rest.webmvc.support
-
A value object to represent ETags.
- eTagArgumentResolver() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ETagArgumentResolver - Class in org.springframework.data.rest.webmvc.support
-
HandlerMethodArgumentResolver
to resolve If-Match headers for optimistic locking handlingETag
. - ETagArgumentResolver() - Constructor for class org.springframework.data.rest.webmvc.support.ETagArgumentResolver
- ETagDoesntMatchException - Exception in org.springframework.data.rest.webmvc.support
-
An exception being thrown in case the
ETag
calculated for a particular object does not match an expected one. - ETagDoesntMatchException(Object, ETag) - Constructor for exception org.springframework.data.rest.webmvc.support.ETagDoesntMatchException
-
Creates a new
ETagDoesntMatchException
for the given bean as well as theETag
it was expected to match. - evaluate(Class<?>) - Method in class org.springframework.data.rest.webmvc.json.patch.PatchOperation
- evaluateValueFromTarget(Object, Class<?>, BindContext) - Method in class org.springframework.data.rest.webmvc.json.patch.PatchOperation
-
Performs late-value evaluation on the operation value if the value is a
LateObjectEvaluator
. - ExceptionEvent - Class in org.springframework.data.rest.core.event
-
An event to encapsulate an exception occurring anywhere within the REST exporter.
- ExceptionEvent(Throwable) - Constructor for class org.springframework.data.rest.core.event.ExceptionEvent
- ExceptionMessage - Class in org.springframework.data.rest.webmvc.support
-
A helper that renders an
Exception
JSON-friendly. - ExceptionMessage(Throwable) - Constructor for class org.springframework.data.rest.webmvc.support.ExceptionMessage
- excerptProjection() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
Configures the projection type to be used when embedding item resources into collections and related resources.
- excerptProjector(RepositoryResourceMappings) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ExcerptProjector - Interface in org.springframework.data.rest.webmvc.support
-
Interface for a component that can provide excerpt projections.
- exported() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
Flag indicating whether this resource is exported at all.
- exported() - Element in annotation interface org.springframework.data.rest.core.annotation.RestResource
-
Flag indicating whether this resource is exported at all.
- exportsMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- exportsMappingFor(Class<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMappings
-
Returns whether we have a
ResourceMapping
for the given type and it is exported. - exportsTopLevelResourceFor(String) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- exportsTopLevelResourceFor(String) - Method in interface org.springframework.data.rest.core.mapping.ResourceMappings
-
Returns whether we export a top-level resource for the given path.
- exposeIdsFor(Class<?>...) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the list of domain types for which we will expose the ID value as a normal property.
- exposeRepositoryMethodsByDefault() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns whether to expose repository methods by default.
- ExposureConfiguration - Class in org.springframework.data.rest.core.mapping
-
Configuration type to register filters customizing the HTTP methods supported.
- ExposureConfiguration() - Constructor for class org.springframework.data.rest.core.mapping.ExposureConfiguration
- ExposureConfigurer - Interface in org.springframework.data.rest.core.mapping
-
Configuration API to register filters to customize the supported HTTP methods by different kinds of resources.
- ExposureConfigurer.AggregateResourceHttpMethodsFilter - Interface in org.springframework.data.rest.core.mapping
-
A filter to post-process the supported HTTP methods by aggregate resources (collection or item resource).
- ExposureConfigurer.AssociationResourceHttpMethodsFilter - Interface in org.springframework.data.rest.core.mapping
-
A filter to post-process the supported HTTP methods by
Association
resources. - extendHandlerExceptionResolvers(List<HandlerExceptionResolver>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- extendInterceptors(List<Object>) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
F
- filter(PropertyAwareResourceMapping, ConfigurableHttpMethods) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AssociationResourceHttpMethodsFilter
- filter(ResourceMetadata, ConfigurableHttpMethods) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AggregateResourceHttpMethodsFilter
- findExported(Class<?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findExported(Method) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findMappingVariable(String, Method, String) - Static method in class org.springframework.data.rest.webmvc.util.UriUtils
-
Returns the value for the mapping variable with the given name.
- findPath(Class<?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findPath(Method) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findRel(Class<?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findRel(Method) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- findRepositoryMappingForPath(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- findTypeForPath(String) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
- forCreation() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
-
Finally creates the
PersistentEntityResource
instance to symbolize the contained entity is about to be created. - forDomainType(Class<?>) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
-
Returns a
ExposureConfigurer
to allow the registration of type specificExposureConfigurer.AggregateResourceHttpMethodsFilter
andExposureConfigurer.AssociationResourceHttpMethodsFilter
s which means the configured filters will only be invoked for aggregates of the given type and properties owned by that type respectively. - forLookupRepository(Class<R>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar
-
Starts building a custom
EntityLookup
for the given repository type and registers the domain type of the given repository as lookup type. - format - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- formatRel(RepositoryRestConfiguration, RepositoryInformation, PersistentProperty<?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- forRepository(Class<R>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar
-
Starts building a custom
EntityLookup
for the given repository type. - forRepository(Class<R>, Converter<T, ID>, EntityLookupRegistrar.LookupRegistrar.Lookup<R, ID>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar
-
Registers an
EntityLookup
for the given repository type, identifier mapping and lookup operation. - forValueRepository(Class<R>, Converter<T, ID>, EntityLookupRegistrar.LookupRegistrar.Lookup<R, ID>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar
-
Registers an
EntityLookup
for the given repository type, identifier mapping and lookup operation and registers the domain type managed by the given repository as lookup type. - from(String) - Static method in class org.springframework.data.rest.webmvc.support.ETag
- from(Optional<String>) - Static method in class org.springframework.data.rest.webmvc.support.ETag
- from(PersistentEntity<?, ? extends PersistentProperty<?>>, Object) - Static method in class org.springframework.data.rest.webmvc.support.ETag
-
Creates a new
ETag
from the givenPersistentEntity
and target bean. - from(PersistentEntityResource) - Static method in class org.springframework.data.rest.webmvc.support.ETag
-
Creates a new
ETag
for the givenPersistentEntityResource
. - fromRequestId(String, Class<?>) - Method in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
- fromRequestId(String, Class<?>) - Method in interface org.springframework.data.rest.webmvc.spi.BackendIdConverter
-
Returns the id of the entity to be looked up eventually.
- fromText(Class<T>, String) - Method in class org.springframework.data.rest.webmvc.json.EnumTranslator
-
Parses the given source text into the corresponding enum value using the configured
MessageSourceAccessor
potentially falling back to the default translation or the plain enum name if configured.
G
- getArguments() - Method in class org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport
- getArguments() - Method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
- getBasePath() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
The base path to expose repository resources under.
- getBaseUri() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.use
RepositoryRestConfiguration.getBasePath()
instead. - getBean() - Method in exception org.springframework.data.rest.webmvc.support.ETagDoesntMatchException
-
Returns the bean not matching the
ETag
. - getBindContextFor(ObjectMapper) - Method in interface org.springframework.data.rest.webmvc.json.BindContextFactory
-
Creates a
BindContext
for the givenObjectMapper
. - getBindContextFor(ObjectMapper) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntitiesBindContextFactory
- getBody() - Method in class org.springframework.data.rest.webmvc.IncomingRequest
-
Returns the body of the request.
- getBody() - Method in class org.springframework.data.rest.webmvc.util.InputStreamHttpInputMessage
- getCause() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationExceptionMessage
- getCause() - Method in class org.springframework.data.rest.webmvc.support.ExceptionMessage
- getCodes() - Method in class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
- getCodes() - Method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.data.rest.core.support.RepositoryRelProvider
- getCollectionResourceRelFor(Class<?>) - Method in class org.springframework.data.rest.core.support.SimpleRelProvider
- getContainer() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getConvertibleTypes() - Method in class org.springframework.data.rest.core.UriToEntityConverter
- getConvertibleTypes() - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter
- getCorsConfiguration(Object, HttpServletRequest) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- getCorsConfigurations() - Method in interface org.springframework.data.rest.webmvc.config.CorsConfigurationAware
-
Return the registered
CorsConfiguration
objects, keyed by path pattern. - getCustomizerFor(Class<?>) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory
- getDefaultMediaType() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the
MediaType
to use as a default when none is specified. - getDefaultMessage() - Method in class org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport
- getDefaultMessage() - Method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
- getDefaultPageSize() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the default size of
Pageable
s. - getDefaultSelfLink() - Method in class org.springframework.data.rest.webmvc.RepositoryController
- getDefinitionFor(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Returns the
BeanPropertyDefinition
for the givenPersistentProperty
. - getDefinitions() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.Definitions
- getDefinitions() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getDescription() - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
-
Returns the description for the method parameter.
- getDescription() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
-
Returns the resource's description.
- getDescription() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- getDescription() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getDomainType() - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns the domain type that is exposed through the resource.
- getDomainType() - Method in class org.springframework.data.rest.webmvc.RepositorySearchesResource
-
Returns the domain type for which the resource lists searches.
- getDomainType() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getDomainTypesResourceMappingConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- getEmbeddedResources(Object) - Method in class org.springframework.data.rest.webmvc.EmbeddedResourcesAssembler
-
Returns the embedded resources to render.
- getEmbeddeds() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Returns the resources that are supposed to be rendered in the
_embedded
clause. - getEntity() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationMessage
- getEntity() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- getEntityLookups() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- getEntityLookups(Repositories) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns all
EntityLookup
s considering the customizations made to the configuration. - getEnumTranslationConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
EnumTranslationConfiguration
to be used. - getErrors() - Method in exception org.springframework.data.rest.core.RepositoryConstraintViolationException
- getErrors() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage
- getException() - Method in class org.springframework.data.rest.core.event.ExceptionEvent
-
Get the source of this exception event.
- getExcerptProjection() - Method in interface org.springframework.data.rest.core.mapping.CollectionResourceMapping
-
Returns the projection type to be used when embedding item resources into collections and related resources.
- getExpectedETag() - Method in exception org.springframework.data.rest.webmvc.support.ETagDoesntMatchException
-
Returns the
ETag
the bean was expected to match. - getExportedMappings() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
-
Returns the mappings for all exported query methods.
- getExportedMethodMappingForPath(String) - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
-
Returns the
MethodResourceMapping
for the given path. - getExportedMethodMappingForRel(LinkRelation) - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
-
Returns the
MappingResourceMetadata
for the given relation name. - getExposureConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
- getFallbackDescription(ResourceMetadata, BeanPropertyDefinition) - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Returns the fallback
ResourceDescription
to be used for the givenBeanPropertyDefinition
. - getHeaders() - Method in class org.springframework.data.rest.webmvc.util.InputStreamHttpInputMessage
- getInterceptors() - Method in class org.springframework.data.rest.webmvc.support.JpaHelper
- getInvalidValue() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationMessage
- getInvalidValue() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- getInvoker() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getInvokerFor(Class<?>) - Method in class org.springframework.data.rest.core.support.UnwrappingRepositoryInvokerFactory
- getItemResourceDescription() - Method in interface org.springframework.data.rest.core.mapping.CollectionResourceMapping
-
Returns the
ResourceDescription
for the item resource. - getItemResourceRel() - Method in interface org.springframework.data.rest.core.mapping.CollectionResourceMapping
-
Returns the relation type pointing to the item resource within a collection.
- getItemResourceRelFor(Class<?>) - Method in class org.springframework.data.rest.core.support.RepositoryRelProvider
- getItemResourceRelFor(Class<?>) - Method in class org.springframework.data.rest.core.support.SimpleRelProvider
- getLimitParamName() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the name of the URL query string parameter that indicates how many results to return at once.
- getLinked() - Method in class org.springframework.data.rest.core.event.LinkedEntityEvent
-
Get the linked object.
- getLinkRelationProvider() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
LinkRelationProvider
configured to calculate the link relation defaults for repositories. - getLinksFor(Object) - Method in class org.springframework.data.rest.webmvc.mapping.DefaultLinkCollector
-
Returns all
Links
for the given object. - getLinksFor(Object) - Method in interface org.springframework.data.rest.webmvc.mapping.LinkCollector
-
Returns all
Links
for the given object. - getLinksFor(Object, Links) - Method in class org.springframework.data.rest.webmvc.mapping.DefaultLinkCollector
-
Returns all
Links
for the given object and already existingLink
. - getLinksFor(Object, Links) - Method in interface org.springframework.data.rest.webmvc.mapping.LinkCollector
-
Returns all
Links
for the given object and already existingLink
. - getLinksFor(Association<? extends PersistentProperty<?>>, Path) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
-
Returns the links to render for the given
Association
. - getLinksForNested(Object, Links) - Method in class org.springframework.data.rest.webmvc.mapping.DefaultLinkCollector
- getLinksForNested(Object, Links) - Method in interface org.springframework.data.rest.webmvc.mapping.LinkCollector
- getLookupProperty() - Method in interface org.springframework.data.rest.core.support.EntityLookup
-
Returns the lookup property if available.
- getMappedMethod(String) - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
-
Returns the method mapped to the given path.
- getMappingFor(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- getMappingFor(PersistentProperty<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns the
ResourceMapping
for the givenPersistentProperty
or null if not managed. - getMappingForMethod(Method, Class<?>) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
- getMappings() - Method in class org.springframework.data.rest.webmvc.mapping.Associations
- getMaxPageSize() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the maximum size of pages.
- getMessage() - Method in class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
- getMessage() - Method in interface org.springframework.data.rest.core.mapping.ResourceDescription
-
Returns the description.
- getMessage() - Method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- getMessage() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationMessage
- getMessage() - Method in class org.springframework.data.rest.webmvc.support.ExceptionMessage
- getMessage() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- getMessages() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationExceptionMessage
- getMetadataConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
MetadataConfiguration
to customize metadata exposure. - getMetadataFor(Class<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- getMetadataFor(Class<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMappings
-
Returns a
ResourceMetadata
for the given type if available. - getMetadataFor(Class<?>) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
-
Returns the
ResourceMetadata
for the given type. - getMethod() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
-
Returns the
Method
backing the resource. - getMethodsFor(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.CrudMethodsSupportedHttpMethods
- getMethodsFor(PersistentProperty<?>) - Method in interface org.springframework.data.rest.core.mapping.SupportedHttpMethods
-
Returns the supported
HttpMethod
s for the givenPersistentProperty
. - getMethodsFor(PersistentProperty<?>) - Method in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
- getMethodsFor(ResourceType) - Method in class org.springframework.data.rest.core.mapping.CrudMethodsSupportedHttpMethods
- getMethodsFor(ResourceType) - Method in interface org.springframework.data.rest.core.mapping.SupportedHttpMethods
-
Returns the supported
HttpMethod
s for the givenResourceType
. - getMethodsFor(ResourceType) - Method in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
- getName() - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
-
Return sthe name of the method parameter.
- getName() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- getNameForPath(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- getOrder() - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerAdapter
- getPageable() - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
-
Returns the delegate
Pageable
. - getPageParamName() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the name of the URL query string parameter that indicates what page to return.
- getPaginationTemplateVariables(MethodParameter, UriComponents) - Method in interface org.springframework.data.rest.webmvc.support.PagingAndSortingTemplateVariables
-
Returns the
TemplateVariables
for pagination. - getParameterName() - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
- getParameterName() - Method in interface org.springframework.data.rest.core.projection.ProjectionDefinitions
-
Returns the request parameter to be used to expose the projection to the web.
- getParameterNames() - Method in class org.springframework.data.rest.core.mapping.ParametersMetadata
-
Returns all parameter names.
- getParametersMetadata() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
-
Returns
ParameterMetadata
instances for all named parameters. - getPath() - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- getPath() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
-
Returns the path the resource is exposed under.
- getPath() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- getPath(RepositoryRestConfiguration, ResourceMapping) - Static method in class org.springframework.data.rest.webmvc.ProfileController
-
Return the href for the profile link of a given baseUri and domain type mapping.
- getPathSegments(Method) - Static method in class org.springframework.data.rest.webmvc.util.UriUtils
-
Returns the mapping path segments request mapping.
- getPatternFor(Class<?>) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Returns the
Pattern
registered for the given value type. - getPersistentEntity() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Returns the
PersistentEntity
for the underlying instance. - getPersistentEntity() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getProjectionConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
ProjectionDefinitionConfiguration
to register addition projections. - getProjectionsFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Returns all projections registered for the given source type.
- getProjectionType(Class<?>, String) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
- getProjectionType(Class<?>, String) - Method in interface org.springframework.data.rest.core.projection.ProjectionDefinitions
-
Returns the projection type for the given source type and name.
- getProperty() - Method in interface org.springframework.data.rest.core.mapping.PropertyAwareResourceMapping
- getProperty() - Method in class org.springframework.data.rest.webmvc.support.ConstraintViolationMessage
- getProperty() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- getProperty(String) - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns the
PropertyAwareResourceMapping
for the given mapped path. - getPropertyAccessor() - Method in class org.springframework.data.rest.core.ValidationErrors
- getPropertyAccessor() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Returns the
PersistentPropertyAccessor
for the underlying content bean. - getReadableProperty(String, Class<?>) - Method in interface org.springframework.data.rest.webmvc.json.patch.BindContext
-
Return the name of the readable property for the given JSON pointer segment.
- getRel() - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- getRel() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
-
Returns the relation for the resource exported.
- getRel() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- getRelProvider() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.since 3.5, use
RepositoryRestConfiguration.getLinkRelationProvider()
instead. - getRepositoryDetectionStrategy() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
RepositoryDetectionStrategy
to be used to decide which repositories get exposed. - getRepositoryLookupPath(String) - Method in class org.springframework.data.rest.webmvc.BaseUri
-
Extracts the actual lookup path within the Spring Data REST managed URI space.
- getRepositoryLookupPath(NativeWebRequest) - Method in class org.springframework.data.rest.webmvc.BaseUri
-
Extracts the actual lookup path within the Spring Data REST managed URI space.
- getResourceIdentifier(T) - Method in interface org.springframework.data.rest.core.support.EntityLookup
-
Returns the property of the given entity that shall be used to uniquely identify it.
- getResourceMapping(RepositoryRestConfiguration, PersistentEntity<?, ?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- getResourceMapping(RepositoryRestConfiguration, RepositoryInformation) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- getResourceMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
- getResourceMappingFor(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- getResourceMappingForDomainType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- getResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- getResourceMappings() - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- getResourceMetadata() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getReturnedDomainType() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
-
Returns the domain type that the query method returns.
- getRootPath(RepositoryRestConfiguration) - Static method in class org.springframework.data.rest.webmvc.ProfileController
-
Return the href for the profile root link of a given baseUri.
- getSchema() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getSchemaFormatFor(Class<?>) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Returns the
JsonSchemaFormat
to be used for the given type. - getSearchMappings() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getSearchResourceMappings() - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns the
SearchResourceMappings
, i.e. the mappings for the search resource exposed for the current resource. - getSearchResourceMappings(Class<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- getSearchResourceMappings(Class<?>) - Method in class org.springframework.data.rest.core.mapping.RepositoryResourceMappings
- getSearchResourceMappings(Class<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMappings
-
Returns the
ResourceMapping
s for the search resources of the given type. - getServerHttpRequest() - Method in class org.springframework.data.rest.webmvc.IncomingRequest
-
Returns the underlying
ServerHttpRequest
. - getSortParamName() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Get the name of the URL query string parameter that indicates what direction to sort results.
- getSortTemplateVariables(MethodParameter, UriComponents) - Method in interface org.springframework.data.rest.webmvc.support.PagingAndSortingTemplateVariables
-
Returns the
TemplateVariables
for sorting. - getSupportedHttpMethods() - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns the supported
HttpMethod
s. - getSupportedMediaTypes() - Method in class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
- getSupportedMethods() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- getTarget() - Method in class org.springframework.data.rest.core.ValidationErrors
- getTarget() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Returns the underlying instance.
- getThis() - Method in class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- getTitle() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- getTitle() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getType() - Method in class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
- getType() - Method in interface org.springframework.data.rest.core.mapping.ResourceDescription
- getType() - Method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- getType() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema
- getTypeSerializer(Class<?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Returns the
JsonSerializer
for the given type, or null if none available. - getUri() - Method in class org.springframework.data.rest.webmvc.BaseUri
-
Returns the base URI.
- getUriComponentsBuilder() - Method in class org.springframework.data.rest.webmvc.BaseUri
-
Returns a new
UriComponentsBuilder
for the base URI. - getValues() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- getValues(Class<? extends Enum<?>>) - Method in class org.springframework.data.rest.webmvc.json.EnumTranslator
-
Returns all potentially translated values for the given
Enum
type. - getWritableProperty(String, Class<?>) - Method in interface org.springframework.data.rest.webmvc.json.patch.BindContext
-
Returns the name of the writable property for the given JSON pointer segment.
H
- HAL_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- halJacksonHttpMessageConverter(LinkCollector, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- halObjectMapper(LinkCollector) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- HandleAfterCreate - Annotation Interface in org.springframework.data.rest.core.annotation
- HandleAfterDelete - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the afterDelete event.
- HandleAfterLinkDelete - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the afterLinkDelete event.
- HandleAfterLinkSave - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the afterLinkSave event.
- HandleAfterSave - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the afterSave event.
- HandleBeforeCreate - Annotation Interface in org.springframework.data.rest.core.annotation
- HandleBeforeDelete - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the beforeDelete event.
- HandleBeforeLinkDelete - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the beforeLinkDelete event.
- HandleBeforeLinkSave - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the beforeLinkSave event.
- HandleBeforeSave - Annotation Interface in org.springframework.data.rest.core.annotation
-
Denotes a component that should handle the beforeSave event.
- handleNoMatch(Set<RequestMappingInfo>, String, HttpServletRequest) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- hasCorsConfigurationSource(Object) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
- hasExcerptProjection(Class<?>) - Method in class org.springframework.data.rest.webmvc.support.DefaultExcerptProjector
- hasExcerptProjection(Class<?>) - Method in interface org.springframework.data.rest.webmvc.support.ExcerptProjector
-
Returns whether an excerpt projection has been registered for the given type.
- hashCode() - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
- hashCode() - Method in class org.springframework.data.rest.core.Path
- hashCode() - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
- hashCode() - Method in class org.springframework.data.rest.webmvc.support.ETag
- hashCode() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- hasMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- hasMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.mapping.RepositoryResourceMappings
- hasMappingFor(Class<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMappings
-
Returns whether we have a
ResourceMapping
for the given type. - hasMetadataFor(Class<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
-
Returns whether we currently already have
ResourceMetadata
for the given type. - hasProjectionFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
- hasProjectionFor(Class<?>) - Method in interface org.springframework.data.rest.core.projection.ProjectionDefinitions
-
Returns whether we have a projection registered for the given source type.
- hasResourceMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
- hasResourceMappingFor(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- hasResourceMappingForDomainType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- hasResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- hasTextExceptSlash(CharSequence) - Static method in class org.springframework.data.rest.core.support.ResourceStringUtils
-
Checks whether the given input contains actual text (slash excluded).
- headForRepositories() - Method in class org.springframework.data.rest.webmvc.RepositoryController
-
HEAD /
- HOSTNAME - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- httpHeadersPreparer(AuditableBeanWrapperFactory) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- HttpHeadersPreparer - Class in org.springframework.data.rest.webmvc
- HttpHeadersPreparer(AuditableBeanWrapperFactory) - Constructor for class org.springframework.data.rest.webmvc.HttpHeadersPreparer
- HttpMethodHandlerMethodArgumentResolver - Enum Class in org.springframework.data.rest.webmvc.support
-
HandlerMethodArgumentResolver
to provideHttpMethod
instances for innjection into MVC controller methods. - HttpMethods - Interface in org.springframework.data.rest.core.mapping
-
A collection of
HttpMethod
s with some convenience methods to create alternate sets of those.
I
- IncomingRequest - Class in org.springframework.data.rest.webmvc
-
Value object to wrap a
ServerHttpRequest
to provide a slightly more abstract API to find out about the request method. - IncomingRequest(ServerHttpRequest) - Constructor for class org.springframework.data.rest.webmvc.IncomingRequest
-
Creates a new
IncomingRequest
fromServerHttpRequest
. - InputStreamHttpInputMessage - Class in org.springframework.data.rest.webmvc.util
-
HttpInputMessage
based on a plainInputStream
, i.e. exposing no headers. - INSTANCE - Enum constant in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
- INSTANCE - Enum constant in enum class org.springframework.data.rest.core.StringToLdapNameConverter
- INSTANCE - Enum constant in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
- INSTANCE - Enum constant in enum class org.springframework.data.rest.webmvc.support.HttpMethodHandlerMethodArgumentResolver
- IPV4 - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- IPV6 - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- isDefault() - Method in class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
- isDefault() - Method in interface org.springframework.data.rest.core.mapping.ResourceDescription
-
Returns whether this is the default description.
- isDefault() - Method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
- isDefault() - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
-
Returns whether the contained
Pageable
is the default one configured. - isEnableEnumTranslation() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns whether enum value translation is enabled.
- isExported() - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- isExported() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
-
Returns whether the component shall be exported at all.
- isExported() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- isExported(PersistentProperty<?>) - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
-
Returns whether the given
PersistentProperty
is a managed resource and in fact exported. - isExported(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Check if a given property for a type is available to be exported, i.e. serialized via Jackson.
- isExported(RepositoryMetadata) - Method in interface org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy
-
Returns whether the repository described by the given
RepositoryMetadata
is exported or not. - isHandler(Class<?>) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
-
Deprecated.for overriding in 3.6. Will be made final in 4.0.
- isHandlerInternal(Class<?>) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
-
Returns whether the given controller type is considered a handler.
- isHandlerInternal(Class<?>) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- isIdExposed(PersistentEntity<?, ?>) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
- isIdExposedFor(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Should we expose the ID property for this domain type?
- isJsonMergePatchRequest() - Method in class org.springframework.data.rest.webmvc.IncomingRequest
-
Returns whether the request is a PATCH request with a payload of type
RestMediaTypes.MERGE_PATCH_JSON
. - isJsonPatchRequest() - Method in class org.springframework.data.rest.webmvc.IncomingRequest
-
Returns whether the request is a PATCH request with a payload of type
RestMediaTypes.JSON_PATCH_JSON
. - isLinkableAssociation(Association<? extends PersistentProperty<?>>) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
-
Returns whether the given
Association
is linkable. - isLinkableAssociation(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
-
Returns whether the given property is an association that is linkable.
- isLookupType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
- isLookupType(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.mapping.Associations
-
Returns whether the type of the given
PersistentProperty
is configured as lookup type. - isMapped(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- isMapped(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.RepositoryResourceMappings
- isNested() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
- isNew() - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource
-
Returns whether the content of the resource is a new entity about to be created.
- isObjectStillValid(Object, HttpHeaders) - Method in class org.springframework.data.rest.webmvc.HttpHeadersPreparer
-
Returns whether the given object is still valid in the context of the given
HttpHeaders
' requirements. - isPagingResource() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
-
Returns whether the resource is paging one.
- isPagingResource() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- isPatchRequest() - Method in class org.springframework.data.rest.webmvc.IncomingRequest
-
Returns whether the request is a PATCH request.
- isReadOnly() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- isReadOnly(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Returns whether the given
PersistentProperty
is considered read-only by Jackson. - isReturnBodyOnCreate() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.
- isReturnBodyOnUpdate() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.
- isSortableResource() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
-
Returns whether the resource is sortable.
- isValueType() - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Returns whether the backing type is considered a Jackson value type.
- ITEM - Enum constant in enum class org.springframework.data.rest.core.mapping.ResourceType
- itemResourceDescription() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
The description of the item resource.
- itemResourceRel() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
The rel value to use when generating links to the item resource.
- items - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- iterator() - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
- iterator() - Method in class org.springframework.data.rest.core.mapping.ParametersMetadata
- iterator() - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
- iterator() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
- iterator() - Method in class org.springframework.data.rest.webmvc.json.JacksonMetadata
- iterator() - Method in class org.springframework.data.rest.webmvc.json.patch.Patch
J
- Jackson2DatatypeHelper - Class in org.springframework.data.rest.webmvc.json
-
Helper class to register datatype modules based on their presence in the classpath.
- Jackson2DatatypeHelper() - Constructor for class org.springframework.data.rest.webmvc.json.Jackson2DatatypeHelper
- jacksonHttpMessageConverter(RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
The
HttpMessageConverter
used by Spring MVC to read and write JSON data. - JacksonMappingAwareSortTranslator - Class in org.springframework.data.rest.webmvc.json
-
Translator for
Sort
arguments that is aware of Jackson-Mapping on domain classes. - JacksonMappingAwareSortTranslator(ObjectMapper, Repositories, DomainClassResolver, PersistentEntities, Associations) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonMappingAwareSortTranslator
-
Creates a new
JacksonMappingAwareSortTranslator
for the givenObjectMapper
,Repositories
,DomainClassResolver
andPersistentEntities
. - JacksonMappingAwareSortTranslator.SortTranslator - Class in org.springframework.data.rest.webmvc.json
-
Translates
Sort
orders from Jackson-mapped field names toPersistentProperty
names. - JacksonMetadata - Class in org.springframework.data.rest.webmvc.json
-
Value object to abstract Jackson based bean metadata of a given type.
- JacksonMetadata(ObjectMapper, Class<?>) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonMetadata
-
Creates a new
JacksonMetadata
instance for the givenObjectMapper
and type. - JacksonSerializers - Class in org.springframework.data.rest.webmvc.json
-
Custom Spring Data REST Jackson serializers.
- JacksonSerializers(EnumTranslator) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonSerializers
-
Creates a new
JacksonSerializers
with the givenEnumTranslator
. - JacksonSerializers.EnumTranslatingDeserializer - Class in org.springframework.data.rest.webmvc.json
-
Enum deserializer that uses a resource bundle to resolve enum values.
- JacksonSerializers.EnumTranslatingSerializer - Class in org.springframework.data.rest.webmvc.json
-
An enum serializer to translate raw enum values into values resolved through a resource bundle.
- jpaHelper() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- JpaHelper - Class in org.springframework.data.rest.webmvc.support
- JpaHelper() - Constructor for class org.springframework.data.rest.webmvc.support.JpaHelper
- JSON_PATCH_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- JsonPatchPatchConverter - Class in org.springframework.data.rest.webmvc.json.patch
-
Convert
JsonNode
s containing JSON Patch to/fromPatch
objects. - JsonPatchPatchConverter(ObjectMapper, BindContext) - Constructor for class org.springframework.data.rest.webmvc.json.patch.JsonPatchPatchConverter
- JsonSchema - Class in org.springframework.data.rest.webmvc.json
-
Model class to render JSON schema documents.
- JsonSchema(String, String, Collection<JsonSchema.AbstractJsonSchemaProperty<?>>, JsonSchema.Definitions) - Constructor for class org.springframework.data.rest.webmvc.json.JsonSchema
-
Creates a new
JsonSchema
instance for the given title, description,JsonSchema.AbstractJsonSchemaProperty
s andJsonSchema.Definitions
. - JsonSchema.Definitions - Class in org.springframework.data.rest.webmvc.json
-
Value object to abstract a
Map
of JSON Schema definitions. - JsonSchema.EnumProperty - Class in org.springframework.data.rest.webmvc.json
-
A
JsonSchema.JsonSchemaProperty
representing enumerations. - JsonSchema.JsonSchemaProperty - Class in org.springframework.data.rest.webmvc.json
-
A JSON Schema property
- jsonSchemaConverter(PersistentEntities, Associations, RepositoryInvokerFactory, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Turns a domain class into a
JsonSchema
. - JsonSchemaFormat - Enum Class in org.springframework.data.rest.core.config
-
An enum to represent JSON Schema pre-defined formats.
- JsonSchemaPropertyCustomizer - Interface in org.springframework.data.rest.webmvc.json
-
Callback interface to customize the
JsonSchema.JsonSchemaProperty
created by default for a given type.
L
- linkCollector(PersistentEntities, SelfLinkProvider, Associations) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- LinkCollector - Interface in org.springframework.data.rest.webmvc.mapping
-
A service to collect all standard links that need to be added to a certain object.
- LinkedEntityEvent - Class in org.springframework.data.rest.core.event
-
Base class for
RepositoryEvent
s that deal with saving/updating or deleting a linked object. - LinkedEntityEvent(Object, Object) - Constructor for class org.springframework.data.rest.core.event.LinkedEntityEvent
-
Creates a new
LinkedEntityEvent
for th given source and linked instance. - linkFor(Class<?>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- linkFor(Class<?>, Object...) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- linkForItemResource(Class<?>, Object) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- linksToSearchResources(Class<?>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Returns all links to search resource for the given type.
- linksToSearchResources(Class<?>, Pageable) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Returns all link to search resources for the given type, pre-expanded with the given
Pageable
if applicable. - linksToSearchResources(Class<?>, Sort) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Returns all link to search resources for the given type, pre-expanded with the given
Sort
if applicable. - linkToCollectionResource(Class<?>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- linkToItemResource(Class<?>, Object) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- linkToPagedResource(Class<?>, Pageable) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Returns the link to to the paged colelction resource for the given type, pre-expanding the
- linkToSearchResource(Class<?>, LinkRelation) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Creates the link to the search resource with the given
LinkRelation
for a given type. - linkToSearchResource(Class<?>, LinkRelation, Pageable) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Creates the link to the search resource with the given
LinkRelation
for a given type. - linkToSearchResource(Class<?>, LinkRelation, Sort) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
-
Creates the link to the search resource with the given
LinkRelation
for a given type. - listRepositories() - Method in class org.springframework.data.rest.webmvc.RepositoryController
-
Lists all repositories exported by creating a link list pointing to resources exposing the repositories.
- lookup(R, ID) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar.LookupRegistrar.Lookup
-
Looks up the entity using the given
Repository
and identifier. - lookupEntity(Object) - Method in interface org.springframework.data.rest.core.support.EntityLookup
-
Returns the entity instance to be used if an entity with the given identifier value is requested.
- lookupHandlerMethod(String, HttpServletRequest) - Method in class org.springframework.data.rest.webmvc.BasePathAwareHandlerMapping
- lookupHandlerMethod(String, HttpServletRequest) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- LookupObjectSerializer(PluginRegistry<EntityLookup<?>, Class<?>>) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.LookupObjectSerializer
M
- MappingAwareDefaultedPageableArgumentResolver - Class in org.springframework.data.rest.webmvc.json
-
HandlerMethodArgumentResolver
to resolveDefaultedPageable
from aPageableHandlerMethodArgumentResolver
applying field to property mapping. - MappingAwareDefaultedPageableArgumentResolver(JacksonMappingAwareSortTranslator, PageableHandlerMethodArgumentResolver) - Constructor for class org.springframework.data.rest.webmvc.json.MappingAwareDefaultedPageableArgumentResolver
- MappingAwarePageableArgumentResolver - Class in org.springframework.data.rest.webmvc.json
-
HandlerMethodArgumentResolver
to resolvePageable
from aPageableArgumentResolver
applying field to property mapping. - MappingAwarePageableArgumentResolver(JacksonMappingAwareSortTranslator, PageableArgumentResolver) - Constructor for class org.springframework.data.rest.webmvc.json.MappingAwarePageableArgumentResolver
- MappingAwareSortArgumentResolver - Class in org.springframework.data.rest.webmvc.json
-
HandlerMethodArgumentResolver
to resolveSort
from aSortHandlerMethodArgumentResolver
applying field to property mapping. - MappingAwareSortArgumentResolver(JacksonMappingAwareSortTranslator, SortArgumentResolver) - Constructor for class org.springframework.data.rest.webmvc.json.MappingAwareSortArgumentResolver
- MapUtils - Interface in org.springframework.data.rest.core.util
-
Helper methods to work with
Map
s. - matches(String) - Method in class org.springframework.data.rest.core.Path
-
Returns whether the given reference String matches the current
Path
. - matches(TypeDescriptor, TypeDescriptor) - Method in class org.springframework.data.rest.core.UriToEntityConverter
- matches(TypeDescriptor, TypeDescriptor) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter
- matches(PersistentEntity<?, ?>, Object) - Method in class org.springframework.data.rest.webmvc.support.ETag
-
Returns whether the
ETag
matches the givenPersistentEntity
and target. - merge(Class<?>, ResourceMapping) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- merge(Method, ResourceMapping) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- MERGE_PATCH_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- metadataConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.since 2.4, use
RepositoryRestConfiguration.getMetadataConfiguration()
instead. - metadataConfiguration() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- MetadataConfiguration - Class in org.springframework.data.rest.core.config
-
Configuration for metadata exposure.
- MetadataConfiguration() - Constructor for class org.springframework.data.rest.core.config.MetadataConfiguration
- MethodResourceMapping - Interface in org.springframework.data.rest.core.mapping
-
A
ResourceMapping
that is backed by aMethod
.
N
- name() - Element in annotation interface org.springframework.data.rest.core.config.Projection
-
The name of projection to refer to.
- NO_ETAG - Static variable in class org.springframework.data.rest.webmvc.support.ETag
- none() - Static method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AggregateResourceHttpMethodsFilter
-
Returns a default filter that just returns all
HttpMethods
as is, i.e. does not apply any filtering. - none() - Static method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AssociationResourceHttpMethodsFilter
-
Returns a default filter that just returns all
HttpMethods
as is, i.e. does not apply any filtering. - none() - Static method in interface org.springframework.data.rest.core.mapping.HttpMethods
- None() - Constructor for class org.springframework.data.rest.core.annotation.RepositoryRestResource.None
- NONE - Static variable in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
- NONE - Static variable in class org.springframework.data.rest.webmvc.BaseUri
O
- objectMapper() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
The Jackson
ObjectMapper
used internally. - of(InputStream) - Static method in class org.springframework.data.rest.webmvc.util.InputStreamHttpInputMessage
- of(String, String, Object, String) - Static method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- of(Collection<HttpMethod>) - Static method in interface org.springframework.data.rest.core.mapping.HttpMethods
-
Returns a new
HttpMethods
with the givenHttpMethod
s. - of(Repositories, ResourceMappings, BaseUri) - Static method in class org.springframework.data.rest.webmvc.support.DomainClassResolver
- omitUnresolvableDescriptionKeys() - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Returns whether to omit documentation attributes for unresolvable resource bundle keys.
- onAfterCreate(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onAfterCreate(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in afterCreate events.
- onAfterDelete(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onAfterDelete(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in afterDelete events.
- onAfterLinkDelete(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in afterLinkDelete events.
- onAfterLinkSave(Object, Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onAfterLinkSave(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in afterLinkSave events.
- onAfterSave(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onAfterSave(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in afterSave events.
- onApplicationEvent(RepositoryEvent) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
- onApplicationEvent(RepositoryEvent) - Method in class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
- onBeforeCreate(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onBeforeCreate(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in beforeCreate events.
- onBeforeDelete(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onBeforeDelete(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in beforeDelete events.
- onBeforeLinkDelete(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in beforeLinkDelete events.
- onBeforeLinkSave(Object, Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onBeforeLinkSave(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in beforeLinkSave events.
- onBeforeSave(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
- onBeforeSave(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
-
Override this method if you are interested in beforeSave events.
- op - Variable in class org.springframework.data.rest.webmvc.json.patch.PatchOperation
- optionsForRepositories() - Method in class org.springframework.data.rest.webmvc.RepositoryController
-
OPTIONS /
. - org.springframework.data.rest.core - package org.springframework.data.rest.core
- org.springframework.data.rest.core.annotation - package org.springframework.data.rest.core.annotation
- org.springframework.data.rest.core.config - package org.springframework.data.rest.core.config
- org.springframework.data.rest.core.event - package org.springframework.data.rest.core.event
- org.springframework.data.rest.core.mapping - package org.springframework.data.rest.core.mapping
- org.springframework.data.rest.core.projection - package org.springframework.data.rest.core.projection
- org.springframework.data.rest.core.support - package org.springframework.data.rest.core.support
- org.springframework.data.rest.core.util - package org.springframework.data.rest.core.util
- org.springframework.data.rest.webmvc - package org.springframework.data.rest.webmvc
- org.springframework.data.rest.webmvc.alps - package org.springframework.data.rest.webmvc.alps
- org.springframework.data.rest.webmvc.config - package org.springframework.data.rest.webmvc.config
- org.springframework.data.rest.webmvc.convert - package org.springframework.data.rest.webmvc.convert
- org.springframework.data.rest.webmvc.json - package org.springframework.data.rest.webmvc.json
- org.springframework.data.rest.webmvc.json.patch - package org.springframework.data.rest.webmvc.json.patch
- org.springframework.data.rest.webmvc.mapping - package org.springframework.data.rest.webmvc.mapping
- org.springframework.data.rest.webmvc.spi - package org.springframework.data.rest.webmvc.spi
- org.springframework.data.rest.webmvc.support - package org.springframework.data.rest.webmvc.support
- org.springframework.data.rest.webmvc.util - package org.springframework.data.rest.webmvc.util
P
- pageableResolver() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- PagingAndSortingTemplateVariables - Interface in org.springframework.data.rest.webmvc.support
-
Interface to abstract the access of
TemplateVariables
for pagination and sorting. - ParameterMetadata - Class in org.springframework.data.rest.core.mapping
-
Value object to capture metadata for query method parameters.
- ParameterMetadata(MethodParameter, String) - Constructor for class org.springframework.data.rest.core.mapping.ParameterMetadata
-
Creates a new
ParameterMetadata
for the givenMethodParameter
and base rel. - ParametersMetadata - Class in org.springframework.data.rest.core.mapping
-
Value object for a list of
ParameterMetadata
instances. - Patch - Class in org.springframework.data.rest.webmvc.json.patch
-
Represents a Patch.
- Patch(List<PatchOperation>, BindContext) - Constructor for class org.springframework.data.rest.webmvc.json.patch.Patch
- PatchConverter<T> - Interface in org.springframework.data.rest.webmvc.json.patch
-
A strategy interface for producing
Patch
instances from a patch document representation (such as JSON Patch) and rendering a Patch to a patch document representation. - PatchException - Exception in org.springframework.data.rest.webmvc.json.patch
-
Exception thrown if an error occurs in the course of applying a Patch.
- PatchException(String) - Constructor for exception org.springframework.data.rest.webmvc.json.patch.PatchException
- PatchException(String, Exception) - Constructor for exception org.springframework.data.rest.webmvc.json.patch.PatchException
- PatchOperation - Class in org.springframework.data.rest.webmvc.json.patch
-
Abstract base class representing and providing support methods for patch operations.
- PatchOperation(String, SpelPath.UntypedSpelPath) - Constructor for class org.springframework.data.rest.webmvc.json.patch.PatchOperation
-
Constructs the operation.
- PatchOperation(String, SpelPath.UntypedSpelPath, Object) - Constructor for class org.springframework.data.rest.webmvc.json.patch.PatchOperation
- path - Variable in class org.springframework.data.rest.webmvc.json.patch.PatchOperation
- path() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryRestResource
-
The path segment under which this resource is to be exported.
- path() - Element in annotation interface org.springframework.data.rest.core.annotation.RestResource
-
The path segment under which this resource is to be exported.
- path() - Element in annotation interface org.springframework.data.rest.webmvc.BasePathAwareController
-
The root path to be prepended to all request mappings configured on handler methods.
- path() - Element in annotation interface org.springframework.data.rest.webmvc.RepositoryRestController
-
The root path to be prepended to all request mappings configured on handler methods.
- Path - Class in org.springframework.data.rest.core
-
Simple value object to build up (URI) paths.
- Path(String) - Constructor for class org.springframework.data.rest.core.Path
- pattern - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- persistentEntities() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- PersistentEntitiesBindContextFactory - Class in org.springframework.data.rest.webmvc.json
-
A
BindContextFactory
based onPersistentEntities
. - PersistentEntitiesBindContextFactory(PersistentEntities) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntitiesBindContextFactory
-
Creates a new
PersistentEntitiesBindContextFactory
for the givenPersistentEntities
. - PersistentEntitiesResourceMappings - Class in org.springframework.data.rest.core.mapping
- PersistentEntitiesResourceMappings(PersistentEntities) - Constructor for class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
-
Creates a new
PersistentEntitiesResourceMappings
from the givenPersistentEntities
. - persistentEntityArgumentResolver(List<HttpMessageConverter<?>>, RootResourceInformationHandlerMethodArgumentResolver, Associations, BackendIdHandlerMethodArgumentResolver, PersistentEntities) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Reads incoming JSON into an entity.
- persistentEntityJackson2Module(LinkCollector) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.
- PersistentEntityJackson2Module - Class in org.springframework.data.rest.webmvc.json
-
Jackson 2 module to serialize and deserialize
PersistentEntityResource
s. - PersistentEntityJackson2Module(Associations, PersistentEntities, UriToEntityConverter, LinkCollector, RepositoryInvokerFactory, PersistentEntityJackson2Module.LookupObjectSerializer, RepresentationModelProcessorInvoker, EmbeddedResourcesAssembler) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module
-
Creates a new
PersistentEntityJackson2Module
using the givenResourceMappings
,Repositories
,RepositoryRestConfiguration
,UriToEntityConverter
andSelfLinkProvider
. - PersistentEntityJackson2Module.AssociationUriResolvingDeserializerModifier - Class in org.springframework.data.rest.webmvc.json
-
A
BeanDeserializerModifier
that registers a customPersistentEntityJackson2Module.UriStringDeserializer
for association properties ofPersistentEntity
s. - PersistentEntityJackson2Module.LookupObjectSerializer - Class in org.springframework.data.rest.webmvc.json
- PersistentEntityJackson2Module.UriStringDeserializer - Class in org.springframework.data.rest.webmvc.json
-
Custom
JsonDeserializer
to interpretString
values as URIs and resolve them using aUriToEntityConverter
. - PersistentEntityProjector - Class in org.springframework.data.rest.webmvc.support
-
Projector
looking up a projection by name for the given source type. - PersistentEntityProjector(ProjectionDefinitions, ProjectionFactory, String, ResourceMappings) - Constructor for class org.springframework.data.rest.webmvc.support.PersistentEntityProjector
-
Creates a new
PersistentEntityProjector
using the givenProjectionDefinitions
,ProjectionFactory
and projection name. - PersistentEntityResource - Class in org.springframework.data.rest.webmvc
-
A Spring HATEOAS
EntityModel
subclass that holds a reference to the entity'sPersistentEntity
metadata. - PersistentEntityResource.Builder - Class in org.springframework.data.rest.webmvc
-
Builder to create
PersistentEntityResource
instances. - PersistentEntityResourceAssembler - Class in org.springframework.data.rest.webmvc
-
RepresentationModelAssembler
to createPersistentEntityResource
s for arbitrary domain objects. - PersistentEntityResourceAssembler(PersistentEntities, Projector, Associations, SelfLinkProvider) - Constructor for class org.springframework.data.rest.webmvc.PersistentEntityResourceAssembler
-
Creates a new
PersistentEntityResourceAssembler
for the givenPersistentEntities
,Projector
,Associations
andSelfLinkProvider
. - PersistentEntityResourceAssemblerArgumentResolver - Class in org.springframework.data.rest.webmvc.config
- PersistentEntityResourceAssemblerArgumentResolver(PersistentEntities, SelfLinkProvider, ProjectionDefinitions, ProjectionFactory, Associations) - Constructor for class org.springframework.data.rest.webmvc.config.PersistentEntityResourceAssemblerArgumentResolver
- PersistentEntityResourceHandlerMethodArgumentResolver - Class in org.springframework.data.rest.webmvc.config
-
Custom
HandlerMethodArgumentResolver
to createPersistentEntityResource
instances. - PersistentEntityResourceHandlerMethodArgumentResolver(List<HttpMessageConverter<?>>, RootResourceInformationHandlerMethodArgumentResolver, BackendIdHandlerMethodArgumentResolver, DomainObjectReader, PluginRegistry<EntityLookup<?>, Class<?>>, BindContextFactory) - Constructor for class org.springframework.data.rest.webmvc.config.PersistentEntityResourceHandlerMethodArgumentResolver
- PersistentEntityResourceProcessor - Class in org.springframework.data.rest.webmvc.support
- PersistentEntityResourceProcessor(Repositories, List<RepresentationModelProcessor<EntityModel<?>>>) - Constructor for class org.springframework.data.rest.webmvc.support.PersistentEntityResourceProcessor
- PersistentEntityToJsonSchemaConverter - Class in org.springframework.data.rest.webmvc.json
-
Converter to create
JsonSchema
instances forPersistentEntity
s. - PersistentEntityToJsonSchemaConverter(PersistentEntities, Associations, MessageResolver, ObjectMapper, RepositoryRestConfiguration, PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter
-
Creates a new
PersistentEntityToJsonSchemaConverter
for the givenPersistentEntities
andResourceMappings
. - PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory - Class in org.springframework.data.rest.webmvc.json
- postProcess(MethodParameter, RepositoryInvoker, Class<?>, Map<String, String[]>) - Method in class org.springframework.data.rest.webmvc.config.RootResourceInformationHandlerMethodArgumentResolver
-
Potentially customize the given
RepositoryInvoker
for the given domain type. - postProcessAfterInitialization(Object, String) - Method in class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
- postProcessAfterInitialization(Object, String) - Method in class org.springframework.data.rest.webmvc.config.ProjectionDefinitionRegistar
- postProcessBeforeInitialization(Object, String) - Method in class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
- prepareHeaders(Optional<PersistentEntityResource>) - Method in class org.springframework.data.rest.webmvc.HttpHeadersPreparer
-
Returns the default headers to be returned for the given
PersistentEntityResource
. - prepareHeaders(PersistentEntity<?, ?>, Object) - Method in class org.springframework.data.rest.webmvc.HttpHeadersPreparer
-
Returns the default headers to be returned for the given
PersistentEntity
and value. - process(PersistentEntityResource) - Method in class org.springframework.data.rest.webmvc.support.PersistentEntityResourceProcessor
- process(RepositoryLinksResource) - Method in class org.springframework.data.rest.webmvc.ProfileResourceProcessor
-
Add a link to the
ProfileController
's base URI to the app's root URI. - PROFILE_REL - Static variable in class org.springframework.data.rest.webmvc.ProfileResourceProcessor
- PROFILE_ROOT_MAPPING - Static variable in class org.springframework.data.rest.webmvc.ProfileController
- ProfileController - Class in org.springframework.data.rest.webmvc
-
Profile-based controller exposing multiple forms of metadata.
- ProfileController(RepositoryRestConfiguration, RepositoryResourceMappings, Repositories) - Constructor for class org.springframework.data.rest.webmvc.ProfileController
-
Wire up the controller with a copy of
RepositoryRestConfiguration
. - profileOptions() - Method in class org.springframework.data.rest.webmvc.ProfileController
-
List the OPTIONS for this controller.
- profileResourceProcessor(RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ProfileResourceProcessor - Class in org.springframework.data.rest.webmvc
-
RepresentationModelProcessor
to add aprofile
link to the root resource to point to multiple forms of metadata. - ProfileResourceProcessor(RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.webmvc.ProfileResourceProcessor
-
Creates a new
ProfileResourceProcessor
with the givenRepositoryRestConfiguration
. - project(Object) - Method in class org.springframework.data.rest.webmvc.support.PersistentEntityProjector
- project(Object) - Method in interface org.springframework.data.rest.webmvc.support.Projector
-
Returns the projection object for the given source.
- projectExcerpt(Object) - Method in class org.springframework.data.rest.webmvc.support.DefaultExcerptProjector
- projectExcerpt(Object) - Method in interface org.springframework.data.rest.webmvc.support.ExcerptProjector
-
Creates a excerpt projection for the given source.
- projectExcerpt(Object) - Method in class org.springframework.data.rest.webmvc.support.PersistentEntityProjector
- Projection - Annotation Interface in org.springframework.data.rest.core.config
-
Annotation to tie a particular projection type to a source type.
- projectionConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.since 2.4, use
RepositoryRestConfiguration.getProjectionConfiguration()
instead. - ProjectionDefinitionConfiguration - Class in org.springframework.data.rest.core.config
-
Wrapper class to register projection definitions for later lookup by name and source type.
- ProjectionDefinitionConfiguration() - Constructor for class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Creates a new
ProjectionDefinitionConfiguration
. - ProjectionDefinitionRegistar - Class in org.springframework.data.rest.webmvc.config
-
BeanPostProcessor
to make sure all excerpt projections defined inRepositoryResourceMappings
are registered with theRepositoryRestConfiguration
. - ProjectionDefinitionRegistar(ObjectFactory<RepositoryRestConfiguration>) - Constructor for class org.springframework.data.rest.webmvc.config.ProjectionDefinitionRegistar
-
Creates a new
ProjectionDefinitionRegistar
for the givenRepositoryRestConfiguration
. - projectionDefinitionRegistrar(ObjectFactory<RepositoryRestConfiguration>) - Static method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ProjectionDefinitions - Interface in org.springframework.data.rest.core.projection
-
Interface to allow the lookup of a projection interface by source type and name.
- Projector - Interface in org.springframework.data.rest.webmvc.support
-
Interface for a component being able to create projections for objects.
- PropertyAwareResourceMapping - Interface in org.springframework.data.rest.core.mapping
R
- read(InputStream, T, ObjectMapper) - Method in class org.springframework.data.rest.webmvc.json.DomainObjectReader
-
Reads the given input stream into an
ObjectNode
and applies that to the given existing instance. - read(Class<? extends RepresentationModel<?>>, HttpInputMessage) - Method in class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
- readPut(ObjectNode, T, ObjectMapper) - Method in class org.springframework.data.rest.webmvc.json.DomainObjectReader
-
Reads the given source node onto the given target object and applies PUT semantics, i.e. explicitly
- reference - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- registerFormattingPatternFor(String, Class<?>) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Registers the given formatting patter for the given value type.
- registerJsonSchemaFormat(JsonSchemaFormat, Class<?>...) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
- rel() - Element in annotation interface org.springframework.data.rest.core.annotation.RestResource
-
The rel value to use when generating links to this resource.
- removeLeadingSlash(String) - Static method in class org.springframework.data.rest.core.support.ResourceStringUtils
-
Returns a string without the leading slash, if any.
- repoRequestArgumentResolver(Repositories, ResourceMetadataHandlerMethodArgumentResolver, RepositoryInvokerFactory) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
A convenience resolver that pulls together all the information needed to service a request.
- repositories() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- RepositoryConstraintViolationException - Exception in org.springframework.data.rest.core
-
Exception that is thrown when a Spring
Validator
throws an error. - RepositoryConstraintViolationException(Errors) - Constructor for exception org.springframework.data.rest.core.RepositoryConstraintViolationException
- RepositoryConstraintViolationExceptionMessage - Class in org.springframework.data.rest.webmvc.support
- RepositoryConstraintViolationExceptionMessage(RepositoryConstraintViolationException, MessageSourceAccessor) - Constructor for class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage
-
Creates a new
RepositoryConstraintViolationExceptionMessage
for the givenRepositoryConstraintViolationException
andMessageSourceAccessor
. - RepositoryConstraintViolationExceptionMessage.ValidationError - Class in org.springframework.data.rest.webmvc.support
- RepositoryController - Class in org.springframework.data.rest.webmvc
-
Controller for the root resource exposing links to the repository resources.
- RepositoryController(PagedResourcesAssembler<Object>, Repositories, EntityLinks, ResourceMappings) - Constructor for class org.springframework.data.rest.webmvc.RepositoryController
-
Creates a new
RepositoryController
for the givenPagedResourcesAssembler
,Repositories
,EntityLinks
andResourceMappings
. - RepositoryDetectionStrategy - Interface in org.springframework.data.rest.core.mapping
-
The strategy to determine whether a given repository is to be exported by Spring Data REST.
- RepositoryDetectionStrategy.RepositoryDetectionStrategies - Enum Class in org.springframework.data.rest.core.mapping
-
A variety of strategies to determine repository exposure.
- RepositoryEntityLinks - Class in org.springframework.data.rest.webmvc.support
-
EntityLinks
implementation that is able to createLink
for domain classes managed by Spring Data REST. - RepositoryEntityLinks(Repositories, ResourceMappings, RepositoryRestConfiguration, PagingAndSortingTemplateVariables, PluginRegistry<BackendIdConverter, Class<?>>) - Constructor for class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- RepositoryEntityLinks(Repositories, ResourceMappings, RepositoryRestConfiguration, Lazy<PagingAndSortingTemplateVariables>, PluginRegistry<BackendIdConverter, Class<?>>) - Constructor for class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- RepositoryEvent - Class in org.springframework.data.rest.core.event
-
Abstract base class for events emitted by the REST exporter.
- RepositoryEvent(Object) - Constructor for class org.springframework.data.rest.core.event.RepositoryEvent
- RepositoryEventHandler - Annotation Interface in org.springframework.data.rest.core.annotation
-
Advertises classes annotated with this that they are event handlers.
- repositoryExporterHandlerAdapter(List<HttpMessageConverter<?>>, AlpsJsonHttpMessageConverter, SelfLinkProvider, PersistentEntityResourceHandlerMethodArgumentResolver, RootResourceInformationHandlerMethodArgumentResolver, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Special
HandlerAdapter
that only recognizes handler methods defined in the provided controller classes. - repositoryInvokerFactory() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- RepositoryLinkBuilder - Class in org.springframework.data.rest.webmvc.support
-
LinkBuilder
to be able to create links pointing to repositories. - RepositoryLinkBuilder(ResourceMetadata, BaseUri) - Constructor for class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- RepositoryLinksResource - Class in org.springframework.data.rest.webmvc
-
Dedicated resource type to represent the links pointing to collection resources exposed for repositories.
- RepositoryLinksResource() - Constructor for class org.springframework.data.rest.webmvc.RepositoryLinksResource
- repositoryRelProvider(ObjectFactory<ResourceMappings>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- RepositoryRelProvider - Class in org.springframework.data.rest.core.support
-
A
LinkRelationProvider
based on theResourceMappings
for the registered repositories. - RepositoryRelProvider(ObjectFactory<ResourceMappings>) - Constructor for class org.springframework.data.rest.core.support.RepositoryRelProvider
-
Creates a new
RepositoryRelProvider
for the givenResourceMappings
. - RepositoryResourceMappings - Class in org.springframework.data.rest.core.mapping
-
Central abstraction obtain
ResourceMetadata
andResourceMapping
instances for domain types and repositories. - RepositoryResourceMappings(Repositories, PersistentEntities, RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.core.mapping.RepositoryResourceMappings
-
Creates a new
RepositoryResourceMappings
from the givenRepositoryRestConfiguration
,PersistentEntities
, andRepositories
. - repositoryRestConfiguration() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Main configuration for the REST exporter.
- RepositoryRestConfiguration - Class in org.springframework.data.rest.core.config
-
Spring Data REST configuration options.
- RepositoryRestConfiguration(ProjectionDefinitionConfiguration, MetadataConfiguration, EnumTranslationConfiguration) - Constructor for class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Creates a new
RepositoryRestConfiguration
with the givenProjectionDefinitionConfiguration
. - RepositoryRestConfigurer - Interface in org.springframework.data.rest.webmvc.config
-
Component to configure and customize the setup of Spring Data REST.
- RepositoryRestController - Annotation Interface in org.springframework.data.rest.webmvc
-
Annotation to demarcate Spring MVC controllers provided by Spring Data REST.
- RepositoryRestDispatcherServlet - Class in org.springframework.data.rest.webmvc
-
Special
DispatcherServlet
subclass that certain exporter components can recognize. - RepositoryRestDispatcherServlet() - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestDispatcherServlet
- RepositoryRestDispatcherServlet(WebApplicationContext) - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestDispatcherServlet
- repositoryRestExceptionHandler() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- RepositoryRestExceptionHandler - Class in org.springframework.data.rest.webmvc
-
Exception handler for Spring Data REST controllers.
- RepositoryRestExceptionHandler(MessageSource) - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestExceptionHandler
-
Creates a new
RepositoryRestExceptionHandler
using the givenMessageSource
. - RepositoryRestHandlerAdapter - Class in org.springframework.data.rest.webmvc
-
RequestMappingHandlerAdapter
implementation that adds a couple argument resolvers for controller method parameters used in the REST exporter controller. - RepositoryRestHandlerAdapter(List<HandlerMethodArgumentResolver>) - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestHandlerAdapter
-
Creates a new
RepositoryRestHandlerAdapter
using the givenHandlerMethodArgumentResolver
s. - RepositoryRestHandlerMapping - Class in org.springframework.data.rest.webmvc
-
RequestMappingHandlerMapping
implementation that will only find a handler method if aRepository
is exported under that URL path segment. - RepositoryRestHandlerMapping(ResourceMappings, RepositoryRestConfiguration) - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
-
Creates a new
RepositoryRestHandlerMapping
for the givenResourceMappings
andRepositoryRestConfiguration
. - RepositoryRestHandlerMapping(ResourceMappings, RepositoryRestConfiguration, Repositories) - Constructor for class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
-
Creates a new
RepositoryRestHandlerMapping
for the givenResourceMappings
RepositoryRestConfiguration
andRepositories
. - RepositoryRestMvcConfiguration - Class in org.springframework.data.rest.webmvc.config
-
Main application configuration for Spring Data REST.
- RepositoryRestMvcConfiguration(ApplicationContext, ObjectFactory<ConversionService>, ObjectProvider<LinkRelationProvider>, ObjectProvider<CurieProvider>, ObjectProvider<HalConfiguration>, ObjectProvider<ObjectMapper>, ObjectProvider<RepresentationModelProcessorInvoker>, ObjectProvider<MessageResolver>, ObjectProvider<GeoModule>, ObjectProvider<PathPatternParser>) - Constructor for class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- RepositoryRestResource - Annotation Interface in org.springframework.data.rest.core.annotation
-
Annotate a
Repository
with this to customize export mapping and rels. - RepositoryRestResource.None - Class in org.springframework.data.rest.core.annotation
- RepositorySearchesResource - Class in org.springframework.data.rest.webmvc
-
A custom
RepresentationModel
type to be able to write customRepresentationModelProcessor
s to add additional links to ones automatically exposed for Spring Data repository query methods. - ResolvableResourceDescriptionSupport - Class in org.springframework.data.rest.core.mapping
-
Adapter class for the
MessageSourceResolvable
part of aResourceDescription
. - ResolvableResourceDescriptionSupport() - Constructor for class org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport
- resolve(Method, NativeWebRequest) - Method in class org.springframework.data.rest.webmvc.support.DomainClassResolver
-
Resolves a domain class that is associated with the
NativeWebRequest
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.config.PersistentEntityResourceAssemblerArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.config.PersistentEntityResourceHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.config.ResourceMetadataHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.config.RootResourceInformationHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.json.MappingAwareDefaultedPageableArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.json.MappingAwarePageableArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.json.MappingAwareSortArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.ServerHttpRequestMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.support.BackendIdHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageableHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in class org.springframework.data.rest.webmvc.support.ETagArgumentResolver
- resolveArgument(MethodParameter, ModelAndViewContainer, NativeWebRequest, WebDataBinderFactory) - Method in enum class org.springframework.data.rest.webmvc.support.HttpMethodHandlerMethodArgumentResolver
- RESOURCE_PROFILE_MAPPING - Static variable in class org.springframework.data.rest.webmvc.ProfileController
- ResourceDescription - Interface in org.springframework.data.rest.core.mapping
-
A description of a resource.
- resourceLink(RootResourceInformation, EntityModel) - Method in class org.springframework.data.rest.webmvc.RepositoryController
- ResourceMapping - Class in org.springframework.data.rest.core.config
-
Deprecated.
- ResourceMapping - Interface in org.springframework.data.rest.core.mapping
-
Mapping information for components to be exported as REST resources.
- ResourceMapping() - Constructor for class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- ResourceMapping(Class<?>) - Constructor for class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- ResourceMapping(String, String) - Constructor for class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- ResourceMapping(String, String, boolean) - Constructor for class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- ResourceMappingConfiguration - Class in org.springframework.data.rest.core.config
-
Manages the
ResourceMapping
configurations for any resources being exported. - ResourceMappingConfiguration() - Constructor for class org.springframework.data.rest.core.config.ResourceMappingConfiguration
- resourceMappings(Repositories, PersistentEntities, RepositoryRestConfiguration) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ResourceMappings - Interface in org.springframework.data.rest.core.mapping
- ResourceMappingUtils - Class in org.springframework.data.rest.core.support
-
Deprecated.for removal in 3.5
- ResourceMappingUtils() - Constructor for class org.springframework.data.rest.core.support.ResourceMappingUtils
-
Deprecated.
- ResourceMetadata - Interface in org.springframework.data.rest.core.mapping
-
Interface for metadata of resources exposed through the system.
- resourceMetadataHandlerMethodArgumentResolver(Repositories, RepositoryResourceMappings, BaseUri) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- ResourceMetadataHandlerMethodArgumentResolver - Class in org.springframework.data.rest.webmvc.config
-
HandlerMethodArgumentResolver
to createResourceMetadata
instances. - ResourceMetadataHandlerMethodArgumentResolver(Repositories, ResourceMappings, BaseUri) - Constructor for class org.springframework.data.rest.webmvc.config.ResourceMetadataHandlerMethodArgumentResolver
-
Creates a new
ResourceMetadataHandlerMethodArgumentResolver
for the givenRepositories
andResourceMappings
. - ResourceNotFoundException - Exception in org.springframework.data.rest.webmvc
-
Indicates a resource was not found.
- ResourceNotFoundException() - Constructor for exception org.springframework.data.rest.webmvc.ResourceNotFoundException
- ResourceNotFoundException(String) - Constructor for exception org.springframework.data.rest.webmvc.ResourceNotFoundException
- ResourceNotFoundException(String, Throwable) - Constructor for exception org.springframework.data.rest.webmvc.ResourceNotFoundException
- ResourceStringUtils - Class in org.springframework.data.rest.core.support
-
Helper methods aiming at handling String representations of resources.
- ResourceStringUtils() - Constructor for class org.springframework.data.rest.core.support.ResourceStringUtils
- ResourceType - Enum Class in org.springframework.data.rest.core.mapping
-
An enum listing all supported resource types.
- RestControllerConfiguration - Class in org.springframework.data.rest.webmvc
-
Configuration class registering required
components
that declare request mappings asbeans
. - restHandlerMapping(Repositories, RepositoryResourceMappings, Optional<JpaHelper>, RepositoryRestConfiguration, CorsConfigurationAware) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
The
HandlerMapping
to delegate requests to Spring Data REST controllers. - RestMediaTypes - Class in org.springframework.data.rest.webmvc
-
Constants to refer to supported media types.
- RestMediaTypes() - Constructor for class org.springframework.data.rest.webmvc.RestMediaTypes
- RestResource - Annotation Interface in org.springframework.data.rest.core.annotation
-
Annotate a
Repository
with this to influence how it is exported and what the value of the rel attribute will be in links. - returnBodyOnCreate(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Whether to return a response body after creating an entity considering the given accept header.
- returnBodyOnUpdate(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Whether to return a response body after updating an entity considering the given accept header.
- RootResourceInformation - Class in org.springframework.data.rest.webmvc
-
Meta-information about the root repository resource.
- RootResourceInformation(ResourceMetadata, PersistentEntity<?, ?>, RepositoryInvoker) - Constructor for class org.springframework.data.rest.webmvc.RootResourceInformation
- RootResourceInformationHandlerMethodArgumentResolver - Class in org.springframework.data.rest.webmvc.config
-
HandlerMethodArgumentResolver
to createRootResourceInformation
for injection into Spring MVC controller methods. - RootResourceInformationHandlerMethodArgumentResolver(Repositories, RepositoryInvokerFactory, ResourceMetadataHandlerMethodArgumentResolver) - Constructor for class org.springframework.data.rest.webmvc.config.RootResourceInformationHandlerMethodArgumentResolver
-
Creates a new
RootResourceInformationHandlerMethodArgumentResolver
using the givenRepositories
,RepositoryInvokerFactory
andResourceMetadataHandlerMethodArgumentResolver
. - RootResourceInformationToAlpsDescriptorConverter - Class in org.springframework.data.rest.webmvc.alps
-
Converter to create Alps
Descriptor
instances for aRootResourceInformation
. - RootResourceInformationToAlpsDescriptorConverter(Associations, Repositories, PersistentEntities, EntityLinks, MessageResolver, RepositoryRestConfiguration, ObjectMapper, EnumTranslator) - Constructor for class org.springframework.data.rest.webmvc.alps.RootResourceInformationToAlpsDescriptorConverter
S
- SCHEMA_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- SCHEMA_JSON_VALUE - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- SearchResourceMappings - Class in org.springframework.data.rest.core.mapping
-
ResourceMapping
for all search resources. - SearchResourceMappings(List<MethodResourceMapping>) - Constructor for class org.springframework.data.rest.core.mapping.SearchResourceMappings
-
Creates a new
SearchResourceMappings
from the given - selfLinkProvider(PersistentEntities, RepositoryEntityLinks, ObjectProvider<ConversionService>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- SelfLinkProvider - Interface in org.springframework.data.rest.core.support
-
Component to create self links for entity instances.
- serialize(Enum, JsonGenerator, SerializerProvider) - Method in class org.springframework.data.rest.webmvc.json.JacksonSerializers.EnumTranslatingSerializer
- serialize(Object, JsonGenerator, SerializerProvider) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.LookupObjectSerializer
- serverHttpRequestMethodArgumentResolver() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
Turns an
HttpServletRequest
into aServerHttpRequest
. - ServerHttpRequestMethodArgumentResolver - Class in org.springframework.data.rest.webmvc
- ServerHttpRequestMethodArgumentResolver() - Constructor for class org.springframework.data.rest.webmvc.ServerHttpRequestMethodArgumentResolver
- setAlpsEnabled(boolean) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Configures whether to expose the ALPS resources.
- setBasePath(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Configures the base path to be used by Spring Data REST to expose repository resources.
- setBeanClassLoader(ClassLoader) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- setBeanFactory(BeanFactory) - Method in class org.springframework.data.rest.webmvc.support.JpaHelper
- setDefaultMediaType(MediaType) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the
MediaType
to use as a default when none is specified. - setDefaultPageSize(int) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the default size of
Pageable
s. - setEmbeddedValueResolver(StringValueResolver) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- setEmbeddedValueResolver(StringValueResolver) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- setEnableDefaultTranslation(boolean) - Method in interface org.springframework.data.rest.core.config.EnumTranslationConfiguration
-
Configures whether the default translation of enum names shall be applied.
- setEnableDefaultTranslation(boolean) - Method in class org.springframework.data.rest.webmvc.json.EnumTranslator
- setEnableEnumTranslation(boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Configures whether to enable enum value translation via the Spring Data REST default resource bundle.
- setExported(boolean) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- setExposeRepositoryMethodsByDefault(boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Sets whether to expose repository methods by default.
- setJpaHelper(JpaHelper) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerMapping
- setLimitParamName(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the name of the URL query string parameter that indicates how many results to return at once.
- setLinkRelationProvider(LinkRelationProvider) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Configures the
LinkRelationProvider
to be used to calculate theLinkRelation
defaults for repositories. - setMaxPageSize(int) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the maximum size of pages.
- setOmitUnresolvableDescriptionKeys(boolean) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
-
Configures whether to omit documentation attributes for unresolvable resource bundle keys.
- setPageParamName(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the name of the URL query string parameter that indicates what page to return.
- setParameterName(String) - Method in class org.springframework.data.rest.core.config.ProjectionDefinitionConfiguration
-
Configures the request parameter name to be used to accept the projection name to be returned.
- setParseEnumNameAsFallback(boolean) - Method in interface org.springframework.data.rest.core.config.EnumTranslationConfiguration
-
Configures whether to always accept the raw enum name when parsing.
- setParseEnumNameAsFallback(boolean) - Method in class org.springframework.data.rest.webmvc.json.EnumTranslator
- setPath(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- setRel(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- setRelProvider(LinkRelationProvider) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.since 3.5, use
RepositoryRestConfiguration.setLinkRelationProvider(LinkRelationProvider)
instead. - setRepositoryDetectionStrategy(RepositoryDetectionStrategy) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Configures the
RepositoryDetectionStrategy
to be used to determine which repositories get exposed. - setResourceMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
- setResourceMappingForDomainType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- setResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Deprecated.for removal in 3.5
- setReturnBodyForPutAndPost(Boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Convenience method to activate returning response bodies for all
PUT
andPOST
requests, i.e. both creating and updating entities. - setReturnBodyOnCreate(Boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set whether to return a response body after creating an entity.
- setReturnBodyOnUpdate(Boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set whether to return a response body after updating an entity.
- setSortParamName(String) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Set the name of the URL query string parameter that indicates what direction to sort results.
- setValidators(Map<String, Collection<Validator>>) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
-
Assign a Map of
Validator
s that are assigned to the variousRepositoryEvent
s. - SimpleRelProvider - Class in org.springframework.data.rest.core.support
- SimpleRelProvider() - Constructor for class org.springframework.data.rest.core.support.SimpleRelProvider
- SimpleResourceDescription - Class in org.springframework.data.rest.core.mapping
- SimpleResourceDescription(String, MediaType) - Constructor for class org.springframework.data.rest.core.mapping.SimpleResourceDescription
-
Creates a new
SimpleResourceDescription
with the given message andMediaType
. - size() - Method in class org.springframework.data.rest.webmvc.json.patch.Patch
- slash(Object) - Method in class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- slash(String) - Method in class org.springframework.data.rest.core.Path
- slash(PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- slash(Path) - Method in class org.springframework.data.rest.core.Path
- sortResolver() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
- SortTranslator(PersistentEntities, ObjectMapper, Associations) - Constructor for class org.springframework.data.rest.webmvc.json.JacksonMappingAwareSortTranslator.SortTranslator
- SPRING_DATA_COMPACT_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- SPRING_DATA_COMPACT_JSON_VALUE - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- SPRING_DATA_VERBOSE_JSON - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- StaticResourceProvider - Interface in org.springframework.data.rest.webmvc.config
-
SPI to be able to register extensions that add static resource routes.
- StringToLdapNameConverter - Enum Class in org.springframework.data.rest.core
- SupportedHttpMethods - Interface in org.springframework.data.rest.core.mapping
-
An API to discover the
HttpMethod
s supported on a givenResourceType
. - SupportedHttpMethods.NoSupportedMethods - Enum Class in org.springframework.data.rest.core.mapping
-
Null object to abstract the absence of any support for any HTTP method.
- supports(Class<?>) - Method in class org.springframework.data.rest.core.support.EntityLookupSupport
- supports(Class<?>) - Method in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
- supports(Class<?>) - Method in class org.springframework.data.rest.webmvc.support.RepositoryEntityLinks
- supports(MethodParameter, Class<? extends HttpMessageConverter<?>>) - Method in class org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter
- supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.data.rest.core.support.RepositoryRelProvider
- supports(LinkRelationProvider.LookupContext) - Method in class org.springframework.data.rest.core.support.SimpleRelProvider
- supportsInternal(HandlerMethod) - Method in class org.springframework.data.rest.webmvc.RepositoryRestHandlerAdapter
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.config.PersistentEntityResourceAssemblerArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.config.PersistentEntityResourceHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.config.ResourceMetadataHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.config.RootResourceInformationHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.json.MappingAwareDefaultedPageableArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.json.MappingAwarePageableArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.json.MappingAwareSortArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.ServerHttpRequestMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.support.BackendIdHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageableHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.data.rest.webmvc.support.ETagArgumentResolver
- supportsParameter(MethodParameter) - Method in enum class org.springframework.data.rest.webmvc.support.HttpMethodHandlerMethodArgumentResolver
T
- TEXT_URI_LIST - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- TEXT_URI_LIST_VALUE - Static variable in class org.springframework.data.rest.webmvc.RestMediaTypes
- toCollectionModel(Iterable<?>, PersistentEntityResourceAssembler, Class<?>, Optional<Link>) - Method in class org.springframework.data.rest.webmvc.RepositoryController
- toEmptyResponse(HttpStatus) - Static method in class org.springframework.data.rest.webmvc.ControllerUtils
-
Return an empty response that is only comprised of a status
- toEmptyResponse(HttpStatus, HttpHeaders) - Static method in class org.springframework.data.rest.webmvc.ControllerUtils
-
Return an empty response that is only comprised of headers and a status
- toFullResource(Object) - Method in class org.springframework.data.rest.webmvc.PersistentEntityResourceAssembler
-
Returns the full object as
PersistentEntityResource
using the underlyingProjector
. - toMap(MultiValueMap<K, V>) - Static method in interface org.springframework.data.rest.core.util.MapUtils
-
Turns a
MultiValueMap
into itsMap
equivalent. - toModel(Object) - Method in class org.springframework.data.rest.webmvc.PersistentEntityResourceAssembler
- toRequestId(Serializable, Class<?>) - Method in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
- toRequestId(Serializable, Class<?>) - Method in interface org.springframework.data.rest.webmvc.spi.BackendIdConverter
-
Returns the id to be used in the URI generated to point to an entity of the given type with the given id.
- toResponseEntity(HttpStatus, HttpHeaders, Optional<R>) - Static method in class org.springframework.data.rest.webmvc.ControllerUtils
- toResponseEntity(HttpStatus, HttpHeaders, R) - Static method in class org.springframework.data.rest.webmvc.ControllerUtils
-
Wrap a resource as a
ResponseEntity
and attach given headers and status. - toSet() - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
-
Returns an unmodifiable
Set
of all underlyingHttpMethod
s. - toString() - Method in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- toString() - Method in class org.springframework.data.rest.core.config.ResourceMapping
-
Deprecated.
- toString() - Method in class org.springframework.data.rest.core.Path
- toString() - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
- toString() - Method in class org.springframework.data.rest.webmvc.support.ETag
- toString() - Method in class org.springframework.data.rest.webmvc.support.RepositoryConstraintViolationExceptionMessage.ValidationError
- translateSort(Sort, MethodParameter, NativeWebRequest) - Method in class org.springframework.data.rest.webmvc.json.JacksonMappingAwareSortTranslator
-
Translates Jackson field names within a
Sort
toPersistentProperty
property names. - translateSort(Sort, PersistentEntity<?, ?>) - Method in class org.springframework.data.rest.webmvc.json.JacksonMappingAwareSortTranslator.SortTranslator
-
Translates
Sort
orders from Jackson-mapped field names toPersistentProperty
names. - type - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- TypedResourceDescription - Class in org.springframework.data.rest.core.mapping
-
SimpleResourceDescription
that additionally captures a type to be able to potentially create a reasonable default message. - types() - Element in annotation interface org.springframework.data.rest.core.config.Projection
-
The type the projection type is bound to.
U
- uniqueItems - Variable in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
- unpagedIfDefault() - Method in class org.springframework.data.rest.webmvc.support.DefaultedPageable
-
Returns
Pageable.unpaged()
if the containedPageable
is the default one. - UnwrappingRepositoryInvokerFactory - Class in org.springframework.data.rest.core.support
-
RepositoryInvokerFactory
that wraps theRepositoryInvokerFactory
returned by the delegate with one that automatically unwraps JDK 8Optional
and GuavaOptional
s. - UnwrappingRepositoryInvokerFactory(RepositoryInvokerFactory, List<? extends EntityLookup<?>>) - Constructor for class org.springframework.data.rest.core.support.UnwrappingRepositoryInvokerFactory
- updateBuilder(DeserializationConfig, BeanDescription, BeanDeserializerBuilder) - Method in class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.AssociationUriResolvingDeserializerModifier
- URI - Enum constant in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
- uriListHttpMessageConverter() - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
The
HttpMessageConverter
used to create text/uri-list responses. - UriListHttpMessageConverter - Class in org.springframework.data.rest.webmvc.convert
-
Converter
to render allLink
s contained in aRepresentationModel
astext/uri-list
and parse a request of that media type back into aRepresentationModel
instance. - UriListHttpMessageConverter() - Constructor for class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
- UriStringDeserializer(Class<?>, UriToEntityConverter) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityJackson2Module.UriStringDeserializer
-
Creates a new
PersistentEntityJackson2Module.UriStringDeserializer
for the givenPersistentProperty
using the givenUriToEntityConverter
. - UriToEntityConverter - Class in org.springframework.data.rest.core
-
A
GenericConverter
that can convert aURI
into an entity. - UriToEntityConverter(PersistentEntities, RepositoryInvokerFactory, Repositories) - Constructor for class org.springframework.data.rest.core.UriToEntityConverter
-
Creates a new
UriToEntityConverter
using the givenPersistentEntities
,RepositoryInvokerFactory
andRepositories
. - UriUtils - Class in org.springframework.data.rest.webmvc.util
-
Utility methods to work with requests and URIs.
- useHalAsDefaultJsonMediaType() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns whether HAL will be served as primary representation in case on
application/json
is requested. - useHalAsDefaultJsonMediaType(boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Configures whether HAL will be served as primary representation in case on
application/json
is requested.
V
- validatingRepositoryEventListener(ObjectFactory<PersistentEntities>) - Method in class org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration
-
ApplicationListener
implementation for invokingValidator
instances assigned to specific domain types. - ValidatingRepositoryEventListener - Class in org.springframework.data.rest.core.event
- ValidatingRepositoryEventListener(ObjectFactory<PersistentEntities>) - Constructor for class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
-
Creates a new
ValidatingRepositoryEventListener
using the given repositories. - ValidationErrors - Class in org.springframework.data.rest.core
-
An
Errors
implementation for use in the events mechanism of Spring Data REST. - ValidationErrors(Object, PersistentEntities) - Constructor for class org.springframework.data.rest.core.ValidationErrors
-
Creates a new
ValidationErrors
instance for the given source object andPersistentEntity
. - value - Variable in class org.springframework.data.rest.webmvc.json.patch.PatchOperation
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.Description
-
The textual description of the resource.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleAfterCreate
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleAfterDelete
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleAfterLinkDelete
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleAfterLinkSave
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleAfterSave
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleBeforeCreate
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleBeforeDelete
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleBeforeLinkDelete
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleBeforeLinkSave
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.HandleBeforeSave
-
Deprecated.the domain type of interest is derived from the type of the first parameter of the annotated handler method.
- value() - Element in annotation interface org.springframework.data.rest.core.annotation.RepositoryEventHandler
-
Deprecated.the type the handler is interested in is determined by the type of the first parameter of a handler method.
- value() - Element in annotation interface org.springframework.data.rest.webmvc.BasePathAwareController
-
The root path to be prepended to all request mappings configured on handler methods.
- value() - Element in annotation interface org.springframework.data.rest.webmvc.RepositoryRestController
-
The root path to be prepended to all request mappings configured on handler methods.
- valueOf(String) - Static method in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.core.mapping.ResourceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.core.StringToLdapNameConverter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.data.rest.webmvc.support.HttpMethodHandlerMethodArgumentResolver
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.data.rest.core.config.JsonSchemaFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.core.mapping.ResourceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.core.StringToLdapNameConverter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.webmvc.spi.BackendIdConverter.DefaultIdConverter
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.data.rest.webmvc.support.HttpMethodHandlerMethodArgumentResolver
-
Returns an array containing the constants of this enum class, in the order they are declared.
- ValueTypeSchemaPropertyCustomizerFactory(RepositoryInvokerFactory) - Constructor for class org.springframework.data.rest.webmvc.json.PersistentEntityToJsonSchemaConverter.ValueTypeSchemaPropertyCustomizerFactory
- verify(PersistentEntity<?, ?>, Object) - Method in class org.springframework.data.rest.webmvc.support.ETag
-
Verifies the ETag to be created for the given target bean with the current one and raises a
ETagDoesntMatchException
in case they don't match. - verifyPutForCreation() - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
- verifySupportedMethod(HttpMethod, PersistentProperty<?>) - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
-
Verifies that the given
HttpMethod
is supported for the givenPersistentProperty
. - verifySupportedMethod(HttpMethod, ResourceType) - Method in class org.springframework.data.rest.webmvc.RootResourceInformation
-
Verifies that the given
HttpMethod
is supported for the givenResourceType
. - VISIBILITY - Enum constant in enum class org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
-
Considers the repository interface's visibility, which means only public interfaces will be exposed.
W
- with(TypeInformation<?>) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Configures the
JsonSchema.JsonSchemaProperty
to reflect the given type. - withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
- withAssociationExposure(ExposureConfigurer.AssociationResourceHttpMethodsFilter) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer
-
Registers the given
ExposureConfigurer.AssociationResourceHttpMethodsFilter
. - withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
- withCollectionExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer
-
Registers the given
ExposureConfigurer.AggregateResourceHttpMethodsFilter
to be used for collection resources. - withConfig(BiConsumer<RepositoryRestConfiguration, CorsRegistry>) - Static method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Convenience method to easily create simple
RepositoryRestConfigurer
instances that solely want to tweak theRepositoryRestConfiguration
. - withConfig(Consumer<RepositoryRestConfiguration>) - Static method in interface org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer
-
Convenience method to easily create simple
RepositoryRestConfigurer
instances that solely want to tweak theRepositoryRestConfiguration
. - withEmbedded(Iterable<EmbeddedWrapper>) - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
-
Configures the builder to embed the given
EmbeddedWrapper
instances. - withEntityLookup() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
-
Returns the
EntityLookupRegistrar
to create customEntityLookup
instances registered in the configuration. - withFormat(JsonSchemaFormat) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Configures the given
JsonSchemaFormat
to be exposed on the currentJsonSchema.JsonSchemaProperty
. - withIdMapping(Converter<T, ID>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar.IdMappingRegistrar
-
Registers the given
Converter
to map the entity to its identifying property. - withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
- withItemExposure(ExposureConfigurer.AggregateResourceHttpMethodsFilter) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer
-
Registers the given
ExposureConfigurer.AggregateResourceHttpMethodsFilter
to be used for item resources. - withLink(Link) - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
-
Adds the given
Link
to thePersistentEntityResource
. - withLinks(List<Link>) - Method in class org.springframework.data.rest.webmvc.PersistentEntityResource.Builder
- withLookup(EntityLookupRegistrar.LookupRegistrar.Lookup<R, ID>) - Method in interface org.springframework.data.rest.core.config.EntityLookupRegistrar.LookupRegistrar
-
Registers the given
EntityLookupRegistrar.LookupRegistrar.Lookup
to obtain entity instances. - withPattern(Pattern) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Configures the
JsonSchema.JsonSchemaProperty
to require the givenPattern
. - withReadOnly() - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
- withRegex(String) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Configures the
JsonSchema.JsonSchemaProperty
to require the given regular expression as pattern. - withResourceRel() - Method in class org.springframework.data.rest.webmvc.support.RepositoryLinkBuilder
- withType(Class<?>) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.JsonSchemaProperty
-
Configures the
JsonSchema.JsonSchemaProperty
to reflect the given type. - withValues(List<String>) - Method in class org.springframework.data.rest.webmvc.json.JsonSchema.EnumProperty
-
Returns the current
JsonSchema.EnumProperty
exposing the given values. - write(RepresentationModel<?>, MediaType, HttpOutputMessage) - Method in class org.springframework.data.rest.webmvc.convert.UriListHttpMessageConverter
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form