Skip to content

Commit

Permalink
#775 - Clean up VndError implementation to match spec.
Browse files Browse the repository at this point in the history 
* Handle single, multiple, and nested errors.
  • Loading branch information
@gregturn
gregturn committed Dec 10, 2019
1 parent 26c44dc commit f1138d8
Show file tree
Hide file tree
Showing 9 changed files with 349 additions and 251 deletions.
11 changes: 11 additions & 0 deletions src/main/java/org/springframework/hateoas/MediaTypes.java
View file
Expand Up @@ -76,4 +76,15 @@ public class MediaTypes {
* Public constant media type for {@code application/vnd.amundsen-uber+json}.
*/
public static final MediaType UBER_JSON = MediaType.parseMediaType(UBER_JSON_VALUE);


/**
* A String equivalent of {@link MediaTypes#VND_ERROR_JSON}.
*/
public static final String VND_ERROR_JSON_VALUE = "application/vnd.error+json";

/**
* Public constant media type for {@code application/vnd.error+json}.
*/
public static final MediaType VND_ERROR_JSON = MediaType.valueOf(VND_ERROR_JSON_VALUE);
}
272 changes: 137 additions & 135 deletions src/main/java/org/springframework/hateoas/mediatype/vnderrors/VndErrors.java
View file
Expand Up @@ -15,20 +15,29 @@
*/
package org.springframework.hateoas.mediatype.vnderrors;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.springframework.hateoas.CollectionModel;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.Links;
import org.springframework.hateoas.RepresentationModel;
import org.springframework.lang.Nullable;
import org.springframework.hateoas.server.core.Relation;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

