com.foreach.across.modules.webcms.domain.endpoint

Interface WebCmsUriComponentsService

public interface WebCmsUriComponentsService

Utility service that builds an extendable UriComponentsBuilder for a given WebCmsAsset, WebCmsEndpoint or WebCmsUrl

Since:

0.0.3

Author:

Steven Gentens

Method Summary

Modifier and Type	Method and Description
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsAsset asset) Builds a UriComponentsBuilder for a particular WebCmsAsset on the current domain.
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsAsset asset, WebCmsDomain domain) Builds a UriComponentsBuilder for a particular WebCmsAsset on the current domain.
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsEndpoint endpoint) Builds a UriComponentsBuilder for a particular WebCmsEndpoint on the current domain.
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsEndpoint endpoint, WebCmsDomain domain) Builds a UriComponentsBuilder for a particular WebCmsEndpoint on the current domain.
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsUrl url) Builds a UriComponentsBuilder for a particular WebCmsUrl on the current domain.
Optional<org.springframework.web.util.UriComponentsBuilder>	buildUriComponents(WebCmsUrl url, WebCmsDomain domain) Builds a UriComponentsBuilder for a particular WebCmsUrl on the current domain.

Method Detail

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsAsset asset)

Builds a UriComponentsBuilder for a particular WebCmsAsset on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

asset - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsAsset asset,
                                                                               WebCmsDomain domain)

Builds a UriComponentsBuilder for a particular WebCmsAsset on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

asset - to build the UriComponentsBuilder for

domain - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsEndpoint endpoint)

Builds a UriComponentsBuilder for a particular WebCmsEndpoint on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

endpoint - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsEndpoint endpoint,
                                                                               WebCmsDomain domain)

Builds a UriComponentsBuilder for a particular WebCmsEndpoint on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

endpoint - to build the UriComponentsBuilder for

domain - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsUrl url)

Builds a UriComponentsBuilder for a particular WebCmsUrl on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available. The domain of the url is specified by its endpoint.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

url - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.

buildUriComponents

Optional<org.springframework.web.util.UriComponentsBuilder> buildUriComponents(WebCmsUrl url,
                                                                               WebCmsDomain domain)

Builds a UriComponentsBuilder for a particular WebCmsUrl on the current domain. The UriComponentsBuilder contains the path of the primary url of the asset if available. The domain of the url is specified by its endpoint.

If the current domain contains WebCmsDomainUrlConfigurer metadata, the UriComponentsBuilder will contain the prefix url if the domain of the asset differs from the current domain or if WebCmsDomainUrlConfigurer.isAlwaysPrefix() is true.

Parameters:

url - to build the UriComponentsBuilder for

domain - to build the UriComponentsBuilder for

Returns:

UriComponentsBuilder if the primary url was available.