io.fabric8.maven.core.util

Class ProfileUtil

java.lang.Object

io.fabric8.maven.core.util.ProfileUtil

public class ProfileUtil
extends Object

Helper class for dealing with profiles.

Since:

25/07/16

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProfileUtil.ProcessorConfigurationExtractor

Field Summary

Fields

Modifier and Type	Field and Description
static ProfileUtil.ProcessorConfigurationExtractor	ENRICHER_CONFIG Get the enricher configuration
static ProfileUtil.ProcessorConfigurationExtractor	GENERATOR_CONFIG Get the generator configuration
static String[]	PROFILE_FILENAMES

Constructor Summary

Constructors

Constructor and Description
ProfileUtil()

Method Summary

Modifier and Type	Method and Description
static ProcessorConfig	extractProcesssorConfiguration(ProcessorConfig given, ProfileUtil.ProcessorConfigurationExtractor extractor, String profile, File resourceDir) Find an enricher or generator config, possibly via a profile
static Profile	findProfile(String profile, File resourceDir) Find a profile.
static List<Profile>	fromYaml(InputStream is) Load a profile from an input stream.
static Profile	lookup(String name, File directory) Lookup profiles from a given directory
static Map<String,Profile>	readAllFromClasspath() Read all profiles found in the classpath.

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_FILENAMES

public static final String[] PROFILE_FILENAMES

GENERATOR_CONFIG

public static final ProfileUtil.ProcessorConfigurationExtractor GENERATOR_CONFIG

Get the generator configuration

ENRICHER_CONFIG

public static final ProfileUtil.ProcessorConfigurationExtractor ENRICHER_CONFIG

Get the enricher configuration

Constructor Detail

ProfileUtil

public ProfileUtil()

Method Detail

findProfile

public static Profile findProfile(String profile,
                                  File resourceDir)
                           throws IOException

Find a profile. Profiles are looked up at various locations:

• A given directory with the name profiles.yml (and variations, findProfile(String, File)

Parameters:

profile - the profile's name

resourceDir - a directory to check for profiles.

Returns:

the profile found

Throws:

IOException

extractProcesssorConfiguration

public static ProcessorConfig extractProcesssorConfiguration(ProcessorConfig given,
                                                             ProfileUtil.ProcessorConfigurationExtractor extractor,
                                                             String profile,
                                                             File resourceDir)
                                                      throws IOException

Find an enricher or generator config, possibly via a profile

Parameters:

given - a given config which should be used directly

extractor - how to extract the config from a profile when found

profile - the profile name (can be null, then no profile is used)

resourceDir - resource directory where to lookup the profile (in addition to a classpath lookup)

Returns:

the configuration found or null if none could be found

Throws:

MojoExecutionException

IOException

readAllFromClasspath

public static Map<String,Profile> readAllFromClasspath()
                                                throws IOException

Read all profiles found in the classpath.

Returns:

map of profiles, keyed by their names

Throws:

IOException - if reading of a profile fails

lookup

public static Profile lookup(String name,
                             File directory)
                      throws IOException

Lookup profiles from a given directory

Parameters:

name - name of the profile to lookup

directory - directory to lookup

Returns:

Profile found or null

Throws:

IOException - if somethings fails during lookup

fromYaml

public static List<Profile> fromYaml(InputStream is)
                              throws IOException

Load a profile from an input stream. This must be in YAML format

Parameters:

is - inputstream to read the profile from

Returns:

the de-serialized profile

Throws:

IOException - if deserialization fails