/**
* A representation model class to be rendered as specified for the media type {@code application/vnd.error}.
Expand All @@ -37,20 +46,50 @@
* @author Oliver Gierke
* @author Greg Turnquist
*/
public class VndErrors implements Iterable<VndErrors.VndError> {
@JsonPropertyOrder({ "message", "logref", "total", "_links", "_embedded" })
@JsonIgnoreProperties(ignoreUnknown = true)
@EqualsAndHashCode
@ToString
public class VndErrors extends CollectionModel<VndErrors.VndError> {

/**
* @deprecated Use {@link org.springframework.hateoas.IanaLinkRelations#HELP}
*/
@Deprecated public static final String REL_HELP = "help";

/**
* @deprecated Use {@link org.springframework.hateoas.IanaLinkRelations#DESCRIBES}
*/
@Deprecated public static final String REL_DESCRIBES = "describes";

/**
* @deprecated Use {@link org.springframework.hateoas.IanaLinkRelations#ABOUT}
*/
@Deprecated public static final String REL_ABOUT = "about";

private final List<VndError> errors;

@Getter //
@JsonInclude(value = JsonInclude.Include.NON_EMPTY) //
private final String message;

@Getter //
@JsonInclude(value = JsonInclude.Include.NON_EMPTY) //
private final Integer logref;

private final List<VndError> vndErrors;
public VndErrors() {

this.errors = new ArrayList<>();
this.message = null;
this.logref = null;
}

/**
* Creates a new {@link VndErrors} instance containing a single {@link VndError} with the given logref, message and
* optional {@link Link}s.
*
* @param logref must not be {@literal null} or empty.
* @param message must not be {@literal null} or empty.
* @param links
*/
public VndErrors(String logref, String message, Link... links) {
this(new VndError(logref, message, links));
this(new VndError(message, null, Integer.parseInt(logref), links));
}

/**
Expand All @@ -62,9 +101,11 @@ public VndErrors(VndError error, VndError... errors) {

Assert.notNull(error, "Error must not be null");

this.vndErrors = new ArrayList<>(errors.length + 1);
this.vndErrors.add(error);
this.vndErrors.addAll(Arrays.asList(errors));
this.errors = new ArrayList<>();
this.errors.add(error);
Collections.addAll(this.errors, errors);
this.message = null;
this.logref = null;
}

/**
Expand All @@ -73,138 +114,134 @@ public VndErrors(VndError error, VndError... errors) {
* @param errors must not be {@literal null} or empty.
*/
@JsonCreator
public VndErrors(List<VndError> errors) {
public VndErrors(@JsonProperty("_embedded") List<VndError> errors, @JsonProperty("message") String message,
@JsonProperty("logref") Integer logref, @JsonProperty("_links") Links links) {

Assert.notNull(errors, "Errors must not be null!"); // Retain for compatibility
Assert.notEmpty(errors, "Errors must not be empty!");

Assert.notNull(errors, "Errors must not be null!");
Assert.isTrue(!errors.isEmpty(), "Errors must not be empty!");
this.vndErrors = errors;
this.errors = errors;
this.message = message;
this.logref = logref;

if (links != null && !links.isEmpty()) {
add(links);
}
}

/**
* Protected default constructor to allow JAXB marshalling.
*/
protected VndErrors() {
this.vndErrors = new ArrayList<>();
public VndErrors withMessage(String message) {
return new VndErrors(this.errors, message, this.logref, this.getLinks());
}

/**
* Adds an additional {@link VndError} to the wrapper.
*
* @param error
*/
public VndErrors add(VndError error) {
this.vndErrors.add(error);
return this;
public VndErrors withLogref(Integer logref) {
return new VndErrors(this.errors, this.message, logref, this.getLinks());
}

/**
* Dummy method to allow {@link JsonValue} to be configured.
*
* @return the vndErrors
*/
@JsonValue
private List<VndError> getErrors() {
return vndErrors;
public VndErrors withErrors(List<VndError> errors) {

Assert.notNull(errors, "errors must not be null!");
Assert.notEmpty(errors, "errors must not empty!");

return new VndErrors(errors, this.message, this.logref, this.getLinks());
}

/*
* (non-Javadoc)
* @see java.lang.Iterable#iterator()
public VndErrors withError(VndError error) {

this.errors.add(error);
return new VndErrors(this.errors, this.message, this.logref, this.getLinks());
}

public VndErrors withLink(Link link) {

add(link);
return new VndErrors(this.errors, this.message, this.logref, this.getLinks());
}

public VndErrors withLinks(Link... links) {

add(links);
return new VndErrors(this.errors, this.message, this.logref, this.getLinks());
}

/**
* Returns the underlying elements.
*
* @return the content will never be {@literal null}.
*/
@Override
public Iterator<VndErrors.VndError> iterator() {
return this.vndErrors.iterator();
public Collection<VndError> getContent() {
return this.errors;
}

/*
* (non-Javadoc)
* @see java.lang.Object#toString()
/**
* Virtual attribute to generate JSON field of {@literal total}. Only generated when there are multiple errors.
*/
@Override
public String toString() {
return String.format("VndErrors[%s]", StringUtils.collectionToCommaDelimitedString(vndErrors));
@JsonInclude(JsonInclude.Include.NON_NULL)
public Integer getTotal() {
return this.errors.size() > 1 //
? this.errors.size() //
: null; //
}

/*
* (non-Javadoc)
* @see java.lang.Object#hashCode()
/**
* Adds an additional {@link VndError} to the wrapper.
*
* @param error
*/
@Override
public int hashCode() {
return vndErrors.hashCode();
public VndErrors add(VndError error) {
return withError(error);
}

/*
* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
* @see java.lang.Iterable#iterator()
*/
@Override
public boolean equals(@Nullable Object obj) {

if (this == obj) {
return true;
}

if (!(obj instanceof VndErrors)) {
return false;
}

VndErrors that = (VndErrors) obj;
return this.vndErrors.equals(that.vndErrors);
public Iterator<VndErrors.VndError> iterator() {
return this.errors.iterator();
}

/**
* A single {@link VndError}.
*
* @author Oliver Gierke
* @author Greg Turnquist
*/
@JsonPropertyOrder({ "message", "path", "logref" })
@Relation(collectionRelation = "errors")
@EqualsAndHashCode
public static class VndError extends RepresentationModel<VndError> {

@JsonProperty private final String logref;
@JsonProperty private final String message;
@Getter //
private final String message;

@Getter(onMethod = @__(@JsonInclude(JsonInclude.Include.NON_EMPTY))) //
private final String path;

@Getter(onMethod = @__(@JsonInclude(JsonInclude.Include.NON_EMPTY))) //
private final Integer logref;

/**
* Creates a new {@link VndError} with the given logref, a message as well as some {@link Link}s.
* Creates a new {@link VndError} with a message and optional a path and a logref.
*
* @param logref must not be {@literal null} or empty.
* @param message must not be {@literal null} or empty.
* @param links
*/
public VndError(String logref, String message, Link... links) {
@JsonCreator
public VndError(@JsonProperty("message") String message, @JsonProperty("path") String path,
@JsonProperty("logref") Integer logref, @JsonProperty("_links") List<Link> links) {

Assert.hasText(logref, "Logref must not be null or empty!");
Assert.hasText(message, "Message must not be null or empty!");

this.logref = logref;
this.message = message;
this.add(Arrays.asList(links));
}

/**
* Protected default constructor to allow JAXB marshalling.
*/
protected VndError() {

this.logref = null;
this.message = null;
}

/**
* Returns the logref of the error.
*
* @return the logref
*/
public String getLogref() {
return logref;
this.path = path;
this.logref = logref;
this.add(links);
}

/**
* Returns the message of the error.
*
* @return the message
*/
public String getMessage() {
return message;
public VndError(String message, String path, Integer logref, Link... link) {
this(message, path, logref, Arrays.asList(link));
}

/*
Expand All @@ -215,40 +252,5 @@ public String getMessage() {
public String toString() {
return String.format("VndError[logref: %s, message: %s, links: [%s]]", logref, message, getLinks().toString());
}

/*
* (non-Javadoc)
* @see org.springframework.hateoas.ResourceSupport#hashCode()
*/
@Override
public int hashCode() {

int result = 17;

result += 31 * logref.hashCode();
result += 31 * message.hashCode();

return result;
}

/*
* (non-Javadoc)
* @see org.springframework.hateoas.ResourceSupport#equals(java.lang.Object)
*/
@Override
public boolean equals(@Nullable Object obj) {

if (obj == this) {
return true;
}

if (!(obj instanceof VndError)) {
return false;
}

VndError that = (VndError) obj;

return this.logref.equals(that.logref) && this.message.equals(that.message);
}
}
}

0 comments on commit f1138d8

Please sign in to comment.