de.alpharogroup.wicket.base.util.url

Class WicketUrlExtensions

java.lang.Object

de.alpharogroup.wicket.base.util.url.WicketUrlExtensions

public class WicketUrlExtensions
extends Object

The Class WicketUrlUtils.

Constructor Summary

Constructors

Constructor and Description
WicketUrlExtensions()

Method Summary

Modifier and Type	Method and Description
static <C extends org.apache.wicket.Page> String	absoluteUrlFor(Class<C> page) Returns the absolute url for the given page without the server port.
static <C extends org.apache.wicket.Page> String	absoluteUrlFor(Class<C> page, boolean withServerPort) Returns the absolute url for the given page and optionally with the server port.
static <C extends org.apache.wicket.Page> String	absoluteUrlFor(Class<C> page, org.apache.wicket.request.mapper.parameter.PageParameters parameters, boolean withServerPort) Returns the absolute url for the given page with the parameters and optionally with the server port.
static org.apache.wicket.request.Url	getBaseUrl() Gets the base Url.
static org.apache.wicket.request.Url	getBaseUrl(Class<? extends org.apache.wicket.Page> pageClass) Gets the base url from the given WebPage class object.
static org.apache.wicket.request.Url	getBaseUrl(Class<? extends org.apache.wicket.Page> pageClass, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Gets the base url.
static org.apache.wicket.request.Url	getBaseUrl(org.apache.wicket.Page page) Gets the base url from the given WebPage.
static org.apache.wicket.request.Url	getCanonicalPageUrl(Class<? extends org.apache.wicket.Page> pageClass) Gets the canonical page url.
static org.apache.wicket.request.Url	getCanonicalPageUrl(Class<? extends org.apache.wicket.Page> pageClass, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Gets the canonical page url.
static String	getContextPath() Gets the context path.
static String	getContextPath(org.apache.wicket.Page page) Gets the context path from the given WebPage.
static String	getDomainUrl() Gets the domain url.
static String	getDomainUrl(boolean withServerPort) Gets the domain url.
static String	getDomainUrl(boolean withServerPort, boolean withSlashAtTheEnd) Gets the domain url.
static String	getDomainUrl(boolean ssl, boolean withServerPort, boolean withSlashAtTheEnd) Gets the domain url.
static String	getLocalName() Returns the host name or the ip address on which the request was received.
static org.apache.wicket.request.Url	getPageUrl(Class<? extends org.apache.wicket.Page> pageClass) Gets the page url as Url object from the given WebPage class object.
static org.apache.wicket.request.Url	getPageUrl(Class<? extends org.apache.wicket.Page> pageClass, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Gets the page url.
static org.apache.wicket.request.Url	getPageUrl(org.apache.wicket.Page page) Gets the page url as Url object from the given WebPage.
static org.apache.wicket.request.Url	getPageUrl(org.apache.wicket.Page page, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Gets the page url.
static String	getServerName() Gets the server name.
static String	getUrlAsString(Class<? extends org.apache.wicket.Page> pageClass) Gets the url as string from the given WebPage class object.
static String	getUrlAsString(org.apache.wicket.Page page) Gets the url as string from the given WebPage.
static String	newDomainUrl(String scheme, String domainName, int port, boolean withServerPort, boolean withSlashAtTheEnd) Creates a new domain url from the given parameters.
static String	toBaseUrl() Gets the base Url as String.
static String	toBaseUrl(Class<? extends org.apache.wicket.Page> pageClass) Gets the base url from the given WebPage class object as String.
static String	toBaseUrl(Class<? extends org.apache.wicket.Page> pageClass, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Gets the base ur as String.

Methods inherited from class java.lang.Object

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

Constructor Detail

WicketUrlExtensions

public WicketUrlExtensions()

Method Detail

absoluteUrlFor

public static <C extends org.apache.wicket.Page> String absoluteUrlFor(Class<C> page)

Returns the absolute url for the given page without the server port.

Type Parameters:

C - the generic type

Parameters:

page - the page

Returns:

the string

absoluteUrlFor

public static <C extends org.apache.wicket.Page> String absoluteUrlFor(Class<C> page,
                                                                       boolean withServerPort)

Returns the absolute url for the given page and optionally with the server port.

Type Parameters:

C - the generic type

Parameters:

page - the page

withServerPort - the with server port

Returns:

the string

absoluteUrlFor

public static <C extends org.apache.wicket.Page> String absoluteUrlFor(Class<C> page,
                                                                       org.apache.wicket.request.mapper.parameter.PageParameters parameters,
                                                                       boolean withServerPort)

Returns the absolute url for the given page with the parameters and optionally with the server port.

Type Parameters:

C - the generic type

Parameters:

page - the page

parameters - the parameters

withServerPort - the with server port

Returns:

the string

getBaseUrl

public static org.apache.wicket.request.Url getBaseUrl()

Gets the base Url.

Returns:

base Url

getBaseUrl

public static org.apache.wicket.request.Url getBaseUrl(Class<? extends org.apache.wicket.Page> pageClass)

Gets the base url from the given WebPage class object.

Parameters:

pageClass - the page class

Returns:

the base url

getBaseUrl

public static org.apache.wicket.request.Url getBaseUrl(Class<? extends org.apache.wicket.Page> pageClass,
                                                       org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Gets the base url.

Parameters:

pageClass - the page class

parameters - the parameters

Returns:

the base url

getBaseUrl

public static org.apache.wicket.request.Url getBaseUrl(org.apache.wicket.Page page)

Gets the base url from the given WebPage.

Parameters:

page - the page

Returns:

the base url

getCanonicalPageUrl

public static org.apache.wicket.request.Url getCanonicalPageUrl(Class<? extends org.apache.wicket.Page> pageClass)

Gets the canonical page url. Try to reduce url by eliminating '..' and '.' from the path where appropriate (this is somehow similar to File.getCanonicalPath()).

Parameters:

pageClass - the page class

Returns:

the page url

See Also:

Url.canonical()

getCanonicalPageUrl

public static org.apache.wicket.request.Url getCanonicalPageUrl(Class<? extends org.apache.wicket.Page> pageClass,
                                                                org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Gets the canonical page url. Try to reduce url by eliminating '..' and '.' from the path where appropriate (this is somehow similar to File.getCanonicalPath()).

Parameters:

pageClass - the page class

parameters - the parameters

Returns:

the page url

See Also:

Url.canonical()

getContextPath

public static String getContextPath()

Gets the context path.

Returns:

the context path

getContextPath

public static String getContextPath(org.apache.wicket.Page page)

Gets the context path from the given WebPage.

Parameters:

page - the page

Returns:

the context path

getDomainUrl

public static String getDomainUrl()

Gets the domain url.

Returns:

the domain url

getDomainUrl

public static String getDomainUrl(boolean withServerPort)

Gets the domain url.

Parameters:

withServerPort - the with server port

Returns:

the domain url

getDomainUrl

public static String getDomainUrl(boolean withServerPort,
                                  boolean withSlashAtTheEnd)

Gets the domain url.

Parameters:

withServerPort - the with server port

withSlashAtTheEnd - the with slash at the end

Returns:

the domain url

getDomainUrl

public static String getDomainUrl(boolean ssl,
                                  boolean withServerPort,
                                  boolean withSlashAtTheEnd)

Gets the domain url.

Parameters:

ssl - if the domain url is secure the scheme https will be added otherwise http

withServerPort - the with server port

withSlashAtTheEnd - the with slash at the end

Returns:

the domain url

getLocalName

public static String getLocalName()

Returns the host name or the ip address on which the request was received.

Returns:

a String containing the host name of the ip address on which the request was received.

See Also:

ServletRequest.getLocalName()

getPageUrl

public static org.apache.wicket.request.Url getPageUrl(Class<? extends org.apache.wicket.Page> pageClass)

Gets the page url as Url object from the given WebPage class object.

Parameters:

pageClass - the page class

Returns:

the page url

getPageUrl

public static org.apache.wicket.request.Url getPageUrl(Class<? extends org.apache.wicket.Page> pageClass,
                                                       org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Gets the page url.

Parameters:

pageClass - the page class

parameters - the parameters

Returns:

the page url

getPageUrl

public static org.apache.wicket.request.Url getPageUrl(org.apache.wicket.Page page)

Gets the page url as Url object from the given WebPage.

Parameters:

page - the page

Returns:

the page url

getPageUrl

public static org.apache.wicket.request.Url getPageUrl(org.apache.wicket.Page page,
                                                       org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Gets the page url.

Parameters:

page - the page

parameters - the parameters

Returns:

the page url

getServerName

public static String getServerName()

Gets the server name.

Returns:

the server name

getUrlAsString

public static String getUrlAsString(Class<? extends org.apache.wicket.Page> pageClass)

Gets the url as string from the given WebPage class object.

Parameters:

pageClass - the page class

Returns:

the url as string

getUrlAsString

public static String getUrlAsString(org.apache.wicket.Page page)

Gets the url as string from the given WebPage.

Parameters:

page - the page

Returns:

the url as string

newDomainUrl

public static String newDomainUrl(String scheme,
                                  String domainName,
                                  int port,
                                  boolean withServerPort,
                                  boolean withSlashAtTheEnd)

Creates a new domain url from the given parameters.

Parameters:

scheme - the scheme

domainName - the domain name

port - the port

withServerPort - the with server port

withSlashAtTheEnd - the with slash at the end

Returns:

the string

toBaseUrl

public static String toBaseUrl()

Gets the base Url as String.

Returns:

base Url as String.

toBaseUrl

public static String toBaseUrl(Class<? extends org.apache.wicket.Page> pageClass)

Gets the base url from the given WebPage class object as String.

Parameters:

pageClass - the page class

Returns:

the base url as String.

toBaseUrl

public static String toBaseUrl(Class<? extends org.apache.wicket.Page> pageClass,
                               org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Gets the base ur as String.

Parameters:

pageClass - the page class

parameters - the parameters

Returns:

the base url as String.