Uses of Class
org.dspace.app.rest.model.RestAddressableModel

Packages that use RestAddressableModel

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

Uses of RestAddressableModel in org.dspace.app.rest

Methods in org.dspace.app.rest with type parameters of type RestAddressableModel

Modifier and Type	Method	Description
<T extends RestAddressableModel> org.springframework.hateoas.RepresentationModel	RestResourceController.executeSearchMethods(String apiCategory, String model, String searchMethodName, jakarta.servlet.http.HttpServletResponse response, org.springframework.data.domain.Pageable pageable, org.springframework.data.domain.Sort sort, org.springframework.data.web.PagedResourcesAssembler assembler, MultiValueMap<String,Object> parameters)
<T extends RestAddressableModel> org.springframework.hateoas.PagedModel<DSpaceResource<T>>	RestResourceController.findAll(String apiCategory, String model, org.springframework.data.domain.Pageable page, org.springframework.data.web.PagedResourcesAssembler assembler, jakarta.servlet.http.HttpServletResponse response, MultiValueMap<String,Object> parameters)	Find all via a GET request to the root endpoint.
<T extends RestAddressableModel> ResponseEntity<org.springframework.hateoas.RepresentationModel<?>>	RestResourceController.upload(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, List<MultipartFile> uploadfile)	Upload a file against the collection resource endpoint.

Methods in org.dspace.app.rest that return types with arguments of type RestAddressableModel

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
DSpaceResource<RestAddressableModel>	RestResourceController.put(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id)	Execute a PUT request for an entity with id of type Integer; curl -X PUT -H "Content-Type:text/uri-list" http://<dspace.server.url>/api/{apiCategory}/{model}/{id} Example:
DSpaceResource<RestAddressableModel>	RestResourceController.put(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, Integer id, com.fasterxml.jackson.databind.JsonNode jsonNode)	Execute a PUT request for an entity with id of type Integer; curl -X PUT -H "Content-Type:application/json" http://<dspace.server.url>/api/{apiCategory}/{model}/{id} Example:
DSpaceResource<RestAddressableModel>	RestResourceController.put(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, String id, com.fasterxml.jackson.databind.JsonNode jsonNode)	Execute a PUT request for an entity with id of type String and containing 32 hexadecimal digits.
DSpaceResource<RestAddressableModel>	RestResourceController.put(jakarta.servlet.http.HttpServletRequest request, String apiCategory, String model, UUID uuid, com.fasterxml.jackson.databind.JsonNode jsonNode)	Execute a PUT request for an entity with id of type UUID; curl -X PUT http://<dspace.server.url>/api/{apiCategory}/{model}/{uuid} Example:

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

Classes in org.dspace.app.rest.converter with type parameters of type RestAddressableModel

Modifier and Type	Interface	Description
interface	IndexableObjectConverter<M,R extends RestAddressableModel>	This is the base converter from/to objects in the DSpace API data model and the REST data model that can be indexed

Uses of RestAddressableModel in org.dspace.app.rest.model

Subclasses of RestAddressableModel in org.dspace.app.rest.model

