org.apache.qpid.server.model.adapter

Class BrokerAdapter

java.lang.Object

org.apache.qpid.server.model.AbstractConfiguredObject<BrokerAdapter>

org.apache.qpid.server.model.adapter.BrokerAdapter

All Implemented Interfaces:

EventLoggerProvider, Broker<BrokerAdapter>, ConfiguredObject<BrokerAdapter>, StatisticsGatherer

public class BrokerAdapter
extends AbstractConfiguredObject<BrokerAdapter>
implements Broker<BrokerAdapter>, StatisticsGatherer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrokerAdapter.ThreadStackContent

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANAGEMENT_MODE_AUTHENTICATION

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

Fields inherited from interface org.apache.qpid.server.model.Broker

BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE, BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD, BROKER_FLOW_TO_DISK_THRESHOLD, BROKER_MESSAGE_COMPRESSION_ENABLED, BROKER_MSG_AUTH, BUILD_VERSION, CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT, CONFIDENTIAL_CONFIGURATION_ENCRYPTION_PROVIDER, CONNECTION_CLOSE_WHEN_NO_ROUTE, CONNECTION_HEART_BEAT_DELAY, CONNECTION_SESSION_COUNT_LIMIT, DEFAULT_AMQP_PORT_NUMBER, DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE, DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD, DEFAULT_BROKER_MSG_AUTH, DEFAULT_BROKER_NAME, DEFAULT_CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT, DEFAULT_FILESYSTEM_MAX_USAGE_PERCENT, DEFAULT_FLOW_TO_DISK_THRESHOLD, DEFAULT_HTTP_PORT_NUMBER, DEFAULT_JMX_PORT_NUMBER, DEFAULT_MESSAGE_COMPRESSION_ENABLED, DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE, DEFAULT_NETWORK_BUFFER_SIZE, DEFAULT_RMI_PORT_NUMBER, DEFAULT_SECURITY_TLS_CIPHER_SUITE_BLACK_LIST, DEFAULT_SECURITY_TLS_CIPHER_SUITE_WHITE_LIST, DEFAULT_SECURITY_TLS_PROTOCOL_BLACK_LIST, DEFAULT_SECURITY_TLS_PROTOCOL_WHITE_LIST, DEFAULT_SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP, MESSAGE_COMPRESSION_THRESHOLD_SIZE, MINIMUM_NETWORK_BUFFER_SIZE, MODEL_VERSION, NETWORK_BUFFER_SIZE, OPERATING_SYSTEM, PLATFORM, PROCESS_PID, PRODUCT_VERSION, QPID_AMQP_PORT, QPID_HTTP_PORT, QPID_JMX_PORT, QPID_RMI_PORT, SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP, STATISTICS_REPORTING_PERIOD, STATISTICS_REPORTING_RESET_ENABLED, STORE_FILESYSTEM_MAX_USAGE_PERCENT, STORE_PATH

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

CONTEXT, CREATED_BY, CREATED_TIME, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Constructor Summary

Constructors

Constructor and Description
BrokerAdapter(Map<String,Object> attributes, SystemConfig parent)

Method Summary

