Module spring.data.rest.webmvc

Package org.springframework.data.rest.webmvc

Class RootResourceInformation

java.lang.Object

org.springframework.data.rest.webmvc.RootResourceInformation

public class RootResourceInformation
extends Object

Meta-information about the root repository resource.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor	Description
RootResourceInformation(org.springframework.data.rest.core.mapping.ResourceMetadata metadata, PersistentEntity<?,?> entity, RepositoryInvoker invoker)

Method Summary

Modifier and Type	Method	Description
Class<?>	getDomainType()
RepositoryInvoker	getInvoker()
PersistentEntity<?,?>	getPersistentEntity()
org.springframework.data.rest.core.mapping.ResourceMetadata	getResourceMetadata()
org.springframework.data.rest.core.mapping.SearchResourceMappings	getSearchMappings()
org.springframework.data.rest.core.mapping.SupportedHttpMethods	getSupportedMethods()
Link	resourceLink(EntityModel<?> resource)
void	verifyPutForCreation()
void	verifySupportedMethod(HttpMethod httpMethod, PersistentProperty<?> property)	Verifies that the given HttpMethod is supported for the given PersistentProperty.
void	verifySupportedMethod(HttpMethod httpMethod, org.springframework.data.rest.core.mapping.ResourceType resourceType)	Verifies that the given HttpMethod is supported for the given ResourceType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RootResourceInformation

public RootResourceInformation(org.springframework.data.rest.core.mapping.ResourceMetadata metadata,
 PersistentEntity<?,?> entity,
 RepositoryInvoker invoker)

Method Details

getDomainType

public Class<?> getDomainType()

getResourceMetadata

public org.springframework.data.rest.core.mapping.ResourceMetadata getResourceMetadata()

getSearchMappings

public org.springframework.data.rest.core.mapping.SearchResourceMappings getSearchMappings()

getInvoker

public RepositoryInvoker getInvoker()

getPersistentEntity

public PersistentEntity<?,?> getPersistentEntity()

getSupportedMethods

public org.springframework.data.rest.core.mapping.SupportedHttpMethods getSupportedMethods()

verifySupportedMethod

public void verifySupportedMethod(HttpMethod httpMethod,
 org.springframework.data.rest.core.mapping.ResourceType resourceType)
                           throws HttpRequestMethodNotSupportedException,
ResourceNotFoundException

Verifies that the given HttpMethod is supported for the given ResourceType.

Parameters:

httpMethod - must not be null.

resourceType - must not be null.

Throws:

ResourceNotFoundException - if the repository is not exported at all.

HttpRequestMethodNotSupportedException - if the ResourceType does not support the given HttpMethod. Will contain all supported methods as indicators for clients.

verifySupportedMethod

public void verifySupportedMethod(HttpMethod httpMethod,
 PersistentProperty<?> property)
                           throws HttpRequestMethodNotSupportedException

Verifies that the given HttpMethod is supported for the given PersistentProperty.

Parameters:

httpMethod - must not be null.

property - must not be null.

Throws:

ResourceNotFoundException - if the repository is not exported at all.

HttpRequestMethodNotSupportedException - if the PersistentProperty does not support the given HttpMethod. Will contain all supported methods as indicators for clients.

verifyPutForCreation

public void verifyPutForCreation()
                          throws HttpRequestMethodNotSupportedException

Throws:

HttpRequestMethodNotSupportedException

resourceLink

public Link resourceLink(EntityModel<?> resource)