Module com.aoapps.servlet.util

Package com.aoapps.servlet.http

Class Canonical

java.lang.Object

com.aoapps.servlet.http.Canonical

All Implemented Interfaces:

AutoCloseable

public abstract class Canonical
extends Object
implements AutoCloseable

Coordinates when canonical URLs should be generated during response URL rewriting (such as information added when cookies are disabled). These URLs without per-user settings are used in things like Canonical URLs, BreadcrumbList, and Sitemaps.

This is implemented as a thread local, so the state must be set by the thread that will invoke HttpServletResponse.encodeURL(java.lang.String) (and related methods). Thus, it would be inappropriate to set this in a broad, asynchronous scope where the thread handling the request may change.

Method Summary

Modifier and Type	Method	Description
static Canonical	clear()	Sets the current state of the canonical ThreadLocal to false.
abstract void	close()	Restores the previous state of the canonical ThreadLocal.
static String	encodeCanonicalRedirectURL(HttpServletResponse response, String url)	Sets the state of the canonical ThreadLocal and invokes HttpServletResponse.encodeRedirectURL(java.lang.String).
static String	encodeCanonicalURL(HttpServletResponse response, String url)	Sets the state of the canonical ThreadLocal and invokes HttpServletResponse.encodeURL(java.lang.String).
static boolean	get()	Gets the current state of the canonical ThreadLocal.
static Canonical	set()	Sets the current state of the canonical ThreadLocal to true.
static Canonical	set(boolean value)	Sets the current state of the canonical ThreadLocal to the given value.

Methods inherited from class java.lang.Object

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

Method Detail

close

public abstract void close()

Restores the previous state of the canonical ThreadLocal.

Specified by:

close in interface AutoCloseable

get

public static boolean get()

Gets the current state of the canonical ThreadLocal.

set

public static Canonical set(boolean value)

Sets the current state of the canonical ThreadLocal to the given value. This should be used in a try-with-resources block to ensure the previous value is restored.

set

public static Canonical set()

Sets the current state of the canonical ThreadLocal to true. This should be used in a try-with-resources block to ensure the previous value is restored.

clear

public static Canonical clear()

Sets the current state of the canonical ThreadLocal to false. This should be used in a try-with-resources block to ensure the previous value is restored.

encodeCanonicalURL

public static String encodeCanonicalURL(HttpServletResponse response,
                                        String url)

Sets the state of the canonical ThreadLocal and invokes HttpServletResponse.encodeURL(java.lang.String).

encodeCanonicalRedirectURL

public static String encodeCanonicalRedirectURL(HttpServletResponse response,
                                                String url)

Sets the state of the canonical ThreadLocal and invokes HttpServletResponse.encodeRedirectURL(java.lang.String).