Uses of Class
org.dspace.app.rest.model.hateoas.HALResource

Packages that use HALResource

Package	Description
org.dspace.app.rest
org.dspace.app.rest.converter
org.dspace.app.rest.link
org.dspace.app.rest.model.hateoas
org.dspace.app.rest.projection
org.dspace.app.rest.signposting.hateoas
org.dspace.app.rest.utils

Uses of HALResource in org.dspace.app.rest

Methods in org.dspace.app.rest that return HALResource

Modifier and Type	Method	Description
HALResource<RestAddressableModel>	RestResourceController.findOne(String apiCategory, String model, Integer id)	Called in GET is used to retrieve the single resource by identifier; Note that the regular expression in the request mapping accept a number as identifier; Please see RestResourceController.findOne(String, String, String) for findOne with string as identifier and see RestResourceController.findOne(String, String, UUID) for uuid as identifier
HALResource<RestAddressableModel>	RestResourceController.findOne(String apiCategory, String model, String id)	Called in GET is used to retrieve the single resource by identifier; Note that the regular expression in the request mapping accept a string as identifier but not the other kind of identifier; http://<dspace.server.url>/api/{apiCategory}/{model}/{id} Example:
HALResource<RestAddressableModel>	RestResourceController.findOne(String apiCategory, String model, UUID uuid)	Called in GET is used to retrieve the single resource by identifier; Note that the regular expression in the request mapping accept a UUID as identifier; Please see RestResourceController.findOne(String, String, Integer) for findOne with number as identifier and see RestResourceController.findOne(String, String, String) for string as identifier

Uses of HALResource in org.dspace.app.rest.converter

Methods in org.dspace.app.rest.converter with type parameters of type HALResource

Modifier and Type	Method	Description
<T extends HALResource> T	ConverterService.toResource(RestModel restObject)	Converts the given rest object to a HALResource object.
<T extends HALResource> T	ConverterService.toResource(RestModel restObject, org.springframework.hateoas.Link... oldLinks)	Converts the given rest object to a HALResource object.

Uses of HALResource in org.dspace.app.rest.link

Methods in org.dspace.app.rest.link that return HALResource

Modifier and Type	Method	Description
HALResource	HalLinkService.addLinks(HALResource halResource)

Methods in org.dspace.app.rest.link with parameters of type HALResource

Modifier and Type	Method	Description
HALResource	HalLinkService.addLinks(HALResource halResource)
void	HalLinkService.addLinks(HALResource halResource, org.springframework.data.domain.Pageable pageable)
List<org.springframework.hateoas.Link>	HalLinkFactory.getLinksFor(HALResource halResource, org.springframework.data.domain.Pageable pageable)

Uses of HALResource in org.dspace.app.rest.model.hateoas

Subclasses of HALResource in org.dspace.app.rest.model.hateoas

