JmxSupport (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.java.JmxSupport

All Implemented Interfaces:: UsesJava, UsesJmx

public class JmxSupport
extends java.lang.Object
implements UsesJmx

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.entity.java.UsesJmx
  UsesJmx.JmxAgentModes

Field Summary
- Fields inherited from interface brooklyn.entity.java.UsesJmx
  DEFAULT_JMX_PORT, JMX_AGENT_LOCAL_PATH, JMX_AGENT_MODE, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_PORT_LEGACY, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, JMX_USER, RMI_REGISTRY_PORT, USE_JMX
- Fields inherited from interface brooklyn.entity.java.UsesJava
  CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS, JAVA_VERSION_REQUIRED

Constructor Summary

Constructors
Constructor and Description

JmxSupport(Entity entity, java.lang.String runDir)
run dir may be null if it is not accessed

Constructors
Constructor and Description
`JmxSupport(Entity entity, java.lang.String runDir)` run dir may be null if it is not accessed

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyJmxJavaSystemProperties(MutableMap.Builder<java.lang.String,java.lang.Object> result)` applies _some_ of the common settings needed to connect via JMX
`Entity`	`getEntity()`
`java.lang.String`	`getJmxAgentJarBasename()` Deprecated. since 0.6.0; use `getJmxAgentJarMavenArtifact()`
`java.lang.String`	`getJmxAgentJarDestinationFilePath()`
`java.lang.String`	`getJmxAgentJarDestinationFilePathDefault()`
`MavenArtifact`	`getJmxAgentJarMavenArtifact()`
`java.lang.String`	`getJmxAgentJarUrl()` returns URL for accessing the java agent, throwing if not applicable; prefers on classpath where it should be, but will fall back to taking from maven hosted (known problem in Eclipse where JARs are not always copied)
`UsesJmx.JmxAgentModes`	`getJmxAgentMode()`
`java.util.List<java.lang.String>`	`getJmxJavaConfigOptions()`
`java.lang.String`	`getJmxUrl()`
`Maybe<SshMachineLocation>`	`getMachine()`
`java.lang.String`	`getRunDir()`
`void`	`install()` installs files needed for JMX, to the runDir given in constructor, assuming the runDir has been created
`boolean`	`isJmx()`
`boolean`	`isSecure()`
`void`	`recommendJmxRmiCustomAgent()` sets JMR_RMI_CUSTOM_AGENT as the connection mode for the indicated apps.
`void`	`setJmxUrl()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JmxSupport
```
public JmxSupport(Entity entity,
          @Nullable
          java.lang.String runDir)
```
    run dir may be null if it is not accessed
- Method Detail
  - getRunDir
```
@Nonnull
public java.lang.String getRunDir()
```
  - getEntity
```
public Entity getEntity()
```
  - getMachine
```
public Maybe<SshMachineLocation> getMachine()
```
  - isJmx
```
public boolean isJmx()
```
  - getJmxAgentMode
```
public UsesJmx.JmxAgentModes getJmxAgentMode()
```
  - isSecure
```
public boolean isSecure()
```
  - setJmxUrl
```
public void setJmxUrl()
```
  - getJmxUrl
```
public java.lang.String getJmxUrl()
```
  - getJmxJavaConfigOptions
```
public java.util.List<java.lang.String> getJmxJavaConfigOptions()
```
  - getJmxAgentJarDestinationFilePath
```
public java.lang.String getJmxAgentJarDestinationFilePath()
```
  - getJmxAgentJarDestinationFilePathDefault
```
public java.lang.String getJmxAgentJarDestinationFilePathDefault()
```
  - getJmxAgentJarMavenArtifact
```
@Nullable
public MavenArtifact getJmxAgentJarMavenArtifact()
```
  - getJmxAgentJarBasename
```
@Deprecated
public java.lang.String getJmxAgentJarBasename()
```
    Deprecated. since 0.6.0; use getJmxAgentJarMavenArtifact()
  - getJmxAgentJarUrl
```
public java.lang.String getJmxAgentJarUrl()
```
    returns URL for accessing the java agent, throwing if not applicable; prefers on classpath where it should be, but will fall back to taking from maven hosted (known problem in Eclipse where JARs are not always copied)
  - applyJmxJavaSystemProperties
```
public void applyJmxJavaSystemProperties(MutableMap.Builder<java.lang.String,java.lang.Object> result)
```
    applies _some_ of the common settings needed to connect via JMX
  - install
```
public void install()
```
    installs files needed for JMX, to the runDir given in constructor, assuming the runDir has been created
  - recommendJmxRmiCustomAgent
```
public void recommendJmxRmiCustomAgent()
```
    sets JMR_RMI_CUSTOM_AGENT as the connection mode for the indicated apps.
    TODO callers of this method have RMI dependencies in the actual app; we should look at removing them, so that those pieces of software can run behind forwarding public IP's and over SSL (both reasons JMXMP is preferred by us!)

Class JmxSupport

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.entity.java.UsesJmx

Field Summary

Fields inherited from interface brooklyn.entity.java.UsesJmx

Fields inherited from interface brooklyn.entity.java.UsesJava

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JmxSupport

Method Detail

getRunDir

getEntity

getMachine

isJmx

getJmxAgentMode

isSecure

setJmxUrl

getJmxUrl

getJmxJavaConfigOptions

getJmxAgentJarDestinationFilePath

getJmxAgentJarDestinationFilePathDefault

getJmxAgentJarMavenArtifact

getJmxAgentJarBasename

getJmxAgentJarUrl

applyJmxJavaSystemProperties

install

recommendJmxRmiCustomAgent