io.fabric8.api

Interface Profile

All Superinterfaces:

Comparable<Profile>, HasId

public interface Profile
extends Comparable<Profile>, HasId

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSTRACT The attribute key for the abstract flag
static String	DELETED Key indicating a deletion.
static String	DESCRIPTION The attribute key for the description of the profile
static String	HASH
static String	HIDDEN The attribute key for the hidden flag
static String	LOCKED The attribute key for the locked flag
static String	PARENTS The attribute key for the list of parents

Method Summary

Methods

Modifier and Type	Method and Description
boolean	agentConfigurationEquals(Profile other) Checks if the two Profiles share the same agent configuration.
boolean	configurationEquals(Profile other)
void	delete()
void	delete(boolean force)
boolean	exists() Checks if the profile exists.
Container[]	getAssociatedContainers()
Map<String,String>	getAttributes() Returns a read only map of all the attributes of this profile
List<String>	getBundles()
Map<String,String>	getConfiguration(String pid) Returns the configuration properties for the given PID
List<String>	getConfigurationFileNames() Returns the configuration file names that are available on this profile
Map<String,Map<String,String>>	getConfigurations() Returns all of the configuration properties
Map<String,String>	getContainerConfiguration() Returns the configuration properties for the container
List<String>	getEndorsedLibraries()
List<String>	getExtensionLibraries()
List<String>	getFabs()
List<String>	getFeatures()
byte[]	getFileConfiguration(String fileName) Returns the configuration file for the given name
Map<String,byte[]>	getFileConfigurations()
List<String>	getLibraries()
Profile	getOverlay() Gets profile with configuration slitted with parents.
Profile	getOverlay(boolean substitute) Same as getOverlay() but also perform variable substitutions
List<String>	getOverrides()
Profile[]	getParents()
String	getProfileHash()
List<String>	getRepositories()
String	getVersion()
boolean	isAbstract() Returns true if this profile is Abstract.
boolean	isHidden() Returns true if this profile is hidden.
boolean	isLocked() Returns true if this profile is locked.
boolean	isOverlay() Indicate if this profile is an overlay or not.
void	refresh() Manually trigger provisioning of this profile
void	setAttribute(String key, String value) Change an attribute on this version.
void	setBundles(List<String> values)
void	setConfiguration(String pid, Map<String,String> configuration) Update configurations of this profile with the new values for the given PID
void	setConfigurations(Map<String,Map<String,String>> configurations) Update configurations of this profile with the new values
void	setFabs(List<String> values)
void	setFeatures(List<String> values)
void	setFileConfigurations(Map<String,byte[]> configurations) Update configurations of this profile with the new values
void	setOverrides(List<String> values)
void	setParents(Profile[] parents)
void	setRepositories(List<String> values)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.fabric8.api.HasId

getId

Field Detail

PARENTS

static final String PARENTS

The attribute key for the list of parents

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

The attribute key for the description of the profile

See Also:

Constant Field Values

LOCKED

static final String LOCKED

The attribute key for the locked flag

See Also:

Constant Field Values

ABSTRACT

static final String ABSTRACT

The attribute key for the abstract flag

See Also:

Constant Field Values

HIDDEN

static final String HIDDEN

The attribute key for the hidden flag

See Also:

Constant Field Values

HASH

static final String HASH

See Also:

Constant Field Values

DELETED

static final String DELETED

Key indicating a deletion. This value can appear as the value of a key in a configuration or as a key itself. If used as a key, the whole configuration is flagged has been deleted from its parent when computing the overlay.

See Also:

Constant Field Values

Method Detail

getVersion

String getVersion()

getAttributes

Map<String,String> getAttributes()

Returns a read only map of all the attributes of this profile

Returns:

setAttribute

void setAttribute(String key,
                String value)

Change an attribute on this version.

Parameters:

key - the name of the attribute

value - the new value or null to delete the attribute

getParents

Profile[] getParents()

setParents

void setParents(Profile[] parents)

getAssociatedContainers

Container[] getAssociatedContainers()

getLibraries

List<String> getLibraries()

getEndorsedLibraries

List<String> getEndorsedLibraries()

getExtensionLibraries

List<String> getExtensionLibraries()

getBundles

List<String> getBundles()

getFabs

List<String> getFabs()

getFeatures

List<String> getFeatures()

getRepositories

List<String> getRepositories()

getOverrides

List<String> getOverrides()

getConfigurationFileNames

List<String> getConfigurationFileNames()

Returns the configuration file names that are available on this profile

getFileConfigurations

Map<String,byte[]> getFileConfigurations()

getFileConfiguration

byte[] getFileConfiguration(String fileName)

Returns the configuration file for the given name

setFileConfigurations

void setFileConfigurations(Map<String,byte[]> configurations)

Update configurations of this profile with the new values

Parameters:

configurations -

getConfigurations

Map<String,Map<String,String>> getConfigurations()

Returns all of the configuration properties

getConfiguration

Map<String,String> getConfiguration(String pid)

Returns the configuration properties for the given PID

getContainerConfiguration

Map<String,String> getContainerConfiguration()

Returns the configuration properties for the container

setConfigurations

void setConfigurations(Map<String,Map<String,String>> configurations)

Update configurations of this profile with the new values

Parameters:

configurations -

setConfiguration

void setConfiguration(String pid,
                    Map<String,String> configuration)

Update configurations of this profile with the new values for the given PID

Parameters:

configuration - is the new configuration value for the given PID

getOverlay

Profile getOverlay()

Gets profile with configuration slitted with parents.

Returns:

Calculated profile or null if instance is already a calculated overlay.

getOverlay

Profile getOverlay(boolean substitute)

Same as getOverlay() but also perform variable substitutions

Parameters:

substitute -

Returns:

isOverlay

boolean isOverlay()

Indicate if this profile is an overlay or not.

Returns:

delete

void delete()

delete

void delete(boolean force)

setBundles

void setBundles(List<String> values)

setFabs

void setFabs(List<String> values)

setFeatures

void setFeatures(List<String> values)

setRepositories

void setRepositories(List<String> values)

setOverrides

void setOverrides(List<String> values)

configurationEquals

boolean configurationEquals(Profile other)

agentConfigurationEquals

boolean agentConfigurationEquals(Profile other)

Checks if the two Profiles share the same agent configuration.

Parameters:

other -

Returns:

exists

boolean exists()

Checks if the profile exists.

Returns:

refresh

void refresh()

Manually trigger provisioning of this profile

isAbstract

boolean isAbstract()

Returns true if this profile is Abstract. Abstract profiles should not be provisioned by default, they are intended to be inherited

isLocked

boolean isLocked()

Returns true if this profile is locked. Locked profiles can't be modified.

Returns:

isHidden

boolean isHidden()

Returns true if this profile is hidden. Hidden profiles are not listed by default.

Returns:

getProfileHash

String getProfileHash()