Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Jul 21 08:23
    morganriand commented #522
  • Jul 21 08:03
    odrotbohm milestoned #1588
  • Jul 21 08:03
    odrotbohm closed #1588
  • Jul 21 08:03
    odrotbohm commented #1588
  • Jul 21 08:03
    odrotbohm closed #1589
  • Jul 21 08:03

    odrotbohm on 1.3.x

    #1589 - WebMvcLinkBuilder.linkT… (compare)

  • Jul 21 08:01
    odrotbohm milestoned #1589
  • Jul 21 08:01
    odrotbohm labeled #1589
  • Jul 21 08:01
    odrotbohm labeled #1589
  • Jul 21 08:01
    odrotbohm assigned #1589
  • Jul 21 08:01
    odrotbohm labeled #1589
  • Jul 21 08:01
    odrotbohm opened #1589
  • Jul 21 08:01
    odrotbohm edited #1588
  • Jul 21 07:56
    odrotbohm labeled #1588
  • Jul 21 07:56
    odrotbohm labeled #1588
  • Jul 21 07:56
    odrotbohm labeled #1588
  • Jul 21 07:55
    odrotbohm assigned #1588
  • Jul 21 07:53

    odrotbohm on main

    #1588 - WebMvcLinkBuilder.linkT… (compare)

  • Jul 20 20:31
    morganriand commented #522
  • Jul 20 18:23
    odrotbohm commented #522
Ingo Griebsch
@ingogriebsch
Hello @gregturn, I would like to ask if there is somewhere explained how the Spring HATEOAS library decides which RepresentationModelProcessor is executed on which specific RepresentationModel? I just struggle a little bit with building complex RepresentationModel's (with a builder) and therefore not having a concrete type I could use to define a processor for.
1 reply
koehnj
@koehnj
Dear Spring HATEOAS team, i just noticed that you've recently added support for the "type" attribute for HAL-FORMS properties. Are there any plans to support the remaining additional attributes as well? Placeholder, minLength and maxLength are especially useful.
2 replies
Marcel Widmer
@marzelwidmer

Hello what is the best practice wo handle in the links with combination of DDD with validation on it... If maybe make a abstraction again on REST entpoint or not... or if there a better way to create the _link

eg. when I use a valid object from a customer. afford<CustomerResource> { methodOn(CustomerResource::class.java).add(customer = customer) }

val customer = Customer(id= null, firstName = FirstName("firstName"), lastName = LastName("lastName"))

    @GetMapping(value = ["/customers/{id}"], produces = [MediaTypes.HAL_JSON_VALUE])
    fun one(@PathVariable id: String): EntityModel<Customer> {
        // TODO: 09.02.21  Validation problems
        val customer = Customer(id= Any().toString(), firstName = FirstName(Any().toString()), lastName = LastName(Any().toString()))
        val create: Affordance = afford<CustomerResource> { methodOn(CustomerResource::class.java).add(customer = customer) }

or should I create the Domain objects eg on the service level... sound not nice for me... because I pass already the controller
maybe I miss understood something....

@odrotbohm will be nice update on yout spring-restbucks ;) how handle everything together..

Greg L. Turnquist
@gregturn

@marzelwidmer I can understand having a DTO that targets the serialized JSON, and having it carry validation rules embedded in either the constructors or the setters. This is the format used to "present" your API. After validating things in the controller, I would then transform into the internal type used at the service level. And I would do that transformation in the controller. The service doesn't have to be aware of this API-level of things.

If the validation rules you have in mind apply at the service level, put your validation rules there. Otherwise, keep them in the DTO. Then, when you transform stuff in the controller, you can have suitable error handling to report to the user of the API what went wrong.

Oliver Drotbohm
@odrotbohm
I don't quite follow. I.e. I don't actually get what the goal is.
Marcel Widmer
@marzelwidmer

@gregturn @odrotbohm Thanks for the response, I try to explain again where I have a conceptional ("knopf-im-kopf") problem in my head. I try to follow (resp. impl) https://speakerdeck.com/olivergierke/domain-driven-design-and-rest-1?slide=15

Also use this classes to validate on the API side. When I have to use this classes then also to create my _links I have to pass also valid (from my business valid objects) values (what is normal because of validation)

If I use the same (what 1st come in my head who should be correct) objects.

