org.apache.portals.applications.webcontent2.proxy.util

Class YamlConfigUtils

java.lang.Object

org.apache.portals.applications.webcontent2.proxy.util.YamlConfigUtils

public class YamlConfigUtils
extends Object

Utility to load reverse proxy mapping configurations in YAML format. This utility uses snakeyaml library internally to parse YAML configurations.

Method Summary

Methods

Modifier and Type	Method and Description
static List<ProxyMapping>	loadProxyMappings(String yamlConfig, Object servletContextOrPortletContext) Loads list of ProxyMapping objects from the yamlConfig.
static Iterable<Object>	loadYaml(org.yaml.snakeyaml.constructor.BaseConstructor constructor, String yamlConfig, Object servletContextOrPortletContext) Loads YAML objects from the yamlConfig.

Methods inherited from class java.lang.Object

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

Method Detail

loadYaml

public static Iterable<Object> loadYaml(org.yaml.snakeyaml.constructor.BaseConstructor constructor,
                        String yamlConfig,
                        Object servletContextOrPortletContext)

Loads YAML objects from the yamlConfig.

The yamlConfig can represent any of the following:

• a file resource URI starting with "file:",
• a classpath resource starting with "classpath:",
• a servlet context relative path resource starting with "/",
• otherwise, yamlConfig is regarded as a whole YAML configuration string.

Note: if yamlConfig represents an external resource (file resource URI, classpath resource or or servlet context relative path resource), then the resource must be encoded in UTF-8.

Parameters:

constructor - snakeyaml base constructor to be used when constructing a Yaml

yamlConfig - YAML configuration resource or string

servletContextOrPortletContext - either a ServletContext or PortletContext instance.

Returns:

an iterable of the parsed YAML objects from the yamlConfig.

loadProxyMappings

public static List<ProxyMapping> loadProxyMappings(String yamlConfig,
                                   Object servletContextOrPortletContext)

Loads list of ProxyMapping objects from the yamlConfig.

Parameters:

yamlConfig - YAML configuration resource or string

servletContextOrPortletContext - either a ServletContext or PortletContext instance.

Returns:

a list of ProxyMapping objects from the yamlConfig.