Package com.broadleafcommerce.customer.web.endpoint

Class CountryEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.CountryEndpoint

@FrameworkRestController
@FrameworkMapping("/countries")
@DataRouteByExample(ISOCountry.class)
public class CountryEndpoint
extends Object

Temporary endpoint to retrieve a list of ISO countries for use in admin. This is planned to be its own service so we have a single source for this data, because right now it's peppered throughout the framework where addresses are used.

Choosing this route to minimize the work when migrating to the actual implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CountryEndpoint()

Method Summary

Modifier and Type	Method	Description
protected void	initializeCountries()
Collection<ISOCountry>	readAllCountries()
protected Map<String,ISOCountry>	readCountries(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
ISOCountry	readCountry(String alpha2)
protected Map<String,List<String>>	readStateProvinceRegions(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
List<String>	readStateProvinceRegionsForCountry(String alpha2)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

CountryEndpoint

public CountryEndpoint()

Method Details

readAllCountries

@FrameworkGetMapping
public Collection<ISOCountry> readAllCountries()

readCountry

@FrameworkGetMapping("/{alpha2}")
public ISOCountry readCountry(@PathVariable("alpha2")
 String alpha2)

readStateProvinceRegionsForCountry

@FrameworkGetMapping("/{alpha2}/stateProvinceRegion")
public List<String> readStateProvinceRegionsForCountry(@PathVariable("alpha2")
 String alpha2)

initializeCountries

protected void initializeCountries()

readStateProvinceRegions

protected Map<String,List<String>> readStateProvinceRegions(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

readCountries

protected Map<String,ISOCountry> readCountries(com.fasterxml.jackson.databind.ObjectMapper objectMapper)