io.fabric8.api

Class FabricRequirements

java.lang.Object

io.fabric8.api.FabricRequirements

public class FabricRequirements
extends Object

Allows the requirements of a profile to be defined so that we can do automatic provisioning, can ensure that required services stay running and can provide health checks

Constructor Summary

Constructors

Constructor and Description
FabricRequirements()
FabricRequirements(List<ProfileRequirements> profileRequirements)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrUpdateProfileRequirements(ProfileRequirements requirement)
ProfileRequirements	findProfileRequirements(String profile)
ProfileRequirements	getOrCreateProfileRequirement(String profile) Returns or creates a new ProfileRequirements for the given profile id
List<ProfileRequirements>	getProfileRequirements()
SshConfiguration	getSshConfiguration()
Map<String,SshHostConfiguration>	getSshHostsMap()
String	getVersion() Returns the current version for the fabric which the requirements apply to (usually the latest version, as scaling requirements typically are independent of rolling upgrades and versioning).
boolean	hasMinimumInstances(String profileId) Returns true if there are any requirements for the given profile ID and it has at least 1 minimum instances defined
ProfileRequirements	profile(String profileId) Returns the requirements for the given profile; lazily creating requirements if none exist yet.
void	removeEmptyRequirements() Removes all the empty requirements; usually used just before saving to JSON
boolean	removeProfileRequirements(String profile)
void	setProfileRequirements(List<ProfileRequirements> profileRequirements)
void	setSshConfiguration(SshConfiguration sshConfiguration)
void	setVersion(String version)
protected void	sortProfilesRequirements()
SshConfiguration	sshConfiguration() Returns the ssh configuration; lazily creating one if it does not exist yet
SshHostConfiguration	sshHost(String hostAlias) Looks up and lazily creates if required a SSH host configuration for the given host alias.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FabricRequirements

public FabricRequirements()

FabricRequirements

public FabricRequirements(List<ProfileRequirements> profileRequirements)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getProfileRequirements

public List<ProfileRequirements> getProfileRequirements()

setProfileRequirements

public void setProfileRequirements(List<ProfileRequirements> profileRequirements)

getVersion

public String getVersion()

Returns the current version for the fabric which the requirements apply to (usually the latest version, as scaling requirements typically are independent of rolling upgrades and versioning).

setVersion

public void setVersion(String version)

getSshConfiguration

public SshConfiguration getSshConfiguration()

setSshConfiguration

public void setSshConfiguration(SshConfiguration sshConfiguration)

getSshHostsMap

public Map<String,SshHostConfiguration> getSshHostsMap()

getOrCreateProfileRequirement

public ProfileRequirements getOrCreateProfileRequirement(String profile)

Returns or creates a new ProfileRequirements for the given profile id

findProfileRequirements

public ProfileRequirements findProfileRequirements(String profile)

removeProfileRequirements

public boolean removeProfileRequirements(String profile)

addOrUpdateProfileRequirements

public void addOrUpdateProfileRequirements(ProfileRequirements requirement)

sortProfilesRequirements

protected void sortProfilesRequirements()

removeEmptyRequirements

public void removeEmptyRequirements()

Removes all the empty requirements; usually used just before saving to JSON

hasMinimumInstances

public boolean hasMinimumInstances(String profileId)

Returns true if there are any requirements for the given profile ID and it has at least 1 minimum instances defined

sshHost

public SshHostConfiguration sshHost(String hostAlias)

Looks up and lazily creates if required a SSH host configuration for the given host alias. The host name will be defaulted to the same hostAlias value for cases when the alias is the same as the actual host name

profile

public ProfileRequirements profile(String profileId)

Returns the requirements for the given profile; lazily creating requirements if none exist yet.

sshConfiguration

public SshConfiguration sshConfiguration()

Returns the ssh configuration; lazily creating one if it does not exist yet