org.jahia.services.seo.jcr

Class VanityUrlManager

java.lang.Object

org.jahia.services.seo.jcr.VanityUrlManager

public class VanityUrlManager
extends Object

Manager for vanity URLs in Jahia

Author:

Benjamin Papez

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAHIAMIX_VANITYURLMAPPED mixin, which will automatically be attached once a vanity URL mapping is applied to a node
static String	JAHIANT_VANITYURL node type of the vanity URL node
static String	JAHIANT_VANITYURLS
static String	PROPERTY_ACTIVE Property name specifying if vanity URL is active
static String	PROPERTY_DEFAULT Property name specifying if vanity URL is the default one for a locale
static String	PROPERTY_FILE Property name specifying if it's vanity URL for a file
static String	PROPERTY_URL Property name holding the vanity URL
static String	VANITYURLMAPPINGS_NODE node name holding vanity URL mappings for a node

Constructor Summary

Constructors

Constructor and Description
VanityUrlManager()

Method Summary

Modifier and Type	Method and Description
List<VanityUrl>	findExistingVanityUrls(String url, String site, JCRSessionWrapper session) Find any mappings for the given vanity URL.
VanityUrl	getVanityUrlForCurrentLocale(JCRNodeWrapper contentNode, String siteKey, JCRSessionWrapper session) Gets a node's default vanity URL for the current locale or if none is default then take the first mapping for the locale.
List<VanityUrl>	getVanityUrls(JCRNodeWrapper contentNode, String languageCode, JCRSessionWrapper session) Gets all node's vanity URLs for the given locale
boolean	removeVanityUrlMapping(JCRNodeWrapper contentNode, VanityUrl vanityUrl, JCRSessionWrapper session) Completely delete a mapped vanity URL.
boolean	removeVanityUrlMappings(JCRNodeWrapper contentNode, String languageCode, JCRSessionWrapper session) Completely delete all mapped vanity URL for a locale.
boolean	saveVanityUrlMapping(JCRNodeWrapper contentNode, VanityUrl vanityUrl, JCRSessionWrapper session) Add or update a vanity URL mapping belonging to a specific content node and identified either by the vanity URL node UUID or the vanity URL value set in the VanityUrl bean.
boolean	saveVanityUrlMapping(JCRNodeWrapper contentNode, VanityUrl vanityUrl, JCRSessionWrapper session, boolean save) Add or update a vanity URL mapping belonging to a specific content node and identified either by the vanity URL node UUID or the vanity URL value set in the VanityUrl bean.
boolean	saveVanityUrlMappings(JCRNodeWrapper contentNode, List<VanityUrl> vanityUrls, Set<String> updatedLocales, JCRSessionWrapper session) Add, update or delete all vanity URL mappings for a specific content node and the language codes set in the list of VanityUrl beans.

Methods inherited from class java.lang.Object

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

Field Detail

JAHIAMIX_VANITYURLMAPPED

public static final String JAHIAMIX_VANITYURLMAPPED

mixin, which will automatically be attached once a vanity URL mapping is applied to a node

See Also:

Constant Field Values

JAHIANT_VANITYURL

public static final String JAHIANT_VANITYURL

node type of the vanity URL node

See Also:

Constant Field Values

JAHIANT_VANITYURLS

public static final String JAHIANT_VANITYURLS

See Also:

Constant Field Values

VANITYURLMAPPINGS_NODE

public static final String VANITYURLMAPPINGS_NODE

node name holding vanity URL mappings for a node

See Also:

Constant Field Values

PROPERTY_URL

public static final String PROPERTY_URL

Property name holding the vanity URL

See Also:

Constant Field Values

PROPERTY_DEFAULT

public static final String PROPERTY_DEFAULT

Property name specifying if vanity URL is the default one for a locale

See Also:

Constant Field Values

PROPERTY_ACTIVE

public static final String PROPERTY_ACTIVE

Property name specifying if vanity URL is active

See Also:

Constant Field Values

PROPERTY_FILE

public static final String PROPERTY_FILE

Property name specifying if it's vanity URL for a file

See Also:

Constant Field Values

Constructor Detail

VanityUrlManager

public VanityUrlManager()

Method Detail

findExistingVanityUrls

public List<VanityUrl> findExistingVanityUrls(String url,
                                              String site,
                                              JCRSessionWrapper session)
                                       throws javax.jcr.RepositoryException

Find any mappings for the given vanity URL. If a site is specified the query will be done only for the specified site, otherwise all sites in the workspace will be searched through and a list of VanityURL beans will be returned. The method searches mappings in any language.

Parameters:

url - URL path to check whether there is a content mapping for it (URL must start with /)

site - key of the site to search for the mapping or all sites if the string is null or empty

session - the JCR session holding the information about workspace and locale

Returns:

the list of VanityUrl beans

Throws:

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

getVanityUrlForCurrentLocale

public VanityUrl getVanityUrlForCurrentLocale(JCRNodeWrapper contentNode,
                                              String siteKey,
                                              JCRSessionWrapper session)
                                       throws javax.jcr.RepositoryException

Gets a node's default vanity URL for the current locale or if none is default then take the first mapping for the locale.

Parameters:

contentNode - the content node for which to return a mapping

siteKey - the key of the current site; if the content node's site does not match the specified one in siteKey, null is returned by this method

session - the JCR session holding the information about workspace and locale

Returns:

the VanityUrl bean

Throws:

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

getVanityUrls