Modifier and Type	Class	Description
class	AInprogressSubmissionRest	Abstract class to share common aspects between the REST representation of inprogressSubmission
class	AuthenticationStatusRest	Find out your authentication status.
class	AuthenticationTokenRest	The authentication token REST HAL Resource.
class	AuthnRest	Root rest object for the /api/authn endpoint
class	AuthorizationFeatureRest	The Authorization Feature REST Resource, shortly feature.
class	AuthorizationRest	The Authorization REST Resource.
class	BaseObjectRest<T extends Serializable>	Base class for any REST resource that need to be addressable and identifiable (via an ID)
class	BitstreamFormatRest	The BitstreamFormat REST Resource
class	BitstreamRest	The Bitstream REST Resource
class	BrowseIndexRest	The Browse Index REST Resource
class	BulkAccessConditionRest	The Bulk Access Condition Configuration REST Resource
class	BundleRest	The Bundle REST Resource
class	ClaimedTaskRest	The ClaimedTask REST Resource
class	CollectionRest	The Collection REST Resource
class	CommunityRest	The Community REST Resource
class	ContentReportSupportRest
class	CorrectionTypeRest	The CorrectionType REST Resource
class	DiscoveryResultsRest	This class provides a container for the information to be used in the DiscoveryResultsResource
class	DSpaceObjectRest	Base REST representation for all the DSpaceObjects
class	EntityTypeRest	This class is the REST representation of the EntityType model object and acts as a data object for the EntityTypeResource class.
class	EPersonRest	The EPerson REST Resource
class	ExternalSourceEntryRest	This class serves as a REST representation for an entry of external data
class	ExternalSourceRest	This class serves as a REST representation for an External Source
class	FacetConfigurationRest	This class' purpose is to give information about the FacetConfiguration to be displayed on the /facets endpoint
class	FacetResultsRest	This class provides a container for the information to be used in the FacetResultsResource
class	FeedbackRest	The REST object for the Feedback objects
class	FilteredCollectionsRest	This class serves as a REST representation of a Filtered Collections Report.
class	FilteredItemsRest	This class serves as a REST representation of a Filtered Items Report.
class	GroupRest	The Group REST Resource
class	HarvestedCollectionRest	The HarvestCollection REST Resource
class	HarvesterMetadataRest	The rest resource used for harvester metadata
class	IdentifierRest	Implementation of IdentifierRest REST resource, representing some DSpace identifier for use with the REST API
class	IdentifiersRest	Implementation of IdentifierRest REST resource, representing a list of all identifiers for use with the REST API
class	ItemFilterRest	The ItemFilter REST Resource
class	ItemRest	The Item REST Resource
class	LDNMessageEntityRest	The LDN Message REST resource.
class	MetadataFieldRest	The MetadataField REST Resource
class	MetadataSchemaRest	The MetadataSchema REST Resource
class	NotifyRequestStatusRest	Rest entity for LDN requests targeting items
class	NotifyServiceRest	The NotifyServiceEntity REST Resource
class	OrcidHistoryRest	The OrcidHistory REST Resource
class	OrcidQueueRest
class	PoolTaskRest	The PoolTask REST Resource
class	PotentialDuplicateRest	REST Model defining a Potential Duplicate for serialisation to JSON This is used in lists of potential duplicates for submission section data and item link / embeds.
class	ProcessFileTypesRest	This class provides a way to list the filetypes present in a given Process by showing them as a list of Strings It'll be used by ProcessFileTypesLinkRepository
class	ProcessRest	This class serves as a REST representation for the Process class
class	PropertyRest	This class acts as the REST representation of a DSpace configuration property.
class	QAEventRest	QA event Rest object.
class	QASourceRest	REST Representation of a quality assurance broker source
class	QATopicRest	REST Representation of a quality assurance broker topic
class	RegistrationRest	This class acts as the REST representation of the RegistrationData model class.
class	RelationshipRest	This class acts as the REST representation of the Relationship model class.
class	RelationshipTypeRest	This class is the REST representation of the RelationshipType model class.
class	RequestItemRest	Represent a user's request for a copy of an Item.
class	ResearcherProfileRest	The Researcher Profile REST resource.
class	ResourcePolicyRest	The Access Condition REST Resource.
class	RootRest	The purpose of this class is to show the representation of information on the home/root page of the REST API
class	ScriptRest	This class serves as a REST representation of a Script
class	SearchConfigurationRest	This class' purpose is to store the information that'll be shown on the /search endpoint.
class	SearchEventRest	This class acts as a REST representation for a SearchEvent in DSpace
class	SearchFacetEntryRest	This class' purpose is to create a container for the information used in the SearchFacetEntryResource
class	SearchFacetValueRest	This class' purpose is to create a container for the information used in the SearchFacetValueResource
class	SearchResultEntryRest	This class' purpose is to create a container for the information in the SearchResultEntryResource
class	SearchResultsRest	This class' purpose is to create a container for the information used in the SearchResultsResource
class	SearchSupportRest	This class' purpose is to give information about the api/discover endpoint
class	SiteRest	The Collection REST Resource
class	StatisticsSupportRest
class	SubmissionAccessOptionRest	The Access Condition Section Configuration REST Resource
class	SubmissionCCLicenseRest	This class is the REST representation of the CCLicense model object and acts as a data object for the SubmissionCCLicenseResource class.
class	SubmissionCCLicenseUrlRest	This class is the REST representation of the CCLicense URL String object and acts as a data object for the SubmissionCCLicenseUrlRest class.
class	SubmissionCOARNotifyRest	This class is the REST representation of the COARNotifySubmissionConfiguration model object and acts as a data object for the SubmissionCOARNotifyResource class.
class	SubmissionDefinitionRest	The Submission Definition REST Resource
class	SubmissionFormRest	The Submission Form REST Resource
class	SubmissionSectionRest	The SubmissionPanel REST Resource.
class	SubmissionUploadRest	The Upload Section Configuration REST Resource
class	SubscriptionRest
class	SuggestionRest	The Suggestion REST Resource.
class	SuggestionSourceRest	The Suggestion Source REST Resource.
class	SuggestionTargetRest	The Suggestion Target REST Resource.
class	SupervisionOrderRest	The REST Resource of SupervisionOrder.
class	SystemWideAlertRest	This class serves as a REST representation for the SystemWideAlert class
class	TemplateItemRest	The TemplateItem REST Resource
class	UsageReportPointCityRest	This class serves as a REST representation of a City data Point of a UsageReportRest from the DSpace statistics
class	UsageReportPointCountryRest	This class serves as a REST representation of a Country data Point of a UsageReportRest from the DSpace statistics.
class	UsageReportPointDateRest	This class serves as a REST representation of a Date (month) data Point of a UsageReportRest from the DSpace statistics
class	UsageReportPointDsoTotalVisitsRest	This class serves as a REST representation of a TotalVisit data Point of a DSO's UsageReportRest from the DSpace statistics
class	UsageReportPointRest	This class serves as a REST representation of a Point of a UsageReportRest from the DSpace statistics
class	UsageReportRest	This class serves as a REST representation of a Usage Report from the DSpace statistics
class	VersionHistoryRest	The REST object for the VersionHistory object
class	VersionRest	The REST object for the Version objects
class	ViewEventRest	This class acts as a REST representation for a ViewEvent in DSpace
class	VocabularyEntryDetailsRest	The Vocabulary Entry Details REST Resource
class	VocabularyRest	The vocabulary REST resource
class	WorkflowActionRest	The rest resource used for workflow actions
class	WorkflowDefinitionRest	The rest resource used for workflow definitions
class	WorkflowItemRest	The WorkflowItem REST Resource
class	WorkflowStepRest	The rest resource used for workflow steps
class	WorkspaceItemRest	The WorkspaceItem REST Resource