Modifier and Type	Method and Description
<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	addChildAsync(Class<C> childClass, Map<String,Object> attributes, ConfiguredObject... otherParents)
void	assignTargetSizes()
protected com.google.common.util.concurrent.ListenableFuture<Void>	beforeClose()
VirtualHostNode	findDefautVirtualHostNode()
Content	findThreadStackTraces(String threadNameFindExpression)
VirtualHost<?,?,?>	findVirtualHostByName(String name)
Collection<AccessControlProvider<?>>	getAccessControlProviders()
Collection<AuthenticationProvider<?>>	getAuthenticationProviders()
static Collection<String>	getAvailableConfigurationEncrypters()
String	getBuildVersion()
long	getBytesIn()
long	getBytesOut()
String	getConfidentialConfigurationEncryptionProvider()
boolean	getConnection_closeWhenNoRoute()
int	getConnection_heartBeatDelay()
int	getConnection_sessionCountLimit()
StatisticsCounter	getDataDeliveryStatistics() Gives access to the StatisticsCounter that is used to count delivered message size statistics.
StatisticsCounter	getDataReceiptStatistics() Gives access to the StatisticsCounter that is used to count received message size statistics.
long	getDirectMemoryTotalCapacity()
EventLogger	getEventLogger()
Collection<GroupProvider<?>>	getGroupProviders()
List<String>	getJvmArguments()
Collection<KeyStore<?>>	getKeyStores()
AuthenticationProvider<?>	getManagementModeAuthenticationProvider()
static long	getMaxDirectMemorySize()
long	getMaximumDirectMemorySize()
long	getMaximumHeapMemorySize()
StatisticsCounter	getMessageDeliveryStatistics() Gives access to the StatisticsCounter that is used to count delivered message statistics.
StatisticsCounter	getMessageReceiptStatistics() Gives access to the StatisticsCounter that is used to count received message statistics.
long	getMessagesIn()
long	getMessagesOut()
String	getModelVersion()
int	getNetworkBufferSize()
int	getNumberOfCores()
int	getNumberOfLiveThreads()
int	getNumberOfObjectsPendingFinalization()
String	getOperatingSystem()
String	getPlatform()
Collection<Port<?>>	getPorts()
String	getProcessPid()
String	getProductVersion()
SecurityManager	getSecurityManager() A temporary hack to expose security manager via broker instance.
int	getStatisticsReportingPeriod()
boolean	getStatisticsReportingResetEnabled()
Content	getThreadStackTraces(boolean appendToLog)
Collection<TrustStore<?>>	getTrustStores()
long	getUsedDirectMemorySize()
long	getUsedHeapMemorySize()
Collection<VirtualHostNode<?>>	getVirtualHostNodes()
void	initiateShutdown()
boolean	isManagementMode()
boolean	isMessageCompressionEnabled()
boolean	isVirtualHostPropertiesNodeEnabled()
protected void	onClose()
protected void	onExceptionInOpen(RuntimeException e) Callback method to perform ConfiguredObject specific exception handling on exception in open.
protected void	onOpen()
void	onValidate() Validation performed for configured object creation and opening.
void	performGC()
protected void	postResolve()
protected void	postResolveChildren()
void	registerMessageDelivered(long messageSize) This method is responsible for registering the delivery of a message with the counters.
void	registerMessageReceived(long messageSize, long timestamp) This method is responsible for registering the receipt of a message with the counters, and also for passing this notification to any parent StatisticsGatherers.
void	resetStatistics() Reset the counters for this, and any child StatisticsGatherers.
void	setEventLogger(EventLogger eventLogger)
protected void	validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

addChangeListener, applyToChildren, asObjectRecord, attainState, attributeSet, authoriseCreate, authoriseCreateChild, authoriseDelete, authoriseSetAttributes, changeAttribute, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleted, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getTaskExecutor, getType, getTypeClass, handleExceptionOnOpen, isDurable, managesChildStorage, notifyStateChanged, onCreate, onResolve, open, openAsync, parentsMap, registerWithParents, removeChangeListener, rethrowRuntimeExceptionsOnOpen, runTask, setAttribute, setAttributes, setAttributesAsync, setEncrypter, setState, start, startAsync, stop, toString, validateOnCreate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

addChangeListener, asObjectRecord, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getTaskExecutor, getType, getTypeClass, isDurable, managesChildStorage, open, openAsync, removeChangeListener, setAttribute, setAttributes, setAttributesAsync

Field Detail

MANAGEMENT_MODE_AUTHENTICATION

public static final String MANAGEMENT_MODE_AUTHENTICATION

See Also:

Constant Field Values

Constructor Detail

BrokerAdapter

public BrokerAdapter(Map<String,Object> attributes,
                     SystemConfig parent)

Method Detail

