io.fabric8.api

Class Profiles

java.lang.Object

io.fabric8.api.Profiles

public class Profiles
extends Object

Helper methods for working with profiles

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROFILE_FOLDER_SUFFIX
static boolean	useDirectoriesForProfiles Should we convert a directory of profiles called "foo-bar" into a directory "foo/bar.profile" structure to use the file system better, to better organise profiles into folders and make it easier to work with profiles in the wiki

Constructor Summary

Constructors

Constructor and Description
Profiles()

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertValidProfileId(Set<String> profileIds, String profileId) Asserts that the given profile ID is in the given set of profile IDs, throwing an exception if its not valid
static String	convertProfileIdToPath(String profileId) Converts a profile ID into a path for the folder in a file system, git or on the web
static Map<String,String>	getConfigurationFileNameMap(Profile[] profiles) Returns the configuration file names for the given profile
static List<String>	getConfigurationFileNames(Collection<Profile> profiles) Returns the configuration file names for the given profile
static byte[]	getFileConfiguration(Collection<Profile> profiles, String fileName) Returns the configuration file data for the given file name and list of inherited profiles
static Map<String,String>	getOverlayConfiguration(FabricService fabricService, Iterable<String> profileIds, String versionId, String pid) Returns the overlay configuration for the given list of profile ids and the configuration PID.
static Map<String,Map<String,String>>	getOverlayFactoryConfigurations(FabricService fabricService, Iterable<String> profileIds, String versionId, String pid) Returns the overlay factory configurations for the given list of profile ids which start with the given pid.
static String	getProfileIconURL(Profile[] profiles) Returns the icon URL of the given list of profiles relative to the REST API URL or null if it could not be determined
static List<Profile>	getProfiles(FabricService fabricService, Iterable<String> profileIds, String versionId) Returns the Profile objects for the given list of profile ids for the given version
static String	getSummaryMarkdown(Profile[] profiles) Returns the first summary markdown text of the profiles
static Profile	profile(Profile[] profiles, String profileId) Returns the profile for the given id if it exists in the array or null
static List<String>	profileIds(Iterable<Profile> profiles)
static List<String>	profileIds(Profile... profiles)
static String	versionId(Version version)
static List<String>	versionIds(Iterable<Version> versions)
static List<String>	versionIds(Version... versions)

Methods inherited from class java.lang.Object

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

Field Detail

useDirectoriesForProfiles

public static final boolean useDirectoriesForProfiles

Should we convert a directory of profiles called "foo-bar" into a directory "foo/bar.profile" structure to use the file system better, to better organise profiles into folders and make it easier to work with profiles in the wiki

See Also:

Constant Field Values

PROFILE_FOLDER_SUFFIX

public static final String PROFILE_FOLDER_SUFFIX

See Also:

Constant Field Values

Constructor Detail

Profiles

public Profiles()

Method Detail

profileIds

public static List<String> profileIds(Iterable<Profile> profiles)

profileIds

public static List<String> profileIds(Profile... profiles)

versionId

public static String versionId(Version version)

versionIds

public static List<String> versionIds(Version... versions)

versionIds

public static List<String> versionIds(Iterable<Version> versions)

profile

public static Profile profile(Profile[] profiles,
              String profileId)

Returns the profile for the given id if it exists in the array or null

getConfigurationFileNames

public static List<String> getConfigurationFileNames(Collection<Profile> profiles)

Returns the configuration file names for the given profile

getFileConfiguration

public static byte[] getFileConfiguration(Collection<Profile> profiles,
                          String fileName)

Returns the configuration file data for the given file name and list of inherited profiles

getConfigurationFileNameMap

public static Map<String,String> getConfigurationFileNameMap(Profile[] profiles)

Returns the configuration file names for the given profile

getOverlayConfiguration

public static Map<String,String> getOverlayConfiguration(FabricService fabricService,
                                         Iterable<String> profileIds,
                                         String versionId,
                                         String pid)

Returns the overlay configuration for the given list of profile ids and the configuration PID. This method will find the overlay profile for each profile id and combine all the configurations together. Usually we would use the Profile objects directly; but this API call is useful when creating new containers; letting us figure out the effective overlay before a container exists.

getOverlayFactoryConfigurations

public static Map<String,Map<String,String>> getOverlayFactoryConfigurations(FabricService fabricService,
                                                             Iterable<String> profileIds,
                                                             String versionId,
                                                             String pid)

Returns the overlay factory configurations for the given list of profile ids which start with the given pid. (e.g. of the form "$pid-foo.properties" This method will find the overlay profile for each profile id and combine all the configurations together. Usually we would use the Profile objects directly; but this API call is useful when creating new containers; letting us figure out the effective overlay before a container exists.

getProfiles

public static List<Profile> getProfiles(FabricService fabricService,
                        Iterable<String> profileIds,
                        String versionId)

Returns the Profile objects for the given list of profile ids for the given version

convertProfileIdToPath

public static String convertProfileIdToPath(String profileId)

Converts a profile ID into a path for the folder in a file system, git or on the web

Returns:

the path to the profile (appending the .profile postfix etc)

getProfileIconURL

public static String getProfileIconURL(Profile[] profiles)

Returns the icon URL of the given list of profiles relative to the REST API URL or null if it could not be determined

getSummaryMarkdown

public static String getSummaryMarkdown(Profile[] profiles)

Returns the first summary markdown text of the profiles

assertValidProfileId

public static void assertValidProfileId(Set<String> profileIds,
                        String profileId)

Asserts that the given profile ID is in the given set of profile IDs, throwing an exception if its not valid