Package de.uplanet.lucy.server.auxiliaries

Klasse UrlBuilder

java.lang.Object

de.uplanet.lucy.server.auxiliaries.UrlBuilder

@VelocityCallable("singleton")
public final class UrlBuilder
extends Object

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
UrlBuilder()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
URL	createAbsoluteBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)	Veraltet. Use createAbsoluteBaseUrl(IRequestProcessingContext) instead.
URL	createAbsoluteBaseDirectoryUrl(IServerBridgeRequest p_request)	Veraltet. Use createAbsoluteBaseUrl(IServerBridgeRequest) instead.
URL	createAbsoluteBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
URL	createAbsoluteBaseUrl(IServerBridgeRequest p_request)	Create an absolute base URL from the given request.
URL	createAbsoluteRequestBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)	Reconstructs the URL the client used to make the request.
URL	createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest p_request)	Reconstructs the URL the client used to make the request.
URL	createBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)	Create a base URL, i.e. a relative URL containing solely the root path /.
URL	createBaseUrl(IServerBridgeRequest p_request)	Create a base URL, i.e. a relative URL containing solely the root path /.
URL	createDefaultUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)	Veraltet. Use createBaseUrl(IRequestProcessingContext) instead.
URL	createDefaultUrl(IServerBridgeRequest p_request)	Veraltet. Use createBaseUrl(IServerBridgeRequest) instead.
URL	createRequestBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)	Veraltet. Use createAbsoluteRequestBaseDirectoryUrl(IRequestProcessingContext) instead.
URL	createRequestBaseDirectoryUrl(IServerBridgeRequest p_request)	Veraltet. Use createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest) instead.
URL	createWebSocketBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
URL	createWebSocketBaseUrl(IServerBridgeRequest p_request)	Create a WebSocket URL from the given request.
String	encodeUri(String p_strUri)	Percent encode the given URI using UTF-8 as character set..
boolean	isSafeWebUrl(String p_strUrl)	Calls isSafeWebUrl(String, boolean) with the second parameter set to false to disallow single quotes in the URL.
boolean	isSafeWebUrl(String p_strUrl, boolean p_bAllowSingleQuotes)	Check if the given URL is a safe URL in Intrexx' sense.
boolean	isValidUri(String p_str)	Validate given URLs.
boolean	isValidUrl(String p_str)	Validate given URLs.
URI	parseUri(String p_strUri)	Create an URI object from the given URI.
URL	parseUrl(String p_strUrl)	Create an URL from the given string.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

UrlBuilder

public UrlBuilder()

Methodendetails

createBaseUrl

public URL createBaseUrl(IServerBridgeRequest p_request)

Create a base URL, i.e. a relative URL containing solely the root path /.

Parameter:

p_request - The request.

Gibt zurück:

The / base URL.

createBaseUrl

public URL createBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)

Create a base URL, i.e. a relative URL containing solely the root path /.

Parameter:

p_ctx - The processing context.

Gibt zurück:

The / base URL.

Siehe auch:

• createBaseUrl(IServerBridgeRequest)

createAbsoluteBaseUrl

public URL createAbsoluteBaseUrl(IServerBridgeRequest p_request)
                          throws MalformedURLException

Create an absolute base URL from the given request.

The returned absolute URL will always contain a terminating slash /.

This method tries to create an absolute base URL as follows

• First, if the doc("internal/cfg/portal.cfg")/portal/uris/uri[@name='web.url.base.default'] configuration parameter exists, return it. This is the preferred way. The following is a fallback in case the portal's default URL is not configured.
• Second, try to create an absolute URL from SERVERVAR.SCHEME, SERVERVAR.SERVER_NAME, SERVERVAR.SERVER_PORT, and return it.

Parameter:

p_request - The request.

Gibt zurück:

The base URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

createAbsoluteBaseUrl

public URL createAbsoluteBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
                          throws MalformedURLException

Löst aus:

MalformedURLException

Siehe auch:

• createAbsoluteBaseUrl(IServerBridgeRequest)

createWebSocketBaseUrl

public URL createWebSocketBaseUrl(IServerBridgeRequest p_request)
                           throws MalformedURLException

Create a WebSocket URL from the given request.

This method uses the same algorithm as createAbsoluteBaseUrl(IServerBridgeRequest) except that the scheme is ws or wss instead of http or https.

Parameter:

p_request - The request.

Gibt zurück:

The WebSocket URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

Siehe auch:

• createAbsoluteBaseUrl(IServerBridgeRequest)

createWebSocketBaseUrl

public URL createWebSocketBaseUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
                           throws MalformedURLException

Löst aus:

MalformedURLException

Siehe auch:

• createWebSocketBaseUrl(IServerBridgeRequest)

createAbsoluteRequestBaseDirectoryUrl

public URL createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest p_request)
                                          throws MalformedURLException

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, (optional) port number, and server path without the document part.

The document part is the rightmost path component that is not followed by a slash.

Parameter:

p_request - The request.

Gibt zurück:

The request base directory URL.

Löst aus:

MalformedURLException

createAbsoluteRequestBaseDirectoryUrl

public URL createAbsoluteRequestBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
                                          throws MalformedURLException

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, (optional) port number, and server path without the document part.

The document part is the rightmost path component that is not followed by a slash.

Parameter:

p_ctx - The processing context.

Gibt zurück:

The request base directory URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

Siehe auch:

• createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest)

parseUrl

public URL parseUrl(String p_strUrl)
             throws MalformedURLException

Create an URL from the given string.

Parameter:

p_strUrl - The string to be parsed.

Gibt zurück:

The URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

isValidUri

public boolean isValidUri(String p_str)

Validate given URLs.

Parameter:

p_str - The URL.

Gibt zurück:

true if the URL is valid, or false otherwise.

isValidUrl

public boolean isValidUrl(String p_str)

Validate given URLs.

Parameter:

p_str - The URL.

Gibt zurück:

true if the URL is valid, or false otherwise.

isSafeWebUrl

public boolean isSafeWebUrl(String p_strUrl)

Calls isSafeWebUrl(String, boolean) with the second parameter set to false to disallow single quotes in the URL.

Parameter:

p_strUrl - The URL.

Gibt zurück:

true if the URL is considered safe, or false otherwise.

isSafeWebUrl

public boolean isSafeWebUrl(String p_strUrl,
 boolean p_bAllowSingleQuotes)

Check if the given URL is a safe URL in Intrexx' sense.

The URL must meet the following conditions to be considered a safe Web ULR:

• The URL must only contain characters allowed by the spec (http://tools.ietf.org/html/rfc3986).
• The URL must not contain numeric or named HTML character references.
• The scheme must be either http, or https, or ftp, or the URL must be a relative URL.
• If the URL is absolute it must have an authority part.
• If the URL is relative it must not have an authority part.

Parameter:

p_strUrl - The URL.

p_bAllowSingleQuotes - true if single quotes are allowed to occur in the attribute value, or false otherwise.

Gibt zurück:

true if the URL is considered safe, or false otherwise.

parseUri

public URI parseUri(String p_strUri)
             throws URISyntaxException

Create an URI object from the given URI.

Parameter:

p_strUri - The URI.

Gibt zurück:

An URI object.

Löst aus:

URISyntaxException - If a syntax error occurred.

encodeUri

public String encodeUri(String p_strUri)
                 throws URISyntaxException

Percent encode the given URI using UTF-8 as character set..

Parameter:

p_strUri - The URI.

Gibt zurück:

The encoded URI.

Löst aus:

URISyntaxException - If a syntax error occurred.

createDefaultUrl

@Deprecated
public URL createDefaultUrl(IServerBridgeRequest p_request)

Veraltet.

Use createBaseUrl(IServerBridgeRequest) instead.

The same as createBaseUrl(IServerBridgeRequest).

Parameter:

p_request - The request.

Gibt zurück:

The URL.

createDefaultUrl

@Deprecated
public URL createDefaultUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)

Veraltet.

Use createBaseUrl(IRequestProcessingContext) instead.

The same as createBaseUrl(IRequestProcessingContext).

Parameter:

p_ctx - The processing context.

Gibt zurück:

The URL.

createAbsoluteBaseDirectoryUrl

@Deprecated
public URL createAbsoluteBaseDirectoryUrl(IServerBridgeRequest p_request)
                                   throws MalformedURLException

Veraltet.

Use createAbsoluteBaseUrl(IServerBridgeRequest) instead.

The same as createAbsoluteBaseUrl(IServerBridgeRequest).

Parameter:

p_request - The request.

Gibt zurück:

The URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

createAbsoluteBaseDirectoryUrl

@Deprecated
public URL createAbsoluteBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
                                   throws MalformedURLException

Veraltet.

Use createAbsoluteBaseUrl(IRequestProcessingContext) instead.

The same as createAbsoluteBaseUrl(IRequestProcessingContext).

Parameter:

p_ctx - The processing context.

Gibt zurück:

The URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

createRequestBaseDirectoryUrl

@Deprecated
public URL createRequestBaseDirectoryUrl(IServerBridgeRequest p_request)
                                  throws MalformedURLException

Veraltet.

Use createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest) instead.

The same as createAbsoluteRequestBaseDirectoryUrl(IServerBridgeRequest).

Parameter:

p_request - The request.

Gibt zurück:

The URL.

Löst aus:

MalformedURLException - If a parsing error occurred.

createRequestBaseDirectoryUrl

@Deprecated
public URL createRequestBaseDirectoryUrl(de.uplanet.lucy.server.connector.IRequestProcessingContext p_ctx)
                                  throws MalformedURLException

Veraltet.

Use createAbsoluteRequestBaseDirectoryUrl(IRequestProcessingContext) instead.

The same as createAbsoluteRequestBaseDirectoryUrl(IRequestProcessingContext).

Parameter:

p_ctx - The processing context.

Gibt zurück:

The URL.

Löst aus:

MalformedURLException - If a parsing error occurred.