Methods in org.dspace.app.rest.model that return RestAddressableModel

Modifier and Type	Method	Description
RestAddressableModel	SearchResultEntryRest.getIndexableObject()

Methods in org.dspace.app.rest.model with parameters of type RestAddressableModel

Modifier and Type	Method	Description
void	SearchResultEntryRest.setIndexableObject(RestAddressableModel indexableObject)

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

Classes in org.dspace.app.rest.model.hateoas with type parameters of type RestAddressableModel

Modifier and Type	Class	Description
class	DSpaceResource<T extends RestAddressableModel>	A base class for DSpace Rest HAL Resource.

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

Method parameters in org.dspace.app.rest.projection with type arguments of type RestAddressableModel

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)
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 RestAddressableModel in org.dspace.app.rest.repository

Classes in org.dspace.app.rest.repository with type parameters of type RestAddressableModel

Modifier and Type	Class	Description
class	DSpaceRestRepository<T extends RestAddressableModel,ID extends Serializable>	Base class for any Rest Repository.

Uses of RestAddressableModel in org.dspace.app.rest.signposting.model

Subclasses of RestAddressableModel in org.dspace.app.rest.signposting.model

Modifier and Type	Class	Description
class	LinksetRest	The REST object for the Linkset objects.
class	TypedLinkRest	The REST object represents Typed Link.

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

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

Modifier and Type	Method	Description
org.springframework.hateoas.Link	Utils.linkToSingleResource(RestAddressableModel data, String rel)	Create a HAL Link to a single resource
org.springframework.hateoas.Link	Utils.linkToSubResource(RestAddressableModel data, String rel)	Create a HAL Link to a subresource of given resource.
org.springframework.hateoas.Link	Utils.linkToSubResource(RestAddressableModel data, String rel, String path)	Create a HAL Link to a subresource of given resource using given path name and link name

Method parameters in org.dspace.app.rest.utils with type arguments of type RestAddressableModel

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.
LinkRest	Utils.getClassLevelLinkRest(String rel, Class<? extends RestAddressableModel> restClass)