postResolve

protected void postResolve()

Overrides:

postResolve in class AbstractConfiguredObject<BrokerAdapter>

postResolveChildren

protected void postResolveChildren()

Overrides:

postResolveChildren in class AbstractConfiguredObject<BrokerAdapter>

onValidate

public void onValidate()

Description copied from class: AbstractConfiguredObject

Validation performed for configured object creation and opening.

Overrides:

onValidate in class AbstractConfiguredObject<BrokerAdapter>

validateChange

protected void validateChange(ConfiguredObject<?> proxyForValidation,
                              Set<String> changedAttributes)

Overrides:

validateChange in class AbstractConfiguredObject<BrokerAdapter>

initiateShutdown

public void initiateShutdown()

Specified by:

initiateShutdown in interface Broker<BrokerAdapter>

getBuildVersion

public String getBuildVersion()

Specified by:

getBuildVersion in interface Broker<BrokerAdapter>

getOperatingSystem

public String getOperatingSystem()

Specified by:

getOperatingSystem in interface Broker<BrokerAdapter>

getPlatform

public String getPlatform()

Specified by:

getPlatform in interface Broker<BrokerAdapter>

getProcessPid

public String getProcessPid()

Specified by:

getProcessPid in interface Broker<BrokerAdapter>

getProductVersion

public String getProductVersion()

Specified by:

getProductVersion in interface Broker<BrokerAdapter>

getNumberOfCores

public int getNumberOfCores()

Specified by:

getNumberOfCores in interface Broker<BrokerAdapter>

getConnection_sessionCountLimit

public int getConnection_sessionCountLimit()

Specified by:

getConnection_sessionCountLimit in interface Broker<BrokerAdapter>

getConnection_heartBeatDelay

public int getConnection_heartBeatDelay()

Specified by:

getConnection_heartBeatDelay in interface Broker<BrokerAdapter>

getConnection_closeWhenNoRoute

public boolean getConnection_closeWhenNoRoute()

Specified by:

getConnection_closeWhenNoRoute in interface Broker<BrokerAdapter>

getStatisticsReportingPeriod

public int getStatisticsReportingPeriod()

Specified by:

getStatisticsReportingPeriod in interface Broker<BrokerAdapter>

getStatisticsReportingResetEnabled

public boolean getStatisticsReportingResetEnabled()

Specified by:

getStatisticsReportingResetEnabled in interface Broker<BrokerAdapter>

isMessageCompressionEnabled

public boolean isMessageCompressionEnabled()

Specified by:

isMessageCompressionEnabled in interface Broker<BrokerAdapter>

getConfidentialConfigurationEncryptionProvider

public String getConfidentialConfigurationEncryptionProvider()

Specified by:

getConfidentialConfigurationEncryptionProvider in interface Broker<BrokerAdapter>

getModelVersion

public String getModelVersion()

Specified by:

getModelVersion in interface Broker<BrokerAdapter>

getVirtualHostNodes

public Collection<VirtualHostNode<?>> getVirtualHostNodes()

Specified by:

getVirtualHostNodes in interface Broker<BrokerAdapter>

getPorts

public Collection<Port<?>> getPorts()

Specified by:

getPorts in interface Broker<BrokerAdapter>

getAuthenticationProviders

public Collection<AuthenticationProvider<?>> getAuthenticationProviders()

Specified by:

getAuthenticationProviders in interface Broker<BrokerAdapter>

assignTargetSizes

public void assignTargetSizes()

Specified by:

assignTargetSizes in interface Broker<BrokerAdapter>

onOpen

protected void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<BrokerAdapter>

getGroupProviders

public Collection<GroupProvider<?>> getGroupProviders()

Specified by:

getGroupProviders in interface Broker<BrokerAdapter>

getBytesIn

public long getBytesIn()

Specified by:

getBytesIn in interface Broker<BrokerAdapter>

getBytesOut

public long getBytesOut()

Specified by:

getBytesOut in interface Broker<BrokerAdapter>