Modifier and Type	Class	Description
class	AccessStatusResource	Access Status Rest HAL Resource.
class	AuthenticationStatusResource	Status Resource, wraps the status object and the authenticated EPerson
class	AuthenticationTokenResource	Token resource, wraps the AuthenticationToken object
class	AuthnResource	Authn Rest Resource, used to link to login, logout, status, ...
class	AuthorizationFeatureResource	Authorization Feature Rest HAL Resource.
class	AuthorizationResource	Authorization Rest HAL Resource.
class	BitstreamFormatResource	BitstreamFormat Rest HAL Resource.
class	BitstreamResource	Bitstream Rest HAL Resource.
class	BrowseEntryResource	Browse Entry Rest HAL Resource.
class	BrowseIndexResource	Browse Index Rest HAL Resource.
class	BulkAccessConditionResource	BulkAccessCondition HAL Resource.
class	BundleResource	Bunde Rest HAL Resource.
class	ClaimedTaskResource	ClaimedTask Rest HAL Resource.
class	CollectionResource	Collection Rest HAL Resource.
class	CommunityResource	Item Rest HAL Resource.
class	ContentReportSupportResource
class	CorrectionTypeResource	CorrectionType Rest HAL Resource.
class	DSpaceResource<T extends RestAddressableModel>	A base class for DSpace Rest HAL Resource.
class	EntityTypeResource	EntityType HAL Resource.
class	EPersonResource	EPerson Rest HAL Resource.
class	ExternalSourceEntryResource	This class serves as the HAL Resource for an ExternalSourceEntryRest object
class	ExternalSourceResource	This class serves as the HAL Resource for the ExternalSourceRest object
class	FacetConfigurationResource	This class' purpose is to provide a resource with the information, links and embeds for the /facet endpoint
class	FacetResultsResource	This class contains links, embeds and information (FacetResultsRest) to be shown in the endpoint /facet/author for example.
class	FacetsResource
class	FilteredCollectionsResource
class	FilteredItemsResource
class	GroupResource	Group Rest HAL Resource.
class	HarvestedCollectionResource	HarvestedCollection Rest HAL Resource.
class	HarvesterMetadataResource	HarvesterMetadata Rest HAL Resource.
class	IdentifierResource	Simple HAL wrapper for IdentifierRest model
class	IdentifiersResource	Boilerplate hateos resource for IdentifiersRest
class	ItemFilterResource	ItemFilter Rest HAL Resource.
class	ItemResource	Item Rest HAL Resource.
class	LDNMessageEntityResource	Browse Entry Rest HAL Resource.
class	LicenseResource	License Rest HAL Resource.
class	MetadataFieldResource	MetadataField Rest HAL Resource.
class	MetadataSchemaResource	MetadataSchema Rest HAL Resource.
class	NotifyServiceResource	NotifyService Rest HAL Resource.
class	OrcidHistoryResource	This class serves as a wrapper class to wrap the OrcidHistoryRest into a HAL resource.
class	OrcidQueueResource	This class serves as a wrapper class to wrap the OrcidQueueRest into a HAL resource.
class	PoolTaskResource	PooledTask Rest HAL Resource.
class	PotentialDuplicateResource	Wrap PotentialDuplicatesRest REST resource in a very simple HALResource class
class	ProcessFileTypesResource	Resource object for ProcessFileTypesRest
class	ProcessResource	The Resource representation of a Process object
class	PropertyResource	The purpose of this class is to wrap the information of the PropertyRest into a HAL resource
class	QAEventResource	QA event Rest resource.
class	QASourceResource	QA source Rest resource.
class	QATopicResource	QA topic Rest resource.
class	RegistrationResource	Registration HAL Resource.
class	RelationshipResource	Relationship HAL Resource.
class	RelationshipTypeResource	RelationshipType HAL Resource.
class	RequestItemResource	HAL resource for RequestItemRest.
class	ResearcherProfileResource	This class serves as a wrapper class to wrap the SearchConfigurationRest into a HAL resource.
class	ResourcePolicyResource	Access Condition Rest HAL Resource.
class	RootResource	The purpose of this class is to wrap the information of the RootRest into a HAL resource
class	ScriptResource	The Resource representation of a Script object
class	SearchConfigurationResource	This class serves as a wrapper class to wrap the SearchConfigurationRest into a HAL resource
class	SearchEventResource
class	SearchFacetEntryResource	This class' purpose is to create a container with the information, links and embeds for the different facets on various endpoints
class	SearchFacetValueResource	This class' purpose is to create a container for the information, links and embeds for the facet values on various endpoints
class	SearchResultEntryResource	This class' purpose is to create a container for the information, links and embeds for the search results entries
class	SearchResultsResource	This class' purpose is to create a container with a list of the SearchResultEntryResources
class	SearchSupportResource	This class' purpose is to wrap the SearchSupportRest into a HAL resource
class	SiteResource	Item Rest HAL Resource.
class	StatisticsSupportResource
class	SubmissionAccessOptionResource	SubmissionAccessOption HAL Resource.
class	SubmissionCCLicenseResource	CCLicense HAL Resource.
class	SubmissionCCLicenseUrlResource	SubmissionCCLicenseUrl HAL Resource.
class	SubmissionCOARNotifyResource	COARNotify HAL Resource.
class	SubmissionDefinitionResource	SubmissionDefinition Rest HAL Resource.
class	SubmissionFormResource	InputFrom Rest HAL Resource.
class	SubmissionSectionResource	SubmissionPanel Rest HAL Resource.
class	SubmissionUploadResource	Upload configuration section HAL Resource.
class	SubscriptionResource	The Resource representation of a Subscription object
class	SuggestionResource	Suggestion Rest HAL Resource.
class	SuggestionSourceResource	Suggestion Source Rest HAL Resource.
class	SuggestionTargetResource	Suggestion Target Rest HAL Resource.
class	SupervisionOrderResource	SupervisionOrder Rest HAL Resource.
class	SystemWideAlertResource	The Resource representation of a SystemWideAlert object
class	TemplateItemResource	TemplateItem Rest HAL Resource.
class	UsageReportResource	The Resource representation of a UsageReportRest object
class	VersionHistoryResource	The HALResource object for the VersionHistoryRest object
class	VersionResource	The HALResource object for the VersionRest object
class	ViewEventResource
class	VocabularyEntryDetailsResource	Vocabulary Entry Details Rest HAL Resource.
class	VocabularyEntryResource	Vocabulary Entry Rest HAL Resource.
class	VocabularyResource	Authority Rest HAL Resource.
class	WorkflowActionResource	WorkflowActionRest HAL Resource.
class	WorkflowDefinitionResource	WorkflowDefinition Rest HAL Resource.
class	WorkflowItemResource	WorkflowItem Rest HAL Resource.
class	WorkflowStepResource	WorkflowStepRest HAL Resource.
class	WorkspaceItemResource	WorkspaceItem Rest HAL Resource.