I was asking my self don't if it better to don't use the same object on API side. because the java.lang.IllegalArgumentException are throwing on runtime and If the developer not have the Domain validation in mine when he create the HATEOS resp. _links with the methodOn(...

@gregturn when I get U right is it also valid to create the API validation from the service layer (after transformation)

data class Customer(val id: String? = UUID.randomUUID().toString(), val firstName: FirstName, val lastName: LastName)
// Domain Primitive
data class FirstName(val value: String) {
    init {
        require(value.isNotEmpty()) { "value must be non-empty" }
        require(value.trim().length >= 2) { "wrong value length" }
        require(value.trim().length <= 20) { "wrong value length" }
    }
    companion object {
        @JvmStatic
        @JsonCreator
        fun create(value: String) = FirstName(value)
    }
    @JsonValue
    override fun toString() = value
}
.....

@RestController
class CustomerResource(private val service: CustomerService) {
    val CREATE_REL = "create"
    val ALL_CUSTOMERS_REL = "customers"

    @GetMapping(value = ["/customers/{id}"], produces = [MediaTypes.HAL_JSON_VALUE])
    fun oneCustomer(@PathVariable id: String): EntityModel<Customer> {
        val customer = Customer(
            id = null, firstName = FirstName("Here-I-Have-To-Add-Some-Valid-Domain-Primitive-Value"),
            lastName = LastName("TO-Avoid-IllegalArgumentException")
        )
        // java.lang.IllegalArgumentException: wrong value length
        //    at ch.keepcalm.demo.customer.secureByDesignModel.FirstName.<init>(Customer.kt:13)

        val selfLink = linkTo(methodOn(CustomerResource::class.java).oneCustomer(id)).withSelfRel()
        val createCustomerLink = linkTo(methodOn(CustomerResource::class.java).addCustomer(customer = customer)).withRel(CREATE_REL)
        val allCustomersLink = linkTo(methodOn(CustomerResource::class.java).allCustomers()).withRel(ALL_CUSTOMERS_REL)

        return EntityModel.of(service.findCustomerById(id))
            .add(selfLink, createCustomerLink, allCustomersLink)
    }

    @GetMapping(value = ["/customers"], produces = [MediaTypes.HAL_JSON_VALUE])
    fun allCustomers(): CollectionModel<EntityModel<Customer>> {
        val selfLink: Link = linkTo(methodOn(CustomerResource::class.java).allCustomers()).withSelfRel()
        return CollectionModel.of(
            service.findCustomers().map {
                EntityModel.of(it, linkTo(methodOn(CustomerResource::class.java).oneCustomer(it.id.toString())).withSelfRel())
            }, selfLink
        )
    }
}
Oliver Drotbohm
@odrotbohm

There's a couple of things to discuss here: I think, when manually implementing controllers, you should use dedicated DTOs to wrap into representation models and map from and to them explicitly. Using the domain types, especially inbound, is problematic as the strong rule enforcement will cause the deserialization break at the first rule violation. Unfortunately Jackson currently does not support accumulating the errors to return them all at once reasonably. Outbound, you still face the challenge of having to adapt the entity boundaries to the representation boundaries. Aggregates are a good start but as soon as you get away from the standard "CRUD via HTTP" the symmetry between the representation and a persisted entity usually goes off anyway. I.e. there will be resources that are centered around a DTO that then is used to map to different aggregates and invokes state transitions to them or actually needs different information assembled into a single view on the outbound side.

Does that help?

Marcel Widmer
@marzelwidmer
Nice: Thanks... yes I think so.... in other words. like this.... https://github.com/odrotbohm/spring-restbucks/blob/b4eece09f95d3862877a7521a797d6f1a3553b5b/server/src/main/java/org/springsource/restbucks/order/web/CoreOrderResourceProcessor.java#L47 This Order in my setup without Rest-Data I have to wrap in a own representation who are exposed eg. to a client. in my case Customer name are for the client just a String.
Marcel Widmer
@marzelwidmer
I think this is a topic not about HATEOAS Thanks to all ;)
@gregturn this mean for the quality there are a lot of mappings around....
Jeroen Vandevelde
@jeroenvandevelde

Hi, i am trying to use the Links class for a client-side implementation with a value that comes from the link header.

They return the value linkHeaderValue = 'https://url.com?page=1; rel=first, https://url.com?page=2; rel=last'
But when i call Links.parse(linkHeaderValue), i get an empty Links object.
Links.parse("<https://url.com?page=1>; rel=\"first\", <https://url.com?page=1>; rel=\"last\"")

