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

Interface WebCmsEndpointService

All Known Implementing Classes:

WebCmsEndpointServiceImpl

public interface WebCmsEndpointService

Central API for endpoint and URL related functions.

Since:

0.0.1

Author:

Sander Van Loock, Arne Vandamme

Method Summary

Modifier and Type	Method and Description
org.springframework.web.util.UriComponentsBuilder	appendPreviewCode(WebCmsEndpoint endpoint, org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)
Optional<WebCmsUrl>	getPrimaryUrlForAsset(WebCmsAsset asset) Get the primary URL for a WebCmsAsset on the current domain.
Optional<WebCmsUrl>	getPrimaryUrlForAssetOnDomain(WebCmsAsset asset, WebCmsDomain domain) Get the primary URL for a WebCmsAsset on the specified domain.
Optional<WebCmsUrl>	getUrlForPath(String path) Retrieve the WebCmsUrl corresponding to a particular path.
Optional<WebCmsUrl>	getUrlForPathAndDomain(String path, WebCmsDomain domain) Retrieve the WebCmsUrl corresponding to a particular path on a specific domain.
boolean	isValidPreviewCode(WebCmsEndpoint endpoint, String securityCode) Check if a particular security code allows access to an endpoint.
ModificationReport<EndpointModificationType,WebCmsUrl>	updateOrCreatePrimaryUrlForAsset(String primaryUrl, WebCmsAsset asset, boolean publishEventOnFailure) Update the primary URL for a WebCmsAsset.

Method Detail

getUrlForPath

Optional<WebCmsUrl> getUrlForPath(String path)

Retrieve the WebCmsUrl corresponding to a particular path. Will use the current WebCmsDomainContext to perform the lookup.

Parameters:

path - to find the url for

Returns:

url if found

getUrlForPathAndDomain

Optional<WebCmsUrl> getUrlForPathAndDomain(String path,
                                           WebCmsDomain domain)

Retrieve the WebCmsUrl corresponding to a particular path on a specific domain.

Parameters:

path - to find the url for

domain - to look on

Returns:

url if found

updateOrCreatePrimaryUrlForAsset

ModificationReport<EndpointModificationType,WebCmsUrl> updateOrCreatePrimaryUrlForAsset(String primaryUrl,
                                                                                        WebCmsAsset asset,
                                                                                        boolean publishEventOnFailure)

Update the primary URL for a WebCmsAsset. Depending on the published status of the asset will either create or update the existing primary url, or will update the previous primary url as a redirect to the new primary url.

Note that if there is no single WebCmsAssetEndpoint for the asset, this method will do nothing. The ModificationReport returned should contain the status information on which action was performed. A ModificationStatus.FAILED means another endpoint already has that url.

The third parameter indicates if a PrimaryUrlForAssetFailedEvent should be published in case of a conflict with another endpoint. This allows another bean to take action and change the modification report.

Parameters:

primaryUrl - for the asset

asset - to update

publishEventOnFailure - true if an even

Returns:

modification report, optionally containing the old and new primary url

getPrimaryUrlForAsset

Optional<WebCmsUrl> getPrimaryUrlForAsset(WebCmsAsset asset)

Get the primary URL for a WebCmsAsset on the current domain.

Parameters:

asset - to get the primary url for

Returns:

url or none if no endpoint with a primary url

getPrimaryUrlForAssetOnDomain

Optional<WebCmsUrl> getPrimaryUrlForAssetOnDomain(WebCmsAsset asset,
                                                  WebCmsDomain domain)

Get the primary URL for a WebCmsAsset on the specified domain.

Parameters:

asset - to get the primary url for

domain - to get the primary url on

Returns:

url or none if no endpoint with a primary url

appendPreviewCode

org.springframework.web.util.UriComponentsBuilder appendPreviewCode(WebCmsEndpoint endpoint,
                                                                    org.springframework.web.util.UriComponentsBuilder uriComponentsBuilder)

isValidPreviewCode

boolean isValidPreviewCode(WebCmsEndpoint endpoint,
                           String securityCode)

Check if a particular security code allows access to an endpoint.

Parameters:

endpoint - to access

securityCode - that was used

Returns:

true if allowed