getMessagesIn

public long getMessagesIn()

Specified by:

getMessagesIn in interface Broker<BrokerAdapter>

getMessagesOut

public long getMessagesOut()

Specified by:

getMessagesOut in interface Broker<BrokerAdapter>

addChildAsync

public <C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> addChildAsync(Class<C> childClass,
                                                                                                        Map<String,Object> attributes,
                                                                                                        ConfiguredObject... otherParents)

Overrides:

addChildAsync in class AbstractConfiguredObject<BrokerAdapter>

beforeClose

protected com.google.common.util.concurrent.ListenableFuture<Void> beforeClose()

Overrides:

beforeClose in class AbstractConfiguredObject<BrokerAdapter>

onClose

protected void onClose()

Overrides:

onClose in class AbstractConfiguredObject<BrokerAdapter>

getSecurityManager

public SecurityManager getSecurityManager()

Description copied from interface: Broker

A temporary hack to expose security manager via broker instance. TODO We need to add and implement an authorization provider configured object instead

Specified by:

getSecurityManager in interface Broker<BrokerAdapter>

Overrides:

getSecurityManager in class AbstractConfiguredObject<BrokerAdapter>

findVirtualHostByName

public VirtualHost<?,?,?> findVirtualHostByName(String name)

Specified by:

findVirtualHostByName in interface Broker<BrokerAdapter>

findDefautVirtualHostNode

public VirtualHostNode findDefautVirtualHostNode()

Specified by:

findDefautVirtualHostNode in interface Broker<BrokerAdapter>

getKeyStores

public Collection<KeyStore<?>> getKeyStores()

Specified by:

getKeyStores in interface Broker<BrokerAdapter>

getTrustStores

public Collection<TrustStore<?>> getTrustStores()

Specified by:

getTrustStores in interface Broker<BrokerAdapter>

isManagementMode

public boolean isManagementMode()

Specified by:

isManagementMode in interface Broker<BrokerAdapter>

getAccessControlProviders

public Collection<AccessControlProvider<?>> getAccessControlProviders()

Specified by:

getAccessControlProviders in interface Broker<BrokerAdapter>

getEventLogger

public EventLogger getEventLogger()

Specified by:

getEventLogger in interface EventLoggerProvider

Specified by:

getEventLogger in interface Broker<BrokerAdapter>

setEventLogger

public void setEventLogger(EventLogger eventLogger)

Specified by:

setEventLogger in interface Broker<BrokerAdapter>

onExceptionInOpen

protected void onExceptionInOpen(RuntimeException e)

Description copied from class: AbstractConfiguredObject

Callback method to perform ConfiguredObject specific exception handling on exception in open.

The method is not expected to throw any runtime exception.

Overrides:

onExceptionInOpen in class AbstractConfiguredObject<BrokerAdapter>

Parameters:

e - open exception

registerMessageDelivered

public void registerMessageDelivered(long messageSize)

Description copied from interface: StatisticsGatherer

This method is responsible for registering the delivery of a message with the counters. Message delivery is recorded by the counter using the current system time, as opposed to the message timestamp.

Specified by:

registerMessageDelivered in interface StatisticsGatherer

Parameters:

messageSize - the size in bytes of the delivered message

See Also:

StatisticsGatherer.registerMessageReceived(long, long)

registerMessageReceived

public void registerMessageReceived(long messageSize,
                                    long timestamp)

Description copied from interface: StatisticsGatherer

This method is responsible for registering the receipt of a message with the counters, and also for passing this notification to any parent StatisticsGatherers. If statistics generation is not enabled, then this method should simple delegate to the parent gatherer.

Specified by:

registerMessageReceived in interface StatisticsGatherer

Parameters:

messageSize - the size in bytes of the delivered message

timestamp - the time the message was delivered

getMessageReceiptStatistics

public StatisticsCounter getMessageReceiptStatistics()

Description copied from interface: StatisticsGatherer