This is because the linkHeaderValue doesn't match the LINK_HEADER_PATTERN in the Links class.
If they would return 'https://url.com?page=1; rel="first", https://url.com?page=2; rel="last"' it would work.

The docs of the producer say that they implement this spec for the link header.
But i am not really certain if they produce data up to standard of the specs or Links class does.

So i have 2 questions:

  • Does anyone know what the correct spec is? 'https://url.com?page=1; rel="first", https://url.com?page=2; rel="last"' or 'https://url.com?page=1; rel=first, https://url.com?page=2; rel=last'
  • This is a kind of follow-up question but if they don't produce the link header up to the standard. Is it okay if i add a way to overwrite the REGEX eg. Links.parse(source, LINK_HEADER_PATTERN)
    When playing around with this i noticed i also would need to overwrite the LINK_HEADERPATTERN in Links to
    ```Pattern.compile("(\w+)=(\p{Lower}[\p{Lower}\p{Digit}.\-\s]*|(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~
    |!:,.;]*[-a-zA-Z0-9+&@#/%=~_|])")```
    So i don't really know if this is still a smart way to go but looking forward to your feedback.
9 replies
Jeroen Vandevelde
@jeroenvandevelde
Great, thanks for the quick fix!
Oliver Drotbohm
@odrotbohm
Heads up: versions 1.3 M2, 1.2.4 and 1.1.4 have just been released for inclusion into the corresponding Spring Boot releases tomorrow.
4 replies
Christian
@anno1985
Hi! Is there a clever way to use Spring HATEOAS with the HAL flavour together with OpenAPI 3.x so that _link relations only have to be defined in one place, and are then propagated? Ideally, specify them in the OpenAPI spec and have the controller interfaces generated automatically, together with the DTO (which would then explicitly define the possible links). Otherwise, is there a way to have the OpenAPI spec generated from a project's code (the project using Spring HATEOAS)? The rationale being I'd like to define the possible link relations in one place, and then have them represented in my spec (OpenAPI), the server code (Spring) and the client code (Angular)...
4 replies
Christian
@anno1985
I've got another question: it seems that when creating the link relations and embedding resources, we end up tying together a lot of controllers and business objects. It looks a bit like the result are omniscient classes. Is this what usually happens with HAL in Spring, or is that a smell?
2 replies
KnightK0der
@mrabusalah

ERROR!
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.hateoas.hal.Jackson2HalModule$HalLinkListSerializer': Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.springframework.hateoas.hal.Jackson2HalModule$HalLinkListSerializer]: No default constructor found; nested exception is java.lang.NoSuchMethodException: org.springframework.hateoas.hal.Jackson2HalModule$HalLinkListSerializer.<init>()

any help ?

1 reply
Deniz Dalkilic
@dnzdlklc
Hello

I'm trying to store an object that extends RepresentationModel in Redis cache, upon retrieval I get a serialisation error:

