senselogic.sitevision.api.redirect

Interface RedirectUtil

@Requireable(value="RedirectUtil")
public interface RedirectUtil

Redirect utility interface (301 redirects for "old urls").

An instance of the Sitevision class implementing this interface can be obtained via Utils.getRedirectUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 4.0.3

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
void	addRedirectURI(Node aNode, String aRelativeURI) Adds a relative URI that should trigger a 301 redirect to a specific node.
void	addRedirectURIs(Node aNode, Collection<String> aRelativeURIs) Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
Set<String>	getRedirectURIs(Node aNode) Gets all 301 redirect URIs registered for a specific node.
void	removeAllRedirectURIs(Node aNode) Removes all relative 301 redirect URIs from a specific node.
void	removeRedirectURI(Node aNode, String aRelativeURI) Removes a relative 301 redirect URI from a specific node.

Method Detail

getRedirectURIs

Set<String> getRedirectURIs(Node aNode)

Gets all 301 redirect URIs registered for a specific node.

Parameters:

aNode - a node, typically a sv:page

Returns:

a set of 301 redirect URIs for aNode, never null

addRedirectURI

void addRedirectURI(Node aNode,
                    String aRelativeURI)
             throws IllegalArgumentException,
                    RepositoryException

Adds a relative URI that should trigger a 301 redirect to a specific node.

Permission note! Current user must have PermissionUtil.Permission.WRITE on aNode.

Parameters:

aNode - a node, typically a sv:page

aRelativeURI - the relative URI that should trigger a 301 redirect to aNode.

Throws:

IllegalArgumentException - if aNode is null or an invalid node, if aRelativeURI is null, whitespace-only or an absolute URI.

RepositoryException - if current user is not authorized to alter aNode, if aNode is already locked or something else goes wrong

addRedirectURIs

void addRedirectURIs(Node aNode,
                     Collection<String> aRelativeURIs)
              throws IllegalArgumentException,
                     RepositoryException

Adds a collection of relative URIs that should trigger 301 redirects to a specific node.

Permission note! Current user must have PermissionUtil.Permission.WRITE on aNode.

Parameters:

aNode - a node, typically a sv:page

aRelativeURIs - a collection of relative URIs that should trigger 301 redirects to aNode.

Throws:

IllegalArgumentException - if aNode is null or an invalid node, if aRelativeURI is null, empty or doesn't contain any non-whitespace only or an non-absolute URI.

RepositoryException - if current user is not authorized to alter aNode, if aNode is already locked or something else goes wrong

removeRedirectURI

void removeRedirectURI(Node aNode,
                       String aRelativeURI)
                throws IllegalArgumentException,
                       RepositoryException

Removes a relative 301 redirect URI from a specific node.

Permission note! Current user must have PermissionUtil.Permission.WRITE on aNode.

Parameters:

aNode - a node, typically a sv:page

aRelativeURI - the relative URI that should be removed from aNode.

Throws:

IllegalArgumentException - if aNode is null or an invalid node, if aRelativeURI is null, whitespace-only or an absolute URI.

RepositoryException - if current user is not authorized to alter aNode, if aNode is already locked or something else goes wrong

removeAllRedirectURIs

void removeAllRedirectURIs(Node aNode)
                    throws IllegalArgumentException,
                           RepositoryException

Removes all relative 301 redirect URIs from a specific node.

Permission note! Current user must have PermissionUtil.Permission.WRITE on aNode.

Parameters:

aNode - a node, typically a sv:page

Throws:

IllegalArgumentException - if aNode is null or an invalid node,

RepositoryException - if current user is not authorized to alter aNode, if aNode is already locked or something else goes wrong