com.tridion.configuration.util

Class ConfigurationUtil

java.lang.Object

com.tridion.configuration.util.ConfigurationUtil

public class ConfigurationUtil
extends Object

Class with some utility methods to handle configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URL Base URL.
static com.sdl.delivery.configuration.ConfigurationPath	BASE_URLS_REL_PATH Base URLS Rel Path.
static String	CONFIG_VALUE_CONTEXT_PATH Config Value Context Path.
static String	CONFIG_VALUE_HOST Config Value Host.
static int	CONFIG_VALUE_HTTP_PORT_DEFAULT Config Value HTTP Port Default.
static int	CONFIG_VALUE_HTTPS_PORT_DEFAULT Config Value HTTPS Port Default.
static String	CONFIG_VALUE_NAMESPACE_ID Config Value NamespaceId.
static String	CONFIG_VALUE_PATH Config Value Path.
static String	CONFIG_VALUE_PORT Config Value Port.
static int	CONFIG_VALUE_PORT_NOT_SET Config Value Port not set.
static String	CONFIG_VALUE_PROTOCOL Config Value Protocol.
static String	CONFIG_VALUE_PROTOCOL_FILE Config Value Protocol File.
static String	CONFIG_VALUE_PROTOCOL_HTTP Config Value Protocol HTTP.
static String	CONFIG_VALUE_PROTOCOL_HTTPS Config Value Protocol HTTPS.
static String	CONFIG_VALUE_PUB_ID Config Value Pub ID.
static String	CONFIG_VALUE_ROOT_PATH Config Value Root Path.
static com.sdl.delivery.configuration.ConfigurationPath	EXTENSION_PROPERTIES Extension Properties.
static String	KEY Key.
static com.sdl.delivery.configuration.ConfigurationPath	PUBLICATION_REL_PATH Publication Rel Path.
static String	RESOURCE_NAME The resource name to find the configuration for 'Dynamic Content' and 'Linking'.
static String	VALUE Value.
static com.sdl.delivery.configuration.ConfigurationPath	WEB_APP_PATH Web App Path.

Constructor Summary

Constructors

Constructor and Description
ConfigurationUtil()

Method Summary

Modifier and Type	Method and Description
static String	createUrlFrom(com.sdl.delivery.configuration.Configuration baseUrlConfig, String contextPath) Create a String URL for the given Base URL configuration and context path.
static int	getBaseUrlPort(com.sdl.delivery.configuration.Configuration baseUrlConfig, String protocol) Get the port from the given Base URL configuration, taking into account the given protocol.
static String	getBaseUrlProtocol(com.sdl.delivery.configuration.Configuration baseUrlConfig) Get the protocol from the given Base URL configuration.
static List<com.sdl.delivery.configuration.Configuration>	getConfigurations(com.sdl.delivery.configuration.Configuration configuration, com.sdl.delivery.configuration.ConfigurationPath path) This is a small convenience method that in case of an optional path returns an empty list instead of throwing an exception.
static List<com.sdl.delivery.configuration.Configuration>	getConfigurations(com.sdl.delivery.configuration.Configuration configuration, String path) Check getConfigurations(Configuration, ConfigurationPath) for more information.
static String	getRelativePath(String contextPath, String publicationPath) Get the relative path for the given 'context' and 'publication' path(s).
static Map<String,Integer>	getUrlToPublicationIdMappings(com.sdl.delivery.configuration.Configuration configuration) Extract the URL mappings, by retrieving this information from the publication configuration(s).
static boolean	getValueAsBoolean(com.sdl.delivery.configuration.Configuration configuration, String property, boolean defaultValue)
static String	getValueAsString(com.sdl.delivery.configuration.Configuration configuration, String property, String defaultValue)
static boolean	isPortSet(int port) Check if the given port is set.
static String	nullToEmpty(String string) Returns the given string if it is non-null; the empty string otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URL

public static final String BASE_URL

Base URL.

See Also:

Constant Field Values

WEB_APP_PATH

public static final com.sdl.delivery.configuration.ConfigurationPath WEB_APP_PATH

Web App Path.

PUBLICATION_REL_PATH

public static final com.sdl.delivery.configuration.ConfigurationPath PUBLICATION_REL_PATH

Publication Rel Path.

BASE_URLS_REL_PATH

public static final com.sdl.delivery.configuration.ConfigurationPath BASE_URLS_REL_PATH

Base URLS Rel Path.

EXTENSION_PROPERTIES

public static final com.sdl.delivery.configuration.ConfigurationPath EXTENSION_PROPERTIES

Extension Properties.

RESOURCE_NAME

public static final String RESOURCE_NAME

The resource name to find the configuration for 'Dynamic Content' and 'Linking'.

See Also:

Constant Field Values

CONFIG_VALUE_PUB_ID

public static final String CONFIG_VALUE_PUB_ID

Config Value Pub ID.

See Also:

Constant Field Values

CONFIG_VALUE_NAMESPACE_ID

public static final String CONFIG_VALUE_NAMESPACE_ID

Config Value NamespaceId.

See Also:

Constant Field Values

CONFIG_VALUE_PROTOCOL

public static final String CONFIG_VALUE_PROTOCOL

Config Value Protocol.

See Also:

Constant Field Values

CONFIG_VALUE_HOST

public static final String CONFIG_VALUE_HOST

Config Value Host.

See Also:

Constant Field Values

CONFIG_VALUE_PORT

public static final String CONFIG_VALUE_PORT

Config Value Port.

See Also:

Constant Field Values