public List<VanityUrl> getVanityUrls(JCRNodeWrapper contentNode,
                                     String languageCode,
                                     JCRSessionWrapper session)
                              throws javax.jcr.RepositoryException

Gets all node's vanity URLs for the given locale

Parameters:

contentNode - the content node for which to return the mappings

languageCode - the language code for which to return the mappings. Null to get all mappings

session - the JCR session holding the information about the workspace and user

Returns:

the list of VanityUrl beans

Throws:

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

removeVanityUrlMapping

public boolean removeVanityUrlMapping(JCRNodeWrapper contentNode,
                                      VanityUrl vanityUrl,
                                      JCRSessionWrapper session)
                               throws javax.jcr.RepositoryException

Completely delete a mapped vanity URL. If the deleted vanity URL is the default one for the current locale, then check whether there are other active mappings for the same locale and set the first found one as the new default.

Parameters:

contentNode - the content node for which to remove the given mapping

vanityUrl - the VanityUrl bean representing the URL to be removed

session - the JCR session used to find and remove the vanity URL node

Returns:

true if the vanity URL was removed or false if it was not removed

Throws:

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

removeVanityUrlMappings

public boolean removeVanityUrlMappings(JCRNodeWrapper contentNode,
                                       String languageCode,
                                       JCRSessionWrapper session)
                                throws javax.jcr.RepositoryException

Completely delete all mapped vanity URL for a locale.

Parameters:

contentNode - the content node for which to remove the mappings

languageCode - the language code for which the mappings should be removed

session - the JCR session used to find and remove the vanity URL nodes

Returns:

true if the vanity URLs were removed or false if not

Throws:

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

saveVanityUrlMapping

public boolean saveVanityUrlMapping(JCRNodeWrapper contentNode,
                                    VanityUrl vanityUrl,
                                    JCRSessionWrapper session)
                             throws javax.jcr.RepositoryException

Add or update a vanity URL mapping belonging to a specific content node and identified either by the vanity URL node UUID or the vanity URL value set in the VanityUrl bean.

If the URL mapping has already been saved before, we check whether the default, active, language or vanity URL value in the bean is different from the saved one, so we do an update, otherwise no operation is done.

If the new or updated mapping is now the default one for the language, then we also check if there already is another default URL for this language and set its default flag to false.

We also check whether the same URL is already existing for a different node or language in the current site and throw a ConstraintViolationException if this is the case.

Parameters:

contentNode - the content node for which to add or update the given mapping

vanityUrl - the VanityUrl bean representing the URL to be added or updated

session - the JCR session used to find and save the vanity URL node

Returns:

true if the vanity URL was added or false if it was not added

Throws:

javax.validation.ConstraintViolationException - if the vanity URL mapping already exists for a different content node or language within the site

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

saveVanityUrlMapping

public boolean saveVanityUrlMapping(JCRNodeWrapper contentNode,
                                    VanityUrl vanityUrl,
                                    JCRSessionWrapper session,
                                    boolean save)
                             throws javax.jcr.RepositoryException

Add or update a vanity URL mapping belonging to a specific content node and identified either by the vanity URL node UUID or the vanity URL value set in the VanityUrl bean.

If the URL mapping has already been saved before, we check whether the default, active, language or vanity URL value in the bean is different from the saved one, so we do an update, otherwise no operation is done.

If the new or updated mapping is now the default one for the language, then we also check if there already is another default URL for this language and set its default flag to false.

We also check whether the same URL is already existing for a different node or language in the current site and throw a ConstraintViolationException if this is the case.

Parameters:

contentNode - the content node for which to add or update the given mapping

vanityUrl - the VanityUrl bean representing the URL to be added or updated

session - the JCR session used to find and save the vanity URL node

save - should the session be saved at the end

Returns:

true if the vanity URL was added or false if it was not added

Throws:

javax.validation.ConstraintViolationException - if the vanity URL mapping already exists for a different content node or language within the site

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository

saveVanityUrlMappings

public boolean saveVanityUrlMappings(JCRNodeWrapper contentNode,
                                     List<VanityUrl> vanityUrls,
                                     Set<String> updatedLocales,
                                     JCRSessionWrapper session)
                              throws javax.jcr.RepositoryException

Add, update or delete all vanity URL mappings for a specific content node and the language codes set in the list of VanityUrl beans. First we load all existing mappings for all the languages set in the updatedLocales collection. Then we compare the existing with the list of URL mappings given in the vanityUrls collection to know which nodes need to be added, updated or deleted.

If the default mapping for a language is set for a new or updated mapping, then we check if there already is another default URL for this language and set its default flag to false.

We also check whether the same added URL is already existing for a different node or language in the current site (and which is not being deleted in the same operation) and throw a ConstraintViolationException if this is the case. We also throw a ConstraintViolationException if two URL mappings for the same language in the given vanityUrls collection have the default flag set to true.

Parameters:

contentNode - the content node for which to add the given mapping

vanityUrls - the list of VanityUrls bean representing the URLs to be added or updated

updatedLocales - a set with all locales, which have been edited (e.g. if all mappings for a language need to be deleted, add the language to this set, while in the vanityUrls list there will be no mappings for that language)

session - the JCR session used to find and save the vanity URL nodes

Returns:

true if any vanity URL was added, updated or deleted or false if no change was done

Throws:

javax.validation.ConstraintViolationException - if the vanity URL mapping already exists for a different content node or language in the site

javax.jcr.RepositoryException - if there was an unexpected exception accessing the repository