Caused by: com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Could not resolve type id 'org.springframework.hateoas.Links' as a subtype of java.util.List<org.springframework.hateoas.Link>: Not a subtype at [Source: (io.netty.buffer.ByteBufInputStream); line: 1, column: 507] (through reference chain: ...

Can anyone help what would be the best way to tackle this?
Greg L. Turnquist
@gregturn
@mrabusalah More details, like version of Spring Boot/HATEOAS, and possibly some code excerpts.
Mark Pruden
@kiwisincebirth

Hi I am having Compile Issue using HalModelBuilder in Kotlin Code. I am on all the latest versions. But it comes down to a single method build() on HalModelBuilder

I have created as simple a test class. The compile error is Not enough information to infer type variable T - a typing issue - Here is the example

it seems like this should be simple to solve. If you need me to I can raise an issue on the project. Sorry if this has been asked before.

import org.springframework.hateoas.mediatype.hal.HalModelBuilder

// My domain class which is does NOT extend RepresentationModel
data class MyDomainDobject(
    val id: Int
)

fun main () {

    // the domain object I want to convert
    val myDomainDobject = MyDomainDobject(123)

    // create a hal model builder, for the domain object
    val builder = HalModelBuilder.halModelOf(myDomainDobject)

    // from here I would add links, embeds etc......

    // the following line causes a compile issue
    // - Not enough information to infer type variable T
    val model = builder.build()

    // the build method (is generically typed, whereas HalModelBuilder is not.
    // so cannot infer any type. Regardless the build method seems to assume it is returning
    // a underlying domain object which extends RepresentationModel<T>, which it isn't in my case!

    // my workaround comes in the form of a JAVA STATIC METHOD, which forces the type
    // conversion for me. It works for now but must compile Java code in Kotlin project

//    public static <T> EntityModel<T> build( HalModelBuilder builder ) {
//        return (EntityModel<T>) builder.build();
//    }
}
Greg L. Turnquist
@gregturn
@kiwisincebirth Please do open a ticket, with all the details you can provide.
1 reply
Francis
@francis-a

Hi everyone, I'm in the process of upgrading Spring Hateoas from 0.8x to the current version. It's quite a big application so I'm working through a large set of changes. There are a few places in our code where we are making use of the injectable _halObjectMapper. It seems like the current version is reusing a copy of an object mapper I define: https://github.com/spring-projects/spring-hateoas/blob/1.2.x/src/main/java/org/springframework/hateoas/config/HypermediaWebClientConfigurer.java#L49

My question is, is there any way to get a handle on the hal configured ObjectMapper via some kind of injectable class?

5 replies
Deniz Dalkilic
@dnzdlklc

Hello

Has anyone got any ideas on this?

Knut Schleßelmann
@kschlesselmann
Is it somehow possible to create plain links (no templates) with linkTo(methodOn())? I have some optional parameters and I don't want to include them at all in the URI if I call the method with null
3 replies
Ingo Griebsch
@ingogriebsch
Shameless cross posting from the Spring Data room (if not okay, please let me know). But because it is in some way related I would like to ask here as well...
"Hello, I would like to ask if there is any documentation or if there are any examples, guides or tutorials available to integrate a custom hypermedia-type into a Spring Data REST driven application?"
5 replies
Greg L. Turnquist
@gregturn

"I want to use the RepresentationModelAssemblerSupport to make the assembler aware of the resources controller to get the free self links, and for code organization purposes, but I'm using HAL and I also want to potentially embed objects on single resources.

It seems if I use the Hal builder I can no longer use that assembler because it's typed to go from T to D extends RepresentationModel 😕"

7 replies
Brian Zitzow
@bzitzow
Given a resource that has links to other resources, can I force those links to become embedded?
Marcel Widmer
@marzelwidmer
Hello is there any documentation about the rest-message.properties and normal message.properties https://docs.spring.io/spring-hateoas/docs/current/reference/html/#mediatypes.hal.configuration the sampe about the HEATOAS problems is this used of the message.properties when not I don't know how I can call the messges in my program code from a rest-message.properties I am not sure if this related in this channel because of this I post the same message in the sprong-boot
Knut Schleßelmann
@kschlesselmann
Anyone an idea regarding spring-projects/spring-hateoas#1547 ? After upgrading to 2.5.0 I cannot stream ResponseEntity subclasses any more :-(
Ingo Griebsch
@ingogriebsch

I'm really happy to announce the next release of Spring HATEOAS Siren! Version 1.2.0 is available through Maven Central and based on Spring HATEOAS 1.3.1!

Source: https://github.com/ingogriebsch/spring-hateoas-siren
Documentation: https://ingogriebsch.github.io/spring-hateoas-siren/1.2.0/index.html

The examples project is also updated to reflect the latest changes. Feel free to check it out to understand how to use the features provided by the library.

https://github.com/ingogriebsch/spring-hateoas-siren-samples

Every feedback is very welcome! :)

Preben Asmussen
@pax95
Created this issue in spring-framework spring-projects/spring-framework#27078, but the root cause is in spring-hateoas and should be moved there.
Asian Malaysian Vietnamese
@talentedasian
Are there any plans to support decimal values for HalFormsProperties and not just plain whole numbers without decimals? Only @Min and @Max are supported. spring-projects/spring-hateoas#1557 Github issue for reference.
Kai Toedter
@toedter
Hi all, I have an interesting issue in JSON:API for Spring HATEOAS. Currently I have no clue, why ResponseEntity<EntityModel<Payload>> does not work as expected. Could you please take a look at toedter/spring-hateoas-jsonapi#34 and give me some hints? Thanks a lot!
Kai Toedter
@toedter
This has something to do with the Kotlin coroutine mechanism (it works when removing suspend), but I did not figure out the details...
Kai Toedter
@toedter
I replaced the media type used in the demo of the above issue with the built-in UBER media type => same behavior so I guess the behavior cannot be addressed in JSON:API for Spring HATEOAS.