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

Method Detail

getFabricEnvironment

String getFabricEnvironment()

getFields

List<String> getFields(String className)

getFabricServiceStatus

ServiceStatusDTO getFabricServiceStatus()

createContainers

Map<String,String> createContainers(Map<String,Object> options)

importProfiles

void importProfiles(String versionId,
                  List<String> profileZipUrls)

createProfile

Map<String,Object> createProfile(String version,
                               String name)

createProfile

Map<String,Object> createProfile(String version,
                               String name,
                               List<String> parents)

changeProfileParents

Map<String,Object> changeProfileParents(String version,
                                      String name,
                                      List<String> parents)

profileWebAppURL

String profileWebAppURL(String webAppId,
                      String profileId,
                      String versionId)

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

containerWebAppURL

String containerWebAppURL(String webAppId,
                        String containerName)

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

createVersion

Map<String,Object> createVersion()

createVersion

Map<String,Object> createVersion(String version)

createVersion

Map<String,Object> createVersion(String parentVersionId,
                               String toVersion)

deleteProfile

void deleteProfile(String versionId,
                 String profileId)

deleteProfile

void deleteProfile(String versionId,
                 String profileId,
                 boolean force)

refreshProfile

void refreshProfile(String versionId,
                  String profileId)

deleteVersion

void deleteVersion(String version)

destroyContainer

void destroyContainer(String containerId)

getContainer

Map<String,Object> getContainer(String name)

getContainer

Map<String,Object> getContainer(String name,
                              List<String> fields)

addProfilesToContainer

void addProfilesToContainer(String container,
                          List<String> profiles)

removeProfilesFromContainer

void removeProfilesFromContainer(String container,
                               List<String> profiles)

applyVersionToContainers

void applyVersionToContainers(String version,
                            List<String> containers)

applyProfilesToContainers

void applyProfilesToContainers(String version,
                             List<String> profiles,
                             List<String> containers)

getContainerProvisionList

@Deprecated
List<String> getContainerProvisionList(String name)

Deprecated.

Parameters:

name -

Returns:

containers

List<Map<String,Object>> containers()

containers

List<Map<String,Object>> containers(List<String> fields)

containers

List<Map<String,Object>> containers(List<String> fields,
                                  List<String> profileFields)

containerMetadataType

String containerMetadataType(String id)

containerCreateOptionsType

String containerCreateOptionsType(String id)

changeCreateOptionsField

void changeCreateOptionsField(String containerId,
                            String field,
                            Object value)

containerIds

@Deprecated
String[] containerIds()

Deprecated.

Returns:

containerIdsForProfile

@Deprecated
List<String> containerIdsForProfile(String versionId,
                                             String profileId)

Deprecated.

Parameters:

versionId -

profileId -

Returns:

containersForProfile

List<Map<String,Object>> containersForProfile(String versionId,
                                            String profileId)

containersForProfile

List<Map<String,Object>> containersForProfile(String versionId,
                                            String profileId,
                                            List<String> fields)

setContainerProperty

void setContainerProperty(String containerId,
                        String property,
                        Object value)

containerIdsForVersion

@Deprecated
List<String> containerIdsForVersion(String versionId)

Deprecated.

Parameters:

versionId -

Returns:

containersForVersion

List<Map<String,Object>> containersForVersion(String versionId)

containersForVersion

List<Map<String,Object>> containersForVersion(String versionId,
                                            List<String> fields)

currentContainer

Map<String,Object> currentContainer()

getCurrentContainerName

String getCurrentContainerName()

getDefaultJvmOptions

String getDefaultJvmOptions()

getDefaultRepo

String getDefaultRepo()

defaultVersion

Map<String,Object> defaultVersion()

getDefaultVersion

String getDefaultVersion()

fabricStatus

FabricStatusDTO fabricStatus()

getMavenRepoUploadURI

String getMavenRepoUploadURI()

getMavenRepoURI

String getMavenRepoURI()

getProfile

Map<String,Object> getProfile(String versionId,
                            String profileId)

getProfile

Map<String,Object> getProfile(String versionId,
                            String profileId,
                            List<String> fields)

getProfileIds

@Deprecated
List<String> getProfileIds(String versionId)

Deprecated.

getProfileFeatures

Map<String,Object> getProfileFeatures(String versionId,
                                    String profileId)

getProfiles

List<Map<String,Object>> getProfiles(String versionId)

getProfiles

List<Map<String,Object>> getProfiles(String versionId,
                                   List<String> fields)

