Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
h1. QMan MBean

...



{toc

...

:minLevel

...

=2

...

\|maxLevel

...

Description

QMan is exposed as MBean itself. That means its public interface will be available to any connected management client.

Attributes

N.A.

Operations

void addBroker

Operation Name

Description

Return Type

addBroker

Connects QMan with a broker using the given connection data.

void

Argument Name

Description

Type

Nullable

Note

host

The IP address or DNS name where Qpid Broker is running.

java.lang.String

No

N.A.

port

The port number where Qpid broker is running.

int

No

N.A.

username

The username used for estabilishing connection with Qpid broker

java.lang.String

No

N.A.

password

The password used for estabilishing connection with Qpid broker

java.lang.String

No

N.A.

virtualHost

The virtual host name

java.lang.String

No

N.A.

initialPoolCapacity

The number of physical connections (between 0 and a positive 32-bit integer) to create when creating the (broker) connection pool.

int

No

N.A.

maxPoolCapacity

The maximum number of physical database connections (between 0 and a positive 32-bit integer) that the (Qpid) connection pool can maintain.

int

No

N.A.

maxWaitTimeout

The maximum amount of time to wait for an idle connection

long

No

A value of -1 means "Wait forever"

Notifications

...

Type

...

Class

...

Description

=3}

h2. Description

QMan is exposed as MBean itself. That means its public interface will be available to any connected management client.

h2. Attributes

N.A.

h2. Operations


h3. void addBroker

|| Operation Name || Description || Return Type ||
| addBroker | Connects QMan with a broker using the given connection data. | void |

|| Argument Name || Description || Type || Nullable || Note ||
| host | The IP address or DNS name where Qpid Broker is running. | java.lang.String | No | N.A. |
| port | The port number where Qpid broker is running. | int | No | N.A. |
| username | The username used for estabilishing connection with Qpid broker | java.lang.String | No | N.A. |
| password | The password used for estabilishing connection with Qpid broker | java.lang.String | No | N.A. |
| virtualHost | The virtual host name | java.lang.String | No | N.A. |
| initialPoolCapacity | The number of physical connections (between 0 and a positive 32-bit integer) to create when creating the (broker) connection pool. | int | No | N.A. |
| maxPoolCapacity | The maximum number of physical database connections (between 0 and a positive 32-bit integer) that the (Qpid) connection pool can maintain. | int | No | N.A. |
| maxWaitTimeout | The maximum amount of time to wait for an idle connection | long | No | A value of \-1 means "Wait forever" |

h2. Notifications

|| Type || Class || Description ||
| org.apache.qpid.management.lifecycle.entity.schema.requested

...

 | org.apache.qpid.management.jmx.EntityLifecycleNotification

...

 | A schema request for a QMan entity has been sent.

...

 |
| org.apache.qpid.management.lifecycle.entity.schema.injected

...

 | org.apache.qpid.management.jmx.EntityLifecycleNotification

...

 | A schema has been injected on a QMan entity.

...

 |
| org.apache.qpid.management.lifecycle.error.schema

...

 | org.apache.qpid.management.jmx.EntityLifecycleNotification

...

 | Qman has received a malformed schema.

...

 |
| qman.lifecycle.entity.instance.created

...

 | org.apache.qpid.management.jmx.EntityLifecycleNotification

...

 | A new instance (event or object) has been created on QMan management domain.

...

 |
| qman.lifecycle.entity.instance.removed

...

 | org.apache.qpid.management.jmx.EntityLifecycleNotification

...

 | An object instance has been removed from QMan management domain. |
{dynamictasklist:To be done}