com.jayway.jaxrs.hateoas.HateoasVerbosity Maven / Gradle / Ivy
/*
* Copyright 2011 the original author or authors.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.jayway.jaxrs.hateoas;
import org.apache.commons.lang.StringUtils;
import java.util.LinkedList;
import java.util.List;
import static org.apache.commons.lang.Validate.notEmpty;
/**
* A HateoasVerbosity wraps a number of {@link HateoasOption}s and determines which attributes should be included in
* the generated links.
*
* @author Mattias Hellborg Arthursson
* @author Kalle Stenflo
*/
public class HateoasVerbosity {
public static HateoasVerbosity ATOM = new HateoasVerbosity(
HateoasOption.REL, HateoasOption.HREF, HateoasOption.TYPE);
public static HateoasVerbosity MAXIMUM = new HateoasVerbosity(
HateoasOption.REL, HateoasOption.HREF, HateoasOption.ID,
HateoasOption.CONSUMES, HateoasOption.PRODUCES,
HateoasOption.METHOD, HateoasOption.LABEL,
HateoasOption.DESCRIPTION, HateoasOption.TEMPLATE);
public static HateoasVerbosity MINIMUM = new HateoasVerbosity(
HateoasOption.REL, HateoasOption.HREF, HateoasOption.METHOD);
public static HateoasVerbosity NORMAL = new HateoasVerbosity(
HateoasOption.REL, HateoasOption.HREF, HateoasOption.METHOD,
HateoasOption.PRODUCES, HateoasOption.CONSUMES);
public static HateoasVerbosity GENERIC_CLIENT = new HateoasVerbosity(
HateoasOption.REL, HateoasOption.HREF, HateoasOption.CONSUMES,
HateoasOption.METHOD, HateoasOption.TEMPLATE);
private static HateoasVerbosity defaultVerbosity = HateoasVerbosity.MAXIMUM;
private HateoasOption[] options;
public HateoasVerbosity(HateoasOption... options) {
this.options = options;
}
public static void setDefaultVerbosity(HateoasVerbosity verbosity) {
defaultVerbosity = verbosity;
}
/**
* Find a predefined verbosity level based on name. If no matching name
* is found null is returned.
*
* @param name name of verbosity level
* @return the found verbosity level or null if no match.
*/
public static HateoasVerbosity findByName(String name) {
notEmpty(name, "Verbosity name must not be null or empty");
if ("ATOM".equals(name.toUpperCase())) {
return ATOM;
} else if ("MAXIMUM".equals(name.toUpperCase())) {
return MAXIMUM;
} else if ("MINIMUM".equals(name.toUpperCase())) {
return MINIMUM;
} else if ("NORMAL".equals(name.toUpperCase())) {
return NORMAL;
} else if ("GENERIC_CLIENT".equals(name.toUpperCase())) {
return GENERIC_CLIENT;
} else {
return null;
}
}
/**
* Get a HateoasVerbosity corresponding to the comma-delimited String of {@link HateoasOption} values.
*
* @param optionsString comma-delimited (,) or semi-colon (;) String of {@link HateoasOption} values
* @return a HateoasVerbosity instance wrapping all the specified options,
* or the default verbosity if an empty string is specified.
* @throws IllegalArgumentException if an invalid option is supplied
*/
public static HateoasVerbosity valueOf(String optionsString) {
if (StringUtils.isNotBlank(optionsString)) {
String[] headerSplit;
if(optionsString.contains(",")){
headerSplit = StringUtils.split(optionsString, ",");
} else {
headerSplit = StringUtils.split(optionsString, ";");
}
List options = new LinkedList();
for (String oneOption : headerSplit) {
options.add(HateoasOption.valueOf(oneOption.trim()));
}
return new HateoasVerbosity(
options.toArray(new HateoasOption[0]));
} else {
return defaultVerbosity;
}
}
public HateoasOption[] getOptions() {
return options;
}
}