Package com.broadleafcommerce.tenant.web.endpoint

Class TenantResolverEndpoint

java.lang.Object

com.broadleafcommerce.tenant.web.endpoint.TenantResolverEndpoint

@FrameworkRestController
@FrameworkMapping("/resolver")
@DataRouteByExample(Tenant.class)
public class TenantResolverEndpoint
extends Object

This endpoint is intended for use by apps (e.g. admins) to resolve the current matching Tenant or Application.

Author:

Nathan Moore (nathanmoore), Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TenantResolverEndpoint.AdminTenantResolverResponse
static class	TenantResolverEndpoint.ApplicationResolverResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESOLVER_URI

Constructor Summary

Constructors

Constructor	Description
TenantResolverEndpoint(TenantResolver resolver, TenantService<Tenant> tenantService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected TenantResolverEndpoint.ApplicationResolverResponse	createApplicationResponse(@NonNull Application application)	Creates an TenantResolverEndpoint.ApplicationResolverResponse for the Application.
protected TenantResolver	getResolver()
protected TenantService<Tenant>	getTenantService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.http.ResponseEntity<TenantResolverEndpoint.AdminTenantResolverResponse>	resolveAdminTenant(String url)
org.springframework.http.ResponseEntity<TenantResolverEndpoint.ApplicationResolverResponse>	resolveApplication(String url, String id, String token)

Methods inherited from class java.lang.Object

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

Field Details

RESOLVER_URI

public static final String RESOLVER_URI

See Also:

• Constant Field Values

Constructor Details

TenantResolverEndpoint

public TenantResolverEndpoint(TenantResolver resolver,
 TenantService<Tenant> tenantService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

resolveAdminTenant

@FrameworkGetMapping("/admin")
public org.springframework.http.ResponseEntity<TenantResolverEndpoint.AdminTenantResolverResponse> resolveAdminTenant(@RequestParam
 String url)

resolveApplication

@FrameworkGetMapping("/application")
public org.springframework.http.ResponseEntity<TenantResolverEndpoint.ApplicationResolverResponse> resolveApplication(@RequestParam(required=false)
 String url,
 @RequestParam(required=false)
 String id,
 @RequestParam(required=false)
 String token)

createApplicationResponse

protected TenantResolverEndpoint.ApplicationResolverResponse createApplicationResponse(@NonNull
 @NonNull Application application)

Creates an TenantResolverEndpoint.ApplicationResolverResponse for the Application. This will additionally look up the owning Tenant.

Parameters:

application - Application to be used in the response

Returns:

An TenantResolverEndpoint.ApplicationResolverResponse for application including its Tenant

getResolver

protected TenantResolver getResolver()

getTenantService

protected TenantService<Tenant> getTenantService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()