Gives access to the StatisticsCounter that is used to count received message statistics.

Specified by:

getMessageReceiptStatistics in interface StatisticsGatherer

Returns:

the StatisticsCounter that counts received messages

getDataReceiptStatistics

public StatisticsCounter getDataReceiptStatistics()

Description copied from interface: StatisticsGatherer

Gives access to the StatisticsCounter that is used to count received message size statistics.

Specified by:

getDataReceiptStatistics in interface StatisticsGatherer

Returns:

the StatisticsCounter that counts received bytes

getMessageDeliveryStatistics

public StatisticsCounter getMessageDeliveryStatistics()

Description copied from interface: StatisticsGatherer

Gives access to the StatisticsCounter that is used to count delivered message statistics.

Specified by:

getMessageDeliveryStatistics in interface StatisticsGatherer

Returns:

the StatisticsCounter that counts delivered messages

getDataDeliveryStatistics

public StatisticsCounter getDataDeliveryStatistics()

Description copied from interface: StatisticsGatherer

Gives access to the StatisticsCounter that is used to count delivered message size statistics.

Specified by:

getDataDeliveryStatistics in interface StatisticsGatherer

Returns:

the StatisticsCounter that counts delivered bytes

resetStatistics

public void resetStatistics()

Description copied from interface: StatisticsGatherer

Reset the counters for this, and any child StatisticsGatherers.

Specified by:

resetStatistics in interface StatisticsGatherer

isVirtualHostPropertiesNodeEnabled

public boolean isVirtualHostPropertiesNodeEnabled()

Specified by:

isVirtualHostPropertiesNodeEnabled in interface Broker<BrokerAdapter>

getManagementModeAuthenticationProvider

public AuthenticationProvider<?> getManagementModeAuthenticationProvider()

Specified by:

getManagementModeAuthenticationProvider in interface Broker<BrokerAdapter>

getAvailableConfigurationEncrypters

public static Collection<String> getAvailableConfigurationEncrypters()

getMaxDirectMemorySize

public static long getMaxDirectMemorySize()

getNetworkBufferSize

public int getNetworkBufferSize()

Specified by:

getNetworkBufferSize in interface Broker<BrokerAdapter>

getNumberOfLiveThreads

public int getNumberOfLiveThreads()

Specified by:

getNumberOfLiveThreads in interface Broker<BrokerAdapter>

getMaximumHeapMemorySize

public long getMaximumHeapMemorySize()

Specified by:

getMaximumHeapMemorySize in interface Broker<BrokerAdapter>

getUsedHeapMemorySize

public long getUsedHeapMemorySize()

Specified by:

getUsedHeapMemorySize in interface Broker<BrokerAdapter>

getMaximumDirectMemorySize

public long getMaximumDirectMemorySize()

Specified by:

getMaximumDirectMemorySize in interface Broker<BrokerAdapter>

getUsedDirectMemorySize

public long getUsedDirectMemorySize()

Specified by:

getUsedDirectMemorySize in interface Broker<BrokerAdapter>

getDirectMemoryTotalCapacity

public long getDirectMemoryTotalCapacity()

Specified by:

getDirectMemoryTotalCapacity in interface Broker<BrokerAdapter>

getNumberOfObjectsPendingFinalization

public int getNumberOfObjectsPendingFinalization()

Specified by:

getNumberOfObjectsPendingFinalization in interface Broker<BrokerAdapter>

getJvmArguments

public List<String> getJvmArguments()

Specified by:

getJvmArguments in interface Broker<BrokerAdapter>

performGC

public void performGC()

Specified by:

performGC in interface Broker<BrokerAdapter>

getThreadStackTraces

public Content getThreadStackTraces(boolean appendToLog)

Specified by:

getThreadStackTraces in interface Broker<BrokerAdapter>

findThreadStackTraces

public Content findThreadStackTraces(String threadNameFindExpression)

Specified by:

findThreadStackTraces in interface Broker<BrokerAdapter>