CONFIG_VALUE_CONTEXT_PATH

public static final String CONFIG_VALUE_CONTEXT_PATH

Config Value Context Path.

See Also:

Constant Field Values

CONFIG_VALUE_PATH

public static final String CONFIG_VALUE_PATH

Config Value Path.

See Also:

Constant Field Values

CONFIG_VALUE_PROTOCOL_HTTP

public static final String CONFIG_VALUE_PROTOCOL_HTTP

Config Value Protocol HTTP.

See Also:

Constant Field Values

CONFIG_VALUE_PROTOCOL_HTTPS

public static final String CONFIG_VALUE_PROTOCOL_HTTPS

Config Value Protocol HTTPS.

See Also:

Constant Field Values

CONFIG_VALUE_PROTOCOL_FILE

public static final String CONFIG_VALUE_PROTOCOL_FILE

Config Value Protocol File.

See Also:

Constant Field Values

CONFIG_VALUE_ROOT_PATH

public static final String CONFIG_VALUE_ROOT_PATH

Config Value Root Path.

See Also:

Constant Field Values

CONFIG_VALUE_PORT_NOT_SET

public static final int CONFIG_VALUE_PORT_NOT_SET

Config Value Port not set.

See Also:

Constant Field Values

CONFIG_VALUE_HTTP_PORT_DEFAULT

public static final int CONFIG_VALUE_HTTP_PORT_DEFAULT

Config Value HTTP Port Default.

See Also:

Constant Field Values

CONFIG_VALUE_HTTPS_PORT_DEFAULT

public static final int CONFIG_VALUE_HTTPS_PORT_DEFAULT

Config Value HTTPS Port Default.

See Also:

Constant Field Values

KEY

public static final String KEY

Key.

See Also:

Constant Field Values

VALUE

public static final String VALUE

Value.

See Also:

Constant Field Values

Constructor Detail

ConfigurationUtil

public ConfigurationUtil()

Method Detail

getUrlToPublicationIdMappings

public static Map<String,Integer> getUrlToPublicationIdMappings(com.sdl.delivery.configuration.Configuration configuration)

Extract the URL mappings, by retrieving this information from the publication configuration(s).

Parameters:

configuration - The main configuration including the publication configuration(s). It can not be null.

getBaseUrlProtocol

public static String getBaseUrlProtocol(com.sdl.delivery.configuration.Configuration baseUrlConfig)
                                 throws com.sdl.delivery.configuration.ConfigurationException

Get the protocol from the given Base URL configuration.

Parameters:

baseUrlConfig - The given Base URL configuration. It can not be null.

Returns:

The protocol.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getBaseUrlPort

public static int getBaseUrlPort(com.sdl.delivery.configuration.Configuration baseUrlConfig,
                                 String protocol)
                          throws com.sdl.delivery.configuration.ConfigurationException

Get the port from the given Base URL configuration, taking into account the given protocol. In case the protocol used is either HTTP or HTTPS the default port would be different.

Parameters:

baseUrlConfig - The given Base URL configuration. It can not be null.

protocol - The given protocol. It can not be null.

Returns:

The port.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getRelativePath

public static String getRelativePath(String contextPath,
                                     String publicationPath)

Get the relative path for the given 'context' and 'publication' path(s). Take into account that the relative path is built by appending the 'context' and 'publication' path(s).

Parameters:

contextPath - The given 'context' path

publicationPath - The given 'publication' path.

Returns:

The resulting relative path.

createUrlFrom

public static String createUrlFrom(com.sdl.delivery.configuration.Configuration baseUrlConfig,
                                   String contextPath)
                            throws com.sdl.delivery.configuration.ConfigurationException

Create a String URL for the given Base URL configuration and context path.

Parameters:

baseUrlConfig - The given Base URL configuration. It can not be null.

contextPath - The given context path. If null is used, an empty path will be used instead.

Returns:

The created String URL.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getValueAsString

public static String getValueAsString(com.sdl.delivery.configuration.Configuration configuration,
                                      String property,
                                      String defaultValue)
                               throws com.sdl.delivery.configuration.ConfigurationException

Throws:

com.sdl.delivery.configuration.ConfigurationException

getValueAsBoolean

public static boolean getValueAsBoolean(com.sdl.delivery.configuration.Configuration configuration,
                                        String property,
                                        boolean defaultValue)
                                 throws com.sdl.delivery.configuration.ConfigurationException

Throws:

com.sdl.delivery.configuration.ConfigurationException

getConfigurations

public static List<com.sdl.delivery.configuration.Configuration> getConfigurations(com.sdl.delivery.configuration.Configuration configuration,
                                                                                   String path)

Check getConfigurations(Configuration, ConfigurationPath) for more information.

nullToEmpty

public static String nullToEmpty(String string)

Returns the given string if it is non-null; the empty string otherwise.

Parameters:

string - the string to test and possibly return

Returns:

string itself if it is non-null; "" if it is null

getConfigurations

public static List<com.sdl.delivery.configuration.Configuration> getConfigurations(com.sdl.delivery.configuration.Configuration configuration,
                                                                                   com.sdl.delivery.configuration.ConfigurationPath path)

This is a small convenience method that in case of an optional path returns an empty list instead of throwing an exception.

Parameters:

configuration - The configuration to look for a child path in

path - The path to look up

Returns:

The list of found configuration items or an empty list if none

isPortSet

public static boolean isPortSet(int port)

Check if the given port is set.

Parameters:

port - The given port.

Returns:

true when the port is set, false otherwise.