Uses of HALResource in org.dspace.app.rest.projection

Methods in org.dspace.app.rest.projection with type parameters of type HALResource

Modifier and Type	Method	Description
<T extends HALResource> T	AbstractProjection.transformResource(T halResource)
<T extends HALResource> T	CompositeProjection.transformResource(T halResource)
<T extends HALResource> T	Projection.transformResource(T halResource)	Transforms the resource object after it has been constructed and any constructor or annotation-based links and embeds have been added.

Methods in org.dspace.app.rest.projection with parameters of type HALResource

Modifier and Type	Method	Description
boolean	AbstractProjection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)
boolean	CompositeProjection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)
boolean	EmbedRelsProjection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)
boolean	FullProjection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)
boolean	Projection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)	Tells whether this projection permits the embedding of a particular embeddable subresource.
boolean	SpecificLevelProjection.allowEmbedding(HALResource<? extends RestAddressableModel> halResource, LinkRest linkRest, org.springframework.hateoas.Link... oldLinks)
boolean	AbstractProjection.allowLinking(HALResource halResource, LinkRest linkRest)
boolean	CompositeProjection.allowLinking(HALResource halResource, LinkRest linkRest)
boolean	FullProjection.allowLinking(HALResource halResource, LinkRest linkRest)
boolean	Projection.allowLinking(HALResource halResource, LinkRest linkRest)	Tells whether this projection permits the linking of a particular linkable subresource.
boolean	SpecificLevelProjection.allowLinking(HALResource halResource, LinkRest linkRest)
org.springframework.data.domain.PageRequest	AbstractProjection.getPagingOptions(String rel, HALResource<? extends RestAddressableModel> resource, org.springframework.hateoas.Link... oldLinks)
org.springframework.data.domain.PageRequest	EmbedRelsProjection.getPagingOptions(String rel, HALResource<? extends RestAddressableModel> resource, org.springframework.hateoas.Link... oldLinks)
org.springframework.data.domain.PageRequest	Projection.getPagingOptions(String rel, HALResource<? extends RestAddressableModel> resource, org.springframework.hateoas.Link... oldLinks)	This method will return the PageRequest object for a specific given rel

Uses of HALResource in org.dspace.app.rest.signposting.hateoas

Subclasses of HALResource in org.dspace.app.rest.signposting.hateoas

Modifier and Type	Class	Description
class	LinksetResource	Linkset Rest HAL Resource.

Uses of HALResource in org.dspace.app.rest.utils

Methods in org.dspace.app.rest.utils with type parameters of type HALResource

Modifier and Type	Method	Description
<T extends HALResource> T	Utils.toResource(RestModel restObject)

Methods in org.dspace.app.rest.utils with parameters of type HALResource

Modifier and Type	Method	Description
void	Utils.embedMethodLevelRels(HALResource<? extends RestAddressableModel> resource)	Adds embeds (if the maximum embed level has not been exceeded yet) for all properties annotated with @LinkRel or whose return types are RestAddressableModel subclasses.
void	Utils.embedOrLinkClassLevelRels(HALResource<RestAddressableModel> halResource, org.springframework.hateoas.Link... oldLinks)	Adds embeds or links for all class-level LinkRel annotations for which embeds or links are allowed.