org.eclipse.jkube.kit.profile

Class ProfileUtil

java.lang.Object

org.eclipse.jkube.kit.profile.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 String	DEFAULT_PROFILE
static ProfileUtil.ProcessorConfigurationExtractor	ENRICHER_CONFIG Get the enricher configuration
static ProfileUtil.ProcessorConfigurationExtractor	GENERATOR_CONFIG Get the generator configuration
static ProfileUtil.ProcessorConfigurationExtractor	WATCHER_CONFIG Get the watcher configuration

Method Summary

Modifier and Type	Method and Description
static ProcessorConfig	blendProfileWithConfiguration(ProfileUtil.ProcessorConfigurationExtractor configExtractor, String profile, List<File> resourceDirs, ProcessorConfig config) Find an enricher or generator config, possibly via a profile and merge it with a given configuration.
static Profile	findProfile(String profileArg, File... resourceDirs) Find a profile.
static Profile	findProfile(String profileArg, List<File> resourceDirs)
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 and merge it with a profile of the same name found in the classpath
static List<Profile>	readAllFromClasspath(String name, String ext) 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

DEFAULT_PROFILE

public static final String DEFAULT_PROFILE

See Also:

Constant Field Values

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

WATCHER_CONFIG

public static final ProfileUtil.ProcessorConfigurationExtractor WATCHER_CONFIG

Get the watcher configuration

Method Detail

findProfile

public static Profile findProfile(String profileArg,
                                  List<File> resourceDirs)
                           throws IOException

Throws:

IOException

findProfile

public static Profile findProfile(String profileArg,
                                  File... resourceDirs)
                           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:

profileArg - the profile's name

resourceDirs - directories to check for profiles.

Returns:

the profile found or the default profile if none of this name is given

Throws:

IOException - if there's a problem while performing IO operations.

blendProfileWithConfiguration

public static ProcessorConfig blendProfileWithConfiguration(ProfileUtil.ProcessorConfigurationExtractor configExtractor,
                                                            String profile,
                                                            List<File> resourceDirs,
                                                            ProcessorConfig config)
                                                     throws IOException

Find an enricher or generator config, possibly via a profile and merge it with a given configuration.

Parameters:

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

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

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

config - the provided configuration

Returns:

the merged configuration which can be empty if no profile is given

Throws:

IOException

lookup

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

Lookup profiles from a given directory and merge it with a profile of the same name found in the classpath

Parameters:

name - name of the profile to lookup

directory - directory to lookup

Returns:

Profile found or null

Throws:

IOException - if somethings fails during lookup

readAllFromClasspath

public static List<Profile> readAllFromClasspath(String name,
                                                 String ext)
                                          throws IOException

Read all profiles found in the classpath.

Parameters:

name - name of the profile to lookup

ext - to use (e.g. 'default' for checking 'profile-default.yml'. Can also be null or empty.

Returns:

all profiles with this name stored in files with this extension

Throws:

IOException - if reading of a profile fails

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