io.fabric8.api.jmx

Interface FabricManagerMBean

All Known Implementing Classes:

FabricManager

public interface FabricManagerMBean

An MBean for use by a Jolokia JMX connector. this MBean will not be usable remotely unless you use Jolokia or you have Fabric on your classpath!

Method Summary

Methods

Modifier and Type	Method and Description
void	addProfilesToContainer(java.lang.String container, java.util.List<java.lang.String> profiles)
void	applyPatches(java.util.List<java.lang.String> files, java.lang.String targetVersionId, java.lang.String newVersionId, java.lang.String proxyUser, java.lang.String proxyPassword)
void	applyProfilesToContainers(java.lang.String version, java.util.List<java.lang.String> profiles, java.util.List<java.lang.String> containers)
void	applyVersionToContainers(java.lang.String version, java.util.List<java.lang.String> containers)
void	changeCreateOptionsField(java.lang.String containerId, java.lang.String field, java.lang.Object value)
java.util.Map<java.lang.String,java.lang.Object>	changeProfileParents(java.lang.String version, java.lang.String name, java.util.List<java.lang.String> parents)
java.lang.String	clusterJson(java.lang.String clusterPathSegment) Returns the JSON for the cluster status for the given path.
java.lang.String	containerCreateOptionsType(java.lang.String id)
java.lang.String[]	containerIds() Deprecated.
java.util.List<java.lang.String>	containerIdsForProfile(java.lang.String versionId, java.lang.String profileId) Deprecated.
java.util.List<java.lang.String>	containerIdsForVersion(java.lang.String versionId) Deprecated.
java.lang.String	containerMetadataType(java.lang.String id)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containers()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containers(java.util.List<java.lang.String> fields)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containers(java.util.List<java.lang.String> fields, java.util.List<java.lang.String> profileFields)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containersForProfile(java.lang.String versionId, java.lang.String profileId)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containersForProfile(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> fields)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containersForVersion(java.lang.String versionId)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	containersForVersion(java.lang.String versionId, java.util.List<java.lang.String> fields)
java.lang.String	containerWebAppURL(java.lang.String webAppId, java.lang.String containerName) Returns the web app URL of the given given webAppId and container name
void	copyProfile(java.lang.String versionId, java.lang.String sourceId, java.lang.String targetId, boolean force)
java.util.Map<java.lang.String,java.lang.String>	createContainers(java.util.Map<java.lang.String,java.lang.Object> options)
java.util.Map<java.lang.String,java.lang.Object>	createProfile(java.lang.String version, java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	createProfile(java.lang.String version, java.lang.String name, java.util.List<java.lang.String> parents)
java.util.Map<java.lang.String,java.lang.Object>	createVersion()
java.util.Map<java.lang.String,java.lang.Object>	createVersion(java.lang.String version)
java.util.Map<java.lang.String,java.lang.Object>	createVersion(java.lang.String parentVersionId, java.lang.String toVersion)
java.util.Map<java.lang.String,java.lang.Object>	currentContainer()
java.util.Map<java.lang.String,java.lang.String>	currentContainerConfigurationFiles() Returns a map of all the current configuration files in the profiles of the current container with the file name as the key and the profile ID as the value
java.util.Map<java.lang.String,java.lang.Object>	defaultVersion()
void	deleteConfigurationFile(java.lang.String versionId, java.lang.String profileId, java.lang.String fileName)
void	deleteProfile(java.lang.String versionId, java.lang.String profileId)
void	deleteProfile(java.lang.String versionId, java.lang.String profileId, boolean force)
void	deleteVersion(java.lang.String version)
void	destroyContainer(java.lang.String containerId)
FabricStatusDTO	fabricStatus()
java.lang.String	getConfigurationFile(java.lang.String versionId, java.lang.String profileId, java.lang.String fileName)
java.util.List<java.lang.String>	getConfigurationFileNames(java.lang.String versionId, java.lang.String profileId) Returns all of the configuration files available in the given profile (with inheritance) returning a map of the file name to the profile which defines the
java.util.Map<java.lang.String,java.lang.Object>	getConfigurationFiles(java.lang.String versionId, java.util.List<java.lang.String> profileIds, java.lang.String regex)
java.lang.String	getConfigurationValue(java.lang.String versionId, java.lang.String profileId, java.lang.String pid, java.lang.String key)
java.util.Map<java.lang.String,java.lang.Object>	getContainer(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getContainer(java.lang.String name, java.util.List<java.lang.String> fields)
java.util.List<java.lang.String>	getContainerProvisionList(java.lang.String name) Deprecated.
java.lang.String	getCurrentContainerName()
java.lang.String	getDefaultJvmOptions()
java.lang.String	getDefaultRepo()
java.lang.String	getDefaultVersion()
java.lang.String	getFabricEnvironment()
ServiceStatusDTO	getFabricServiceStatus()
java.util.List<java.lang.String>	getFields(java.lang.String className)
java.lang.String	getMavenRepoUploadURI()
java.lang.String	getMavenRepoURI()
java.util.Map<java.lang.String,java.lang.Object>	getProfile(java.lang.String versionId, java.lang.String profileId)
java.util.Map<java.lang.String,java.lang.Object>	getProfile(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> fields)
java.util.Map<java.lang.String,java.lang.Object>	getProfileFeatures(java.lang.String versionId, java.lang.String profileId)
java.util.List<java.lang.String>	getProfileIds(java.lang.String versionId) Deprecated.
java.util.Map<java.lang.String,java.lang.String>	getProfileProperties(java.lang.String versionId, java.lang.String profileId, java.lang.String pid) Returns the profile properties for the given PID
java.lang.String	getProfileProperty(java.lang.String versionId, java.lang.String profileId, java.lang.String pid, java.lang.String propertyName) Returns the profile property value for the given PID and propery name
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getProfiles(java.lang.String versionId)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getProfiles(java.lang.String versionId, java.util.List<java.lang.String> fields)
java.util.Map<java.lang.String,java.lang.Object>	getVersion(java.lang.String versionId)
java.util.Map<java.lang.String,java.lang.Object>	getVersion(java.lang.String versionId, java.util.List<java.lang.String> fields)
java.lang.String	getZookeeperInfo(java.lang.String name)
java.lang.String	getZookeeperUrl()
java.lang.String	profileWebAppURL(java.lang.String webAppId, java.lang.String profileId, java.lang.String versionId) Returns the web app URL of the given webAppId, profile and version
void	refreshProfile(java.lang.String versionId, java.lang.String profileId)
java.util.Map<java.lang.String,java.lang.String>	registeredProviders()
void	registerProvider(ContainerProvider provider, java.util.Map<java.lang.String,java.lang.Object> properties)
void	registerProvider(java.lang.String scheme, ContainerProvider provider)
void	removeProfilesFromContainer(java.lang.String container, java.util.List<java.lang.String> profiles)
void	renameProfile(java.lang.String versionId, java.lang.String profileId, java.lang.String newId, boolean force)
FabricRequirements	requirements()
void	requirements(FabricRequirements requirements)
void	requirementsJson(java.lang.String json) Allow the requirements to be passed in via JSON
boolean	scaleProfile(java.lang.String profile, int numberOfInstances) Scales the given profile up or down in the number of instances required
void	setConfigurationFile(java.lang.String versionId, java.lang.String profileId, java.lang.String fileName, java.lang.String data)
void	setConfigurationValue(java.lang.String versionId, java.lang.String profileId, java.lang.String pid, java.lang.String key, java.lang.String value)
void	setContainerProperty(java.lang.String containerId, java.lang.String property, java.lang.Object value)
void	setDefaultJvmOptions(java.lang.String jvmOptions)
void	setDefaultRepo(java.lang.String defaultRepo)
void	setDefaultVersion(java.lang.String versionId)
void	setProfileAttribute(java.lang.String versionId, java.lang.String profileId, java.lang.String attributeId, java.lang.String value)
void	setProfileBundles(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> bundles)
void	setProfileFabs(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> fabs)
void	setProfileFeatures(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> features)
void	setProfileOverrides(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> overrides)
boolean	setProfileProperties(java.lang.String versionId, java.lang.String profileId, java.lang.String pid, java.util.Map<java.lang.String,java.lang.String> properties) Sets the profile properties for the given PID
java.lang.String	setProfileProperty(java.lang.String versionId, java.lang.String profileId, java.lang.String pid, java.lang.String propertyName, java.lang.String value) Sets the profile properties for the given PID and property name
void	setProfileRepositories(java.lang.String versionId, java.lang.String profileId, java.util.List<java.lang.String> repositories)
void	startContainer(java.lang.String containerId)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	startContainers(java.util.List<java.lang.String> containerIds)
void	stopContainer(java.lang.String containerId)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	stopContainers(java.util.List<java.lang.String> containerIds)
void	unregisterProvider(ContainerProvider provider, java.util.Map<java.lang.String,java.lang.Object> properties)
void	unregisterProvider(java.lang.String scheme)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	versions()
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	versions(java.util.List<java.lang.String> fields)

Method Detail

getFabricEnvironment

java.lang.String getFabricEnvironment()

getFields

java.util.List<java.lang.String> getFields(java.lang.String className)

getFabricServiceStatus

ServiceStatusDTO getFabricServiceStatus()

createContainers

java.util.Map<java.lang.String,java.lang.String> createContainers(java.util.Map<java.lang.String,java.lang.Object> options)

createProfile

java.util.Map<java.lang.String,java.lang.Object> createProfile(java.lang.String version,
                                                             java.lang.String name)

createProfile

java.util.Map<java.lang.String,java.lang.Object> createProfile(java.lang.String version,
                                                             java.lang.String name,
                                                             java.util.List<java.lang.String> parents)

changeProfileParents

java.util.Map<java.lang.String,java.lang.Object> changeProfileParents(java.lang.String version,
                                                                    java.lang.String name,
                                                                    java.util.List<java.lang.String> parents)

profileWebAppURL

java.lang.String profileWebAppURL(java.lang.String webAppId,
                                java.lang.String profileId,
                                java.lang.String versionId)

Returns the web app URL of the given webAppId, profile and version

containerWebAppURL

java.lang.String containerWebAppURL(java.lang.String webAppId,
                                  java.lang.String containerName)

Returns the web app URL of the given given webAppId and container name

createVersion

java.util.Map<java.lang.String,java.lang.Object> createVersion()

createVersion

java.util.Map<java.lang.String,java.lang.Object> createVersion(java.lang.String version)

createVersion

java.util.Map<java.lang.String,java.lang.Object> createVersion(java.lang.String parentVersionId,
                                                             java.lang.String toVersion)

deleteProfile

void deleteProfile(java.lang.String versionId,
                 java.lang.String profileId)

deleteProfile

void deleteProfile(java.lang.String versionId,
                 java.lang.String profileId,
                 boolean force)

refreshProfile

void refreshProfile(java.lang.String versionId,
                  java.lang.String profileId)

deleteVersion

void deleteVersion(java.lang.String version)

destroyContainer

void destroyContainer(java.lang.String containerId)

getContainer

java.util.Map<java.lang.String,java.lang.Object> getContainer(java.lang.String name)

getContainer

java.util.Map<java.lang.String,java.lang.Object> getContainer(java.lang.String name,
                                                            java.util.List<java.lang.String> fields)

addProfilesToContainer

void addProfilesToContainer(java.lang.String container,
                          java.util.List<java.lang.String> profiles)

removeProfilesFromContainer

void removeProfilesFromContainer(java.lang.String container,
                               java.util.List<java.lang.String> profiles)

applyVersionToContainers

void applyVersionToContainers(java.lang.String version,
                            java.util.List<java.lang.String> containers)

applyProfilesToContainers

void applyProfilesToContainers(java.lang.String version,
                             java.util.List<java.lang.String> profiles,
                             java.util.List<java.lang.String> containers)

getContainerProvisionList

@Deprecated
java.util.List<java.lang.String> getContainerProvisionList(java.lang.String name)

Deprecated.

Parameters:

name -

Returns:

containers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containers()

containers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containers(java.util.List<java.lang.String> fields)

containers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containers(java.util.List<java.lang.String> fields,
                                                                          java.util.List<java.lang.String> profileFields)

containerMetadataType

java.lang.String containerMetadataType(java.lang.String id)

containerCreateOptionsType

java.lang.String containerCreateOptionsType(java.lang.String id)

changeCreateOptionsField

void changeCreateOptionsField(java.lang.String containerId,
                            java.lang.String field,
                            java.lang.Object value)

containerIds

@Deprecated
java.lang.String[] containerIds()

Deprecated.

Returns:

containerIdsForProfile

@Deprecated
java.util.List<java.lang.String> containerIdsForProfile(java.lang.String versionId,
                                                                 java.lang.String profileId)

Deprecated.

Parameters:

versionId -

profileId -

Returns:

containersForProfile

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containersForProfile(java.lang.String versionId,
                                                                                    java.lang.String profileId)

containersForProfile

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containersForProfile(java.lang.String versionId,
                                                                                    java.lang.String profileId,
                                                                                    java.util.List<java.lang.String> fields)

setContainerProperty

void setContainerProperty(java.lang.String containerId,
                        java.lang.String property,
                        java.lang.Object value)

containerIdsForVersion

@Deprecated
java.util.List<java.lang.String> containerIdsForVersion(java.lang.String versionId)

Deprecated.

Parameters:

versionId -

Returns:

containersForVersion

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containersForVersion(java.lang.String versionId)

containersForVersion

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> containersForVersion(java.lang.String versionId,
                                                                                    java.util.List<java.lang.String> fields)

currentContainer

java.util.Map<java.lang.String,java.lang.Object> currentContainer()

getCurrentContainerName

java.lang.String getCurrentContainerName()

getDefaultJvmOptions

java.lang.String getDefaultJvmOptions()

getDefaultRepo

java.lang.String getDefaultRepo()

defaultVersion

java.util.Map<java.lang.String,java.lang.Object> defaultVersion()

getDefaultVersion

java.lang.String getDefaultVersion()

fabricStatus

FabricStatusDTO fabricStatus()

getMavenRepoUploadURI

java.lang.String getMavenRepoUploadURI()

getMavenRepoURI

java.lang.String getMavenRepoURI()

getProfile

java.util.Map<java.lang.String,java.lang.Object> getProfile(java.lang.String versionId,
                                                          java.lang.String profileId)

getProfile

java.util.Map<java.lang.String,java.lang.Object> getProfile(java.lang.String versionId,
                                                          java.lang.String profileId,
                                                          java.util.List<java.lang.String> fields)

getProfileIds

@Deprecated
java.util.List<java.lang.String> getProfileIds(java.lang.String versionId)

Deprecated.

getProfileFeatures

java.util.Map<java.lang.String,java.lang.Object> getProfileFeatures(java.lang.String versionId,
                                                                  java.lang.String profileId)

getProfiles

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getProfiles(java.lang.String versionId)

getProfiles

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getProfiles(java.lang.String versionId,
                                                                           java.util.List<java.lang.String> fields)

deleteConfigurationFile

void deleteConfigurationFile(java.lang.String versionId,
                           java.lang.String profileId,
                           java.lang.String fileName)

getConfigurationFileNames

java.util.List<java.lang.String> getConfigurationFileNames(java.lang.String versionId,
                                                         java.lang.String profileId)

Returns all of the configuration files available in the given profile (with inheritance) returning a map of the file name to the profile which defines the

getConfigurationFile

java.lang.String getConfigurationFile(java.lang.String versionId,
                                    java.lang.String profileId,
                                    java.lang.String fileName)

currentContainerConfigurationFiles

java.util.Map<java.lang.String,java.lang.String> currentContainerConfigurationFiles()

Returns a map of all the current configuration files in the profiles of the current container with the file name as the key and the profile ID as the value

getConfigurationFiles

java.util.Map<java.lang.String,java.lang.Object> getConfigurationFiles(java.lang.String versionId,
                                                                     java.util.List<java.lang.String> profileIds,
                                                                     java.lang.String regex)

setConfigurationFile

void setConfigurationFile(java.lang.String versionId,
                        java.lang.String profileId,
                        java.lang.String fileName,
                        java.lang.String data)

getProfileProperties

java.util.Map<java.lang.String,java.lang.String> getProfileProperties(java.lang.String versionId,
                                                                    java.lang.String profileId,
                                                                    java.lang.String pid)

Returns the profile properties for the given PID

setProfileProperties

boolean setProfileProperties(java.lang.String versionId,
                           java.lang.String profileId,
                           java.lang.String pid,
                           java.util.Map<java.lang.String,java.lang.String> properties)

Sets the profile properties for the given PID

getProfileProperty

java.lang.String getProfileProperty(java.lang.String versionId,
                                  java.lang.String profileId,
                                  java.lang.String pid,
                                  java.lang.String propertyName)

Returns the profile property value for the given PID and propery name

setProfileProperty

java.lang.String setProfileProperty(java.lang.String versionId,
                                  java.lang.String profileId,
                                  java.lang.String pid,
                                  java.lang.String propertyName,
                                  java.lang.String value)

Sets the profile properties for the given PID and property name

setProfileBundles

void setProfileBundles(java.lang.String versionId,
                     java.lang.String profileId,
                     java.util.List<java.lang.String> bundles)

setProfileFeatures

void setProfileFeatures(java.lang.String versionId,
                      java.lang.String profileId,
                      java.util.List<java.lang.String> features)

setProfileRepositories

void setProfileRepositories(java.lang.String versionId,
                          java.lang.String profileId,
                          java.util.List<java.lang.String> repositories)

setProfileFabs

void setProfileFabs(java.lang.String versionId,
                  java.lang.String profileId,
                  java.util.List<java.lang.String> fabs)

setProfileOverrides

void setProfileOverrides(java.lang.String versionId,
                       java.lang.String profileId,
                       java.util.List<java.lang.String> overrides)

setProfileAttribute

void setProfileAttribute(java.lang.String versionId,
                       java.lang.String profileId,
                       java.lang.String attributeId,
                       java.lang.String value)

requirements

FabricRequirements requirements()

getVersion

java.util.Map<java.lang.String,java.lang.Object> getVersion(java.lang.String versionId)

getVersion

java.util.Map<java.lang.String,java.lang.Object> getVersion(java.lang.String versionId,
                                                          java.util.List<java.lang.String> fields)

versions

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> versions()

versions

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> versions(java.util.List<java.lang.String> fields)

copyProfile

void copyProfile(java.lang.String versionId,
               java.lang.String sourceId,
               java.lang.String targetId,
               boolean force)

renameProfile

void renameProfile(java.lang.String versionId,
                 java.lang.String profileId,
                 java.lang.String newId,
                 boolean force)

getZookeeperInfo

java.lang.String getZookeeperInfo(java.lang.String name)

getZookeeperUrl

java.lang.String getZookeeperUrl()

registerProvider

void registerProvider(ContainerProvider provider,
                    java.util.Map<java.lang.String,java.lang.Object> properties)

registerProvider

void registerProvider(java.lang.String scheme,
                    ContainerProvider provider)

setDefaultJvmOptions

void setDefaultJvmOptions(java.lang.String jvmOptions)

setDefaultRepo

void setDefaultRepo(java.lang.String defaultRepo)

setDefaultVersion

void setDefaultVersion(java.lang.String versionId)

scaleProfile

boolean scaleProfile(java.lang.String profile,
                   int numberOfInstances)
                     throws java.io.IOException

Scales the given profile up or down in the number of instances required

Parameters:

profile - the profile ID to change the requirements

numberOfInstances - the number of instances to increase or decrease

Returns:

true if the requiremetns changed

Throws:

java.io.IOException

requirements

void requirements(FabricRequirements requirements)
                  throws java.io.IOException

Throws:

java.io.IOException

requirementsJson

void requirementsJson(java.lang.String json)
                      throws java.io.IOException

Allow the requirements to be passed in via JSON

Throws:

java.io.IOException

startContainer

void startContainer(java.lang.String containerId)

startContainers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> startContainers(java.util.List<java.lang.String> containerIds)

stopContainers

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> stopContainers(java.util.List<java.lang.String> containerIds)

stopContainer

void stopContainer(java.lang.String containerId)

registeredProviders

java.util.Map<java.lang.String,java.lang.String> registeredProviders()

unregisterProvider

void unregisterProvider(ContainerProvider provider,
                      java.util.Map<java.lang.String,java.lang.Object> properties)

unregisterProvider

void unregisterProvider(java.lang.String scheme)

applyPatches

void applyPatches(java.util.List<java.lang.String> files,
                java.lang.String targetVersionId,
                java.lang.String newVersionId,
                java.lang.String proxyUser,
                java.lang.String proxyPassword)

getConfigurationValue

java.lang.String getConfigurationValue(java.lang.String versionId,
                                     java.lang.String profileId,
                                     java.lang.String pid,
                                     java.lang.String key)

setConfigurationValue

void setConfigurationValue(java.lang.String versionId,
                         java.lang.String profileId,
                         java.lang.String pid,
                         java.lang.String key,
                         java.lang.String value)

clusterJson

java.lang.String clusterJson(java.lang.String clusterPathSegment)
                             throws java.lang.Exception

Returns the JSON for the cluster status for the given path.

Parameters:

clusterPathSegment - if null or an empty string is used then the path "/fabric/registry/clusters" is used; if the value starts with "/" then its treated as an absolute path otherwise it is appended to "/fabric/registry/clusters/" to access a relative path. e.g. you can supply "apis" to find all the APIs, or "webapps" for all the webapps.

Throws:

java.lang.Exception