deleteConfigurationFile

void deleteConfigurationFile(String versionId,
                           String profileId,
                           String fileName)

getConfigurationFileNames

List<String> getConfigurationFileNames(String versionId,
                                     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

String getConfigurationFile(String versionId,
                          String profileId,
                          String fileName)

currentContainerConfigurationFiles

Map<String,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

Map<String,Object> getConfigurationFiles(String versionId,
                                       List<String> profileIds,
                                       String regex)

setConfigurationFile

void setConfigurationFile(String versionId,
                        String profileId,
                        String fileName,
                        String data)

getProfileProperties

Map<String,String> getProfileProperties(String versionId,
                                      String profileId,
                                      String pid)

Returns the profile properties for the given PID

setProfileProperties

boolean setProfileProperties(String versionId,
                           String profileId,
                           String pid,
                           Map<String,String> properties)

Sets the profile properties for the given PID

getProfileProperty

String getProfileProperty(String versionId,
                        String profileId,
                        String pid,
                        String propertyName)

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

setProfileProperty

String setProfileProperty(String versionId,
                        String profileId,
                        String pid,
                        String propertyName,
                        String value)

Sets the profile properties for the given PID and property name

setProfileBundles

void setProfileBundles(String versionId,
                     String profileId,
                     List<String> bundles)

setProfileFeatures

void setProfileFeatures(String versionId,
                      String profileId,
                      List<String> features)

setProfileRepositories

void setProfileRepositories(String versionId,
                          String profileId,
                          List<String> repositories)

setProfileFabs

void setProfileFabs(String versionId,
                  String profileId,
                  List<String> fabs)

setProfileOverrides

void setProfileOverrides(String versionId,
                       String profileId,
                       List<String> overrides)

setProfileAttribute

void setProfileAttribute(String versionId,
                       String profileId,
                       String attributeId,
                       String value)

requirements

io.fabric8.api.FabricRequirements requirements()

getVersion

Map<String,Object> getVersion(String versionId)

getVersion

Map<String,Object> getVersion(String versionId,
                            List<String> fields)

versions

List<Map<String,Object>> versions()

versions

List<Map<String,Object>> versions(List<String> fields)

copyProfile

void copyProfile(String versionId,
               String sourceId,
               String targetId,
               boolean force)

renameProfile

void renameProfile(String versionId,
                 String profileId,
                 String newId,
                 boolean force)

getZookeeperInfo

String getZookeeperInfo(String name)

getZookeeperUrl

String getZookeeperUrl()

registerProvider

void registerProvider(io.fabric8.api.ContainerProvider provider,
                    Map<String,Object> properties)

registerProvider

void registerProvider(String scheme,
                    io.fabric8.api.ContainerProvider provider)

setDefaultJvmOptions

void setDefaultJvmOptions(String jvmOptions)

setDefaultRepo

void setDefaultRepo(String defaultRepo)

setDefaultVersion

void setDefaultVersion(String versionId)

scaleProfile

boolean scaleProfile(String profile,
                   int numberOfInstances)
                     throws 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:

IOException

requirements

void requirements(io.fabric8.api.FabricRequirements requirements)
                  throws IOException

Throws:

IOException

requirementsJson

void requirementsJson(String json)
                      throws IOException

Allow the requirements to be passed in via JSON

Throws:

IOException

startContainer

void startContainer(String containerId)

startContainers

List<Map<String,Object>> startContainers(List<String> containerIds)

stopContainers

List<Map<String,Object>> stopContainers(List<String> containerIds)

stopContainer

void stopContainer(String containerId)

registeredProviders

Map<String,String> registeredProviders()

unregisterProvider

void unregisterProvider(io.fabric8.api.ContainerProvider provider,
                      Map<String,Object> properties)

unregisterProvider

void unregisterProvider(String scheme)

applyPatches

void applyPatches(List<String> files,
                String targetVersionId,
                String newVersionId,
                String proxyUser,
                String proxyPassword)

getConfigurationValue

String getConfigurationValue(String versionId,
                           String profileId,
                           String pid,
                           String key)

setConfigurationValue

void setConfigurationValue(String versionId,
                         String profileId,
                         String pid,
                         String key,
                         String value)

clusterJson

String clusterJson(String clusterPathSegment)
                   throws 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:

Exception

mavenProxyDownloadUrl

String mavenProxyDownloadUrl()

mavenProxyUploadUrl

String mavenProxyUploadUrl()