Skip navigation links
Spring Data REST - Core
A B C D E F G H I J L M N O P R S T U V W 

A

AbstractRepositoryEventListener<T> - Class in org.springframework.data.rest.core.event
Abstract class that listens for generic RepositoryEvents 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.
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.
 
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
 
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
 
ALL - Static variable in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
 
allowsPutForCreation() - Method in class org.springframework.data.rest.core.mapping.ConfigurationApplyingSupportedHttpMethodsAdapter
 
allowsPutForCreation(ResourceMetadata) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
Returns whether PUT is supported for the given ResourceMetadata.
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 org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
 
alpsEnabled() - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
Returns whether the ALPS resources are exposed.
and(HttpMethod...) - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
Returns a new HttpMethods with the given HttpMethods added.
AnnotatedEventHandlerInvoker - Class in org.springframework.data.rest.core.event
Component to discover annotated repository event handlers and trigger them on ApplicationEvents.
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 a Description annotation.
AnnotationBasedResourceDescription(Description, ResourceDescription) - Constructor for class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
Creates a new AnnotationBasedResourceDescription for the given Description and fallback.
AnnotationBasedResourceDescription(Class<?>, ResourceDescription) - Constructor for class org.springframework.data.rest.core.mapping.AnnotationBasedResourceDescription
 

B

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
 
butWithout(HttpMethod...) - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
Returns a new HttpMethods instance with the given HttpMethods removed.

C

CollectionResourceMapping - Interface in org.springframework.data.rest.core.mapping
A custom resource mapping for collection resources.
ConfigurableHttpMethods - Class in org.springframework.data.rest.core.mapping
HttpMethods that expose methods to create different ConfigurableHttpMethods.
ConfigurationApplyingSupportedHttpMethodsAdapter - Class in org.springframework.data.rest.core.mapping
Adapter for a SupportedHttpMethods instance that applies settings made through ExposureConfiguration to the calculated ConfigurableHttpMethods
ConfigurationApplyingSupportedHttpMethodsAdapter(ExposureConfiguration, ResourceMetadata, SupportedHttpMethods) - Constructor for class org.springframework.data.rest.core.mapping.ConfigurationApplyingSupportedHttpMethodsAdapter
 
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 current HttpMethods.
convert(String) - Method in enum org.springframework.data.rest.core.StringToLdapNameConverter
 
convert(Object, TypeDescriptor, TypeDescriptor) - Method in class org.springframework.data.rest.core.UriToEntityConverter
 
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 a CrudMethods instance.
CrudMethodsSupportedHttpMethods(CrudMethods, boolean) - Constructor for class org.springframework.data.rest.core.mapping.CrudMethodsSupportedHttpMethods
Creates a new CrudMethodsSupportedHttpMethods for the given CrudMethods.

D

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
 
defaultFor(String) - Static method in class org.springframework.data.rest.core.mapping.SimpleResourceDescription
 
defaultFor(String, PersistentProperty<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
 
defaultFor(String, String, Class<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
 
defaultFor(String, Class<?>) - Static method in class org.springframework.data.rest.core.mapping.TypedResourceDescription
 
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<?>>) - Constructor for class org.springframework.data.rest.core.support.DefaultSelfLinkProvider
Creates a new DefaultSelfLinkProvider from the PersistentEntities, EntityLinks and EntityLookups.
Description - Annotation Type in org.springframework.data.rest.core.annotation
Annotation to describe semantics of a resource.
disable(HttpMethod...) - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
Disables the given HttpMethods.
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.

E

empty() - Static method in class org.springframework.data.rest.core.util.Java8PluginRegistry
 
enable(HttpMethod...) - Method in class org.springframework.data.rest.core.mapping.ConfigurableHttpMethods
Enables the given HttpMethods.
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 EntityLookups 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.
EnumTranslationConfiguration - Interface in org.springframework.data.rest.core.config
Configuration options for enum value translation.
equals(Object) - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
 
equals(Object) - Method in class org.springframework.data.rest.core.Path
 
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
 
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.

F

filter(ResourceMetadata, ConfigurableHttpMethods) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AggregateResourceHttpMethodsFilter
 
filter(PropertyAwareResourceMapping, ConfigurableHttpMethods) - Method in interface org.springframework.data.rest.core.mapping.ExposureConfigurer.AssociationResourceHttpMethodsFilter
 
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.
 
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
 
findTypeForPath(String) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
 
forDomainType(Class<?>) - Method in class org.springframework.data.rest.core.mapping.ExposureConfiguration
Returns a ExposureConfigurer to allow the registration of type specific AggregateResourceHttpMethodsFilter and AssociationResourceHttpMethodsFilters 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.
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.

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
The base URI against which the exporter should calculate its links.
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
 
getConvertibleTypes() - Method in class org.springframework.data.rest.core.UriToEntityConverter
 
getCorsConfigurations() - Method in class org.springframework.data.rest.core.config.RepositoryCorsRegistry
 
getCorsRegistry() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Returns the RepositoryCorsRegistry to configure Cross-origin resource sharing.
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 Pageables.
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
 
getDomainType() - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
Returns the domain type that is exposed through the resource.
getDomainTypesResourceMappingConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Get the ResourceMappingConfiguration that is currently configured.
getEntityLookups(Repositories) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Returns all EntityLookups 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
 
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.
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(String) - 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
 
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.
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 given PersistentProperty or null if not managed.
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
 
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.
getMethod() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
Returns the Method backing the resource.
getMethodsFor(ResourceType) - Method in class org.springframework.data.rest.core.mapping.ConfigurationApplyingSupportedHttpMethodsAdapter
 
getMethodsFor(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.ConfigurationApplyingSupportedHttpMethodsAdapter
 
getMethodsFor(ResourceType) - Method in class org.springframework.data.rest.core.mapping.CrudMethodsSupportedHttpMethods
 
getMethodsFor(PersistentProperty<?>) - 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 HttpMethods for the given ResourceType.
getMethodsFor(PersistentProperty<?>) - Method in interface org.springframework.data.rest.core.mapping.SupportedHttpMethods
Returns the supported HttpMethods for the given PersistentProperty.
getMethodsFor(ResourceType) - Method in enum org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
 
getMethodsFor(PersistentProperty<?>) - Method in enum 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.
getNameForPath(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
Deprecated.
 
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.
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
 
getPatternFor(Class<?>) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
Returns the Pattern registered for the given value type.
getPluginFor(S) - Method in class org.springframework.data.rest.core.util.Java8PluginRegistry
 
getPluginOrDefaultFor(S, T) - Method in class org.springframework.data.rest.core.util.Java8PluginRegistry
 
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(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
 
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
The RelProvider to be used to calculate the link relation defaults for repositories.
getRepositoryDetectionStrategy() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Returns the RepositoryDetectionStrategy to be used to decide which repositories get exposed.
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, RepositoryInformation) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
Deprecated.
 
getResourceMapping(RepositoryRestConfiguration, PersistentEntity<?, ?>) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
Deprecated.
 
getResourceMappingFor(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
Deprecated.
 
getResourceMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
 
getResourceMappingForDomainType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Get the ResourceMapping for a specific domain type.
getResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Get the ResourceMapping for a specific repository interface.
getResourceMappings() - Method in class org.springframework.data.rest.core.config.ResourceMapping
Deprecated.
 
getReturnedDomainType() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
Returns the domain type that the query method returns.
getSchemaFormatFor(Class<?>) - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
Returns the JsonSchemaFormat to be used for the given type.
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 ResourceMappings for the search resources of the given type.
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.
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.
getSupportedHttpMethods() - Method in interface org.springframework.data.rest.core.mapping.ResourceMetadata
Returns the supported HttpMethods for the given ResourceType.
getTarget() - Method in class org.springframework.data.rest.core.ValidationErrors
 
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
 

H

HandleAfterCreate - Annotation Type in org.springframework.data.rest.core.annotation
 
HandleAfterDelete - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the afterDelete event.
HandleAfterLinkDelete - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the afterLinkDelete event.
HandleAfterLinkSave - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the afterLinkSave event.
HandleAfterSave - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the afterSave event.
HandleBeforeCreate - Annotation Type in org.springframework.data.rest.core.annotation
 
HandleBeforeDelete - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the beforeDelete event.
HandleBeforeLinkDelete - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the beforeLinkDelete event.
HandleBeforeLinkSave - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the beforeLinkSave event.
HandleBeforeSave - Annotation Type in org.springframework.data.rest.core.annotation
Denotes a component that should handle the beforeSave event.
hashCode() - Method in class org.springframework.data.rest.core.mapping.ParameterMetadata
 
hashCode() - Method in class org.springframework.data.rest.core.Path
 
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(String) - Method in class org.springframework.data.rest.core.config.ResourceMapping
Deprecated.
 
hasResourceMappingFor(Class<?>) - Method in class org.springframework.data.rest.core.config.ResourceMappingConfiguration
 
hasResourceMappingForDomainType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Whether there is a ResourceMapping for the given domain type.
hasResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Whether there is a ResourceMapping configured for this Repository class.
hasTextExceptSlash(CharSequence) - Static method in class org.springframework.data.rest.core.support.ResourceStringUtils
Checks whether the given input contains actual text (slash excluded).
HttpMethods - Interface in org.springframework.data.rest.core.mapping
A collection of HttpMethods with some convenience methods to create alternate sets of those.

I

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
 
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(RepositoryMetadata) - Method in interface org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy
Returns whether the repository described by the given RepositoryMetadata is exported or not.
isExported() - Method in interface org.springframework.data.rest.core.mapping.ResourceMapping
Returns whether the component shall be exported at all.
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() - Method in class org.springframework.data.rest.core.mapping.SearchResourceMappings
 
isIdExposedFor(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Should we expose the ID property for this domain type?
isLookupType(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
 
isMapped(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
 
isMapped(PersistentProperty<?>) - Method in class org.springframework.data.rest.core.mapping.RepositoryResourceMappings
 
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
 
isReturnBodyOnCreate() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
isReturnBodyOnUpdate() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
isSortableResource() - Method in interface org.springframework.data.rest.core.mapping.MethodResourceMapping
Returns whether the resource is sortable.
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
 

J

Java8PluginRegistry<T extends org.springframework.plugin.core.Plugin<S>,S> - Class in org.springframework.data.rest.core.util
 
Java8PluginRegistry(PluginRegistry<T, S>) - Constructor for class org.springframework.data.rest.core.util.Java8PluginRegistry
 
JsonSchemaFormat - Enum in org.springframework.data.rest.core.config
An enum to represent JSON Schema pre-defined formats.

L

LinkedEntityEvent - Class in org.springframework.data.rest.core.event
Base class for RepositoryEvents 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.
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.

M

MapUtils - Interface in org.springframework.data.rest.core.util
Helper methods to work with Maps.
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
 
merge(Method, ResourceMapping) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
Deprecated.
 
merge(Class<?>, ResourceMapping) - Static method in class org.springframework.data.rest.core.support.ResourceMappingUtils
Deprecated.
 
MetadataConfiguration - Class in org.springframework.data.rest.core.config
Configuration for metadata exposure.
MetadataConfiguration() - Constructor for class org.springframework.data.rest.core.config.MetadataConfiguration
 
metadataConfiguration() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Deprecated.
MethodResourceMapping - Interface in org.springframework.data.rest.core.mapping
A ResourceMapping that is backed by a Method.

N

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 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
 

O

of(Collection<HttpMethod>) - Static method in interface org.springframework.data.rest.core.mapping.HttpMethods
Returns a new HttpMethods with the given HttpMethods.
of(List<? extends T>) - Static method in class org.springframework.data.rest.core.util.Java8PluginRegistry
 
of(PluginRegistry<T, S>) - Static method in class org.springframework.data.rest.core.util.Java8PluginRegistry
 
omitUnresolvableDescriptionKeys() - Method in class org.springframework.data.rest.core.config.MetadataConfiguration
Returns whether to omit documentation attributes for unresolvable resource bundle keys.
onAfterCreate(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in afterCreate events.
onAfterCreate(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.
onAfterDelete(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
 
onAfterLinkDelete(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in afterLinkDelete events.
onAfterLinkSave(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in afterLinkSave events.
onAfterLinkSave(Object, 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.
onAfterSave(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
 
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(T) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in beforeCreate events.
onBeforeCreate(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.
onBeforeDelete(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
 
onBeforeLinkDelete(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in beforeLinkDelete events.
onBeforeLinkSave(T, Object) - Method in class org.springframework.data.rest.core.event.AbstractRepositoryEventListener
Override this method if you are interested in beforeLinkSave events.
onBeforeLinkSave(Object, 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.
onBeforeSave(Object) - Method in class org.springframework.data.rest.core.event.ValidatingRepositoryEventListener
 
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
 

P

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 given MethodParameter and base rel.
ParametersMetadata - Class in org.springframework.data.rest.core.mapping
Value object for a list of ParameterMetadata instances.
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
Creates a new Path from the given String.
PersistentEntitiesResourceMappings - Class in org.springframework.data.rest.core.mapping
PersistentEntitiesResourceMappings(PersistentEntities) - Constructor for class org.springframework.data.rest.core.mapping.PersistentEntitiesResourceMappings
postProcessAfterInitialization(Object, String) - Method in class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
 
postProcessBeforeInitialization(Object, String) - Method in class org.springframework.data.rest.core.event.AnnotatedEventHandlerInvoker
 
Projection - Annotation Type 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
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
ProjectionDefinitions - Interface in org.springframework.data.rest.core.projection
Interface to allow the lookup of a projection interface by source type and name.
PropertyAwareResourceMapping - Interface in org.springframework.data.rest.core.mapping
 

R

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
 
removeLeadingSlash(String) - Static method in class org.springframework.data.rest.core.support.ResourceStringUtils
Returns a string without the leading slash, if any.
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
 
RepositoryCorsRegistry - Class in org.springframework.data.rest.core.config
Spring Data REST specific CorsRegistry implementation exposing RepositoryCorsRegistry.getCorsConfigurations().
RepositoryCorsRegistry() - Constructor for class org.springframework.data.rest.core.config.RepositoryCorsRegistry
 
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 in org.springframework.data.rest.core.mapping
A variety of strategies to determine repository exposure.
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 Type in org.springframework.data.rest.core.annotation
Advertises classes annotated with this that they are event handlers.
RepositoryRelProvider - Class in org.springframework.data.rest.core.support
A RelProvider based on the ResourceMappings for the registered repositories.
RepositoryRelProvider(ObjectFactory<ResourceMappings>) - Constructor for class org.springframework.data.rest.core.support.RepositoryRelProvider
Creates a new RepositoryRelProvider for the given ResourceMappings.
RepositoryResourceMappings - Class in org.springframework.data.rest.core.mapping
Central abstraction obtain ResourceMetadata and ResourceMapping 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 given RepositoryRestConfiguration, Repositories and RelProvider.
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
RepositoryRestResource - Annotation Type 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
 
ResolvableResourceDescriptionSupport - Class in org.springframework.data.rest.core.mapping
Adapter class for the MessageSourceResolvable part of a ResourceDescription.
ResolvableResourceDescriptionSupport() - Constructor for class org.springframework.data.rest.core.mapping.ResolvableResourceDescriptionSupport
 
ResourceDescription - Interface in org.springframework.data.rest.core.mapping
A description of a resource.
ResourceMapping - Class in org.springframework.data.rest.core.config
Deprecated.
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.
 
ResourceMapping - Interface in org.springframework.data.rest.core.mapping
Mapping information for components to be exported as REST resources.
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 - Interface in org.springframework.data.rest.core.mapping
 
ResourceMappingUtils - Class in org.springframework.data.rest.core.support
Deprecated.
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.
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 in org.springframework.data.rest.core.mapping
An enum listing all supported resource types.
RestResource - Annotation Type 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.

S

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 - Interface in org.springframework.data.rest.core.support
Component to create self links for entity instances.
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.
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 Pageables.
setEnableDefaultTranslation(boolean) - Method in interface org.springframework.data.rest.core.config.EnumTranslationConfiguration
Configures whether the default translation of enum names shall be applied.
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.
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.
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.
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(RelProvider) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
The RelProvider to be used to calculate the link relation defaults for repositories.
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
Start configuration a ResourceMapping for a specific domain type.
setResourceMappingForRepository(Class<?>) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Start configuration a ResourceMapping for a specific repository interface.
setReturnBodyForPutAndPost(Boolean) - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Convenience method to activate returning response bodies for all PUT and POST 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 Validators that are assigned to the various RepositoryEvents.
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 and MediaType.
slash(String) - Method in class org.springframework.data.rest.core.Path
Appends the given String to the current Path.
slash(Path) - Method in class org.springframework.data.rest.core.Path
 
StringToLdapNameConverter - Enum in org.springframework.data.rest.core
Converter to convert a String to a LdapName.
SupportedHttpMethods - Interface in org.springframework.data.rest.core.mapping
An API to discover the HttpMethods supported on a given ResourceType.
SupportedHttpMethods.NoSupportedMethods - Enum 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 class org.springframework.data.rest.core.support.RepositoryRelProvider
 
supports(Class<?>) - Method in class org.springframework.data.rest.core.support.SimpleRelProvider
 

T

toMap(MultiValueMap<K, V>) - Static method in interface org.springframework.data.rest.core.util.MapUtils
Turns a MultiValueMap into its Map equivalent.
toSet() - Method in interface org.springframework.data.rest.core.mapping.HttpMethods
Returns an unmodifiable Set of all underlying HttpMethods.
toString() - Method in enum 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
 
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.

U

UnwrappingRepositoryInvokerFactory - Class in org.springframework.data.rest.core.support
RepositoryInvokerFactory that wraps the RepositoryInvokerFactory returned by the delegate with one that automatically unwraps JDK 8 Optional and Guava com.google.common.base.Optionals.
UnwrappingRepositoryInvokerFactory(RepositoryInvokerFactory, List<? extends EntityLookup<?>>) - Constructor for class org.springframework.data.rest.core.support.UnwrappingRepositoryInvokerFactory
 
UriToEntityConverter - Class in org.springframework.data.rest.core
A GenericConverter that can convert a URI into an entity.
UriToEntityConverter(PersistentEntities, RepositoryInvokerFactory, Repositories) - Constructor for class org.springframework.data.rest.core.UriToEntityConverter
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 - Class in org.springframework.data.rest.core.event
ApplicationListener implementation that dispatches RepositoryEvents to a specific Validator.
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 and PersistentEntity.
valueOf(String) - Static method in enum org.springframework.data.rest.core.config.JsonSchemaFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.data.rest.core.mapping.ResourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.springframework.data.rest.core.StringToLdapNameConverter
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.springframework.data.rest.core.config.JsonSchemaFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.data.rest.core.mapping.RepositoryDetectionStrategy.RepositoryDetectionStrategies
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.data.rest.core.mapping.ResourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.data.rest.core.mapping.SupportedHttpMethods.NoSupportedMethods
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.springframework.data.rest.core.StringToLdapNameConverter
Returns an array containing the constants of this enum type, in the order they are declared.

W

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
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.
withEntityLookup() - Method in class org.springframework.data.rest.core.config.RepositoryRestConfiguration
Returns the EntityLookupRegistrar to create custom EntityLookup instances registered in the configuration.
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.
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.
A B C D E F G H I J L M N O P R S T U V W 
Skip navigation links
Spring Data REST - Core

Copyright © 2011–2019 Pivotal Software, Inc.. All rights reserved.