Package org.apache.qpid.server.model

Class BrokerImpl

java.lang.Object

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

org.apache.qpid.server.model.AbstractContainer<BrokerImpl>

org.apache.qpid.server.model.BrokerImpl

All Implemented Interfaces:

EventLoggerProvider, Broker<BrokerImpl>, ConfiguredObject<BrokerImpl>, Container<BrokerImpl>, ContextProvider, PermissionedObject, TaskExecutorProvider, StatisticsGatherer, UserPreferencesCreator

public class BrokerImpl
extends AbstractContainer<BrokerImpl>
implements Broker<BrokerImpl>

Nested Class Summary

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

AbstractContainer.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	Description
static String	MANAGEMENT_MODE_AUTHENTICATION

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

_eventLogger, _houseKeepingTaskExecutor, _parent

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_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION, BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD, BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE, BROKER_FLOW_TO_DISK_THRESHOLD, BROKER_MESSAGE_COMPRESSION_ENABLED, BROKER_MSG_AUTH, BROKER_SHUTDOWN_TIMEOUT, BROKER_STATISTICS_REPORING_PERIOD, BROKER_TYPE, BUILD_VERSION, CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT, COMPACT_MEMORY_INTERVAL, COMPACT_MEMORY_THRESHOLD, DEFAULT_AMQP_PORT_NUMBER, DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE, DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION, DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD, DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE, DEFAULT_BROKER_HOUSEKEEPING_CHECK_PERIOD, DEFAULT_BROKER_MSG_AUTH, DEFAULT_BROKER_NAME, DEFAULT_BROKER_SHUTDOWN_TIMEOUT, DEFAULT_CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT, DEFAULT_COMPACT_MEMORY_INTERVAL, DEFAULT_COMPACT_MEMORY_THRESHOLD, DEFAULT_DOCUMENTATION_URL, DEFAULT_FILESYSTEM_MAX_USAGE_PERCENT, DEFAULT_FLOW_TO_DISK_THRESHOLD, DEFAULT_HOUSEKEEPING_THREAD_COUNT, DEFAULT_HTTP_PORT_NUMBER, DEFAULT_MESSAGE_COMPRESSION_ENABLED, DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE, DEFAULT_NETWORK_BUFFER_SIZE, DEFAULT_SECURITY_TLS_CIPHER_SUITE_ALLOW_LIST, DEFAULT_SECURITY_TLS_CIPHER_SUITE_DENY_LIST, DEFAULT_SECURITY_TLS_PROTOCOL_ALLOW_LIST, DEFAULT_SECURITY_TLS_PROTOCOL_DENY_LIST, DEFAULT_SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP, DEFAULT_STATISTICS_REPORTING_PERIOD, MESSAGE_COMPRESSION_THRESHOLD_SIZE, MINIMUM_NETWORK_BUFFER_SIZE, MODEL_VERSION, NETWORK_BUFFER_SIZE, OPERATING_SYSTEM, PLATFORM, PREFERENCE_STORE_ATTRIBUTES, PROCESS_PID, PRODUCT_VERSION, PROPERTY_DISABLED_FEATURES, QPID_AMQP_PORT, QPID_BROKER_HOUSEKEEPING_CHECK_PERIOD, QPID_DOCUMENTATION_URL, QPID_HTTP_PORT, SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP, STATISTICS_REPORTING_PERIOD, STORE_FILESYSTEM_MAX_USAGE_PERCENT, STORE_PATH

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

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

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

CONFIDENTIAL_CONFIGURATION_ENCRYPTION_PROVIDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected <C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	addChildAsync(Class<C> childClass, Map<String,Object> attributes)
void	assignTargetSizes()
protected com.google.common.util.concurrent.ListenableFuture<Void>	beforeClose()
protected void	changeAttributes(Map<String,Object> attributes)
void	compactMemory()
UserPreferences	createUserPreferences(ConfiguredObject<?> object)
Map<String,Object>	extractConfig(boolean includeSecureAttributes)
VirtualHostNode	findDefautVirtualHostNode()
VirtualHost<?>	findVirtualHostByName(String name)
AccessControl	getAccessControl()
Collection<AccessControlProvider<?>>	getAccessControlProviders()
Collection<AuthenticationProvider<?>>	getAuthenticationProviders()
long	getBytesIn()	Returns a number of received bytes
long	getBytesOut()	Returns a number of delivered bytes
long	getCompactMemoryInterval()
long	getCompactMemoryThreshold()
SocketConnectionMetaData	getConnectionMetaData()
String	getDocumentationUrl()
long	getFlowToDiskThreshold()
Collection<GroupProvider<?>>	getGroupProviders()
Set<Principal>	getGroups()
long	getHousekeepingCheckPeriod()
long	getInboundMessageSizeHighWatermark()
Collection<KeyStore<?>>	getKeyStores()
AuthenticationProvider<?>	getManagementModeAuthenticationProvider()
long	getMessagesIn()	Returns a number of received messages
long	getMessagesOut()	Returns a number of delivered messages
int	getNetworkBufferSize()
long	getNumberOfBuffersInPool()
long	getNumberOfBuffersInUse()
Collection<Port<?>>	getPorts()
int	getShutdownTimeout()
double	getSparsityFraction()
int	getStatisticsReportingPeriod()
NamedAddressSpace	getSystemAddressSpace(String name)
long	getTransactedMessagesIn()
long	getTransactedMessagesOut()
Collection<TrustStore<?>>	getTrustStores()
Principal	getUser()
Collection<VirtualHostNode<?>>	getVirtualHostNodes()
void	initiateShutdown()
boolean	isManagementMode()
boolean	isMessageCompressionEnabled()
boolean	isVirtualHostPropertiesNodeEnabled()
protected void	logOperation(String operation)
protected com.google.common.util.concurrent.ListenableFuture<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.
protected void	postResolve()
protected void	postResolveChildren()
void	purgeUser(AuthenticationProvider<?> origin, String username)
void	registerMessageDelivered(long messageSize)	This method is responsible for registering the delivery of a message with the counters.
void	registerMessageReceived(long messageSize)	This method is responsible for registering the receipt of a message with the counters.
void	registerTransactedMessageDelivered()
void	registerTransactedMessageReceived()
void	resetStatistics()
void	restart()
protected void	validateChange(ConfiguredObject<?> proxyForValidation, Set<String> changedAttributes)
protected void	validateChildDelete(ConfiguredObject<?> child)

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

findThreadStackTraces, getAvailableConfigurationEncrypters, getBuildVersion, getConfidentialConfigurationEncryptionProvider, getDirectMemoryTotalCapacity, getEventLogger, getHousekeepingThreadCount, getJvmArguments, getMaximumDirectMemorySize, getMaximumHeapMemorySize, getModelVersion, getNumberOfCores, getNumberOfLiveThreads, getNumberOfObjectsPendingFinalization, getOperatingSystem, getPlatform, getProcessPid, getProductVersion, getThreadStackTraces, getUsedDirectMemorySize, getUsedHeapMemorySize, performGC, scheduleHouseKeepingTask, scheduleTask, setEventLogger

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

addChangeListener, addFutureCallback, applyToChildren, asObjectRecord, attainState, attributesAsString, attributeSet, authorise, authorise, authorise, authoriseCreateChild, awaitChildClassToAttainState, awaitChildClassToAttainState, beforeDelete, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleteChildren, deleteNoChecks, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, getActualAttributes, getAncestor, 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, getStatistics, getSubjectWithAddedSystemRights, getSystemPrincipal, getSystemTaskControllerContext, getSystemTaskSubject, getSystemTaskSubject, getTaskExecutor, getType, getTypeClass, getUserPreferences, handleExceptionOnOpen, hasEncrypter, isDurable, isSystemProcess, isSystemSubject, logCreated, logDeleted, logRecovered, logUpdated, managesChildStorage, newToken, notifyStateChanged, onCreate, onDelete, onResolve, open, openAsync, postSetAttributes, registerWithParents, removeChangeListener, removeContextVariable, rethrowRuntimeExceptionsOnOpen, runTask, setAttributes, setAttributesAsync, setContextVariable, setEncrypter, setState, setUserPreferences, start, startAsync, stop, toString, updateModel, 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.Broker

findThreadStackTraces, getBuildVersion, getConfidentialConfigurationEncryptionProvider, getDirectMemoryTotalCapacity, getEventLogger, getHousekeepingThreadCount, getJvmArguments, getMaximumDirectMemorySize, getMaximumHeapMemorySize, getModelVersion, getNumberOfCores, getNumberOfLiveThreads, getNumberOfObjectsPendingFinalization, getOperatingSystem, getPlatform, getProcessPid, getProductVersion, getThreadStackTraces, getUsedDirectMemorySize, getUsedHeapMemorySize, performGC, scheduleHouseKeepingTask, scheduleTask, setEventLogger

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

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

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

getContextKeys, getContextValue, getContextValue

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

getTaskExecutor

Field Detail

MANAGEMENT_MODE_AUTHENTICATION

public static final String MANAGEMENT_MODE_AUTHENTICATION

See Also:

Constant Field Values

Constructor Detail

BrokerImpl

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

Method Detail

postResolve

protected void postResolve()

Overrides:

postResolve in class AbstractConfiguredObject<BrokerImpl>

postResolveChildren

protected void postResolveChildren()

Overrides:

postResolveChildren in class AbstractContainer<BrokerImpl>

onValidate

public void onValidate()

Description copied from class: AbstractConfiguredObject

Validation performed for configured object creation and opening.

Overrides:

onValidate in class AbstractConfiguredObject<BrokerImpl>

validateChange

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

Overrides:

validateChange in class AbstractConfiguredObject<BrokerImpl>

changeAttributes

protected void changeAttributes(Map<String,Object> attributes)

Overrides:

changeAttributes in class AbstractConfiguredObject<BrokerImpl>

validateChildDelete

protected void validateChildDelete(ConfiguredObject<?> child)

Overrides:

validateChildDelete in class AbstractConfiguredObject<BrokerImpl>

initiateShutdown

public void initiateShutdown()

Specified by:

initiateShutdown in interface Broker<BrokerImpl>

extractConfig

public Map<String,Object> extractConfig(boolean includeSecureAttributes)

Specified by:

extractConfig in interface Broker<BrokerImpl>

getShutdownTimeout

public int getShutdownTimeout()

Specified by:

getShutdownTimeout in interface Broker<BrokerImpl>

getStatisticsReportingPeriod

public int getStatisticsReportingPeriod()

Specified by:

getStatisticsReportingPeriod in interface Broker<BrokerImpl>

isMessageCompressionEnabled

public boolean isMessageCompressionEnabled()

Specified by:

isMessageCompressionEnabled in interface Broker<BrokerImpl>

getVirtualHostNodes

public Collection<VirtualHostNode<?>> getVirtualHostNodes()

Specified by:

getVirtualHostNodes in interface Broker<BrokerImpl>

getPorts

public Collection<Port<?>> getPorts()

Specified by:

getPorts in interface Broker<BrokerImpl>

getAuthenticationProviders

public Collection<AuthenticationProvider<?>> getAuthenticationProviders()

Specified by:

getAuthenticationProviders in interface Broker<BrokerImpl>

assignTargetSizes

public void assignTargetSizes()

Specified by:

assignTargetSizes in interface Broker<BrokerImpl>

onOpen

protected void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<BrokerImpl>

getSystemAddressSpace

public NamedAddressSpace getSystemAddressSpace(String name)

Specified by:

getSystemAddressSpace in interface Broker<BrokerImpl>

getGroupProviders

public Collection<GroupProvider<?>> getGroupProviders()

Specified by:

getGroupProviders in interface Broker<BrokerImpl>

addChildAsync

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

Overrides:

addChildAsync in class AbstractConfiguredObject<BrokerImpl>

beforeClose

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

Overrides:

beforeClose in class AbstractConfiguredObject<BrokerImpl>

onClose

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

Overrides:

onClose in class AbstractConfiguredObject<BrokerImpl>

createUserPreferences

public UserPreferences createUserPreferences(ConfiguredObject<?> object)

Specified by:

createUserPreferences in interface UserPreferencesCreator

getAccessControl

public AccessControl getAccessControl()

Overrides:

getAccessControl in class AbstractConfiguredObject<BrokerImpl>

findVirtualHostByName

public VirtualHost<?> findVirtualHostByName(String name)

Specified by:

findVirtualHostByName in interface Broker<BrokerImpl>

findDefautVirtualHostNode

public VirtualHostNode findDefautVirtualHostNode()

Specified by:

findDefautVirtualHostNode in interface Broker<BrokerImpl>

getKeyStores

public Collection<KeyStore<?>> getKeyStores()

Specified by:

getKeyStores in interface Broker<BrokerImpl>

getTrustStores

public Collection<TrustStore<?>> getTrustStores()

Specified by:

getTrustStores in interface Broker<BrokerImpl>

isManagementMode

public boolean isManagementMode()

Specified by:

isManagementMode in interface Broker<BrokerImpl>

getAccessControlProviders

public Collection<AccessControlProvider<?>> getAccessControlProviders()

Specified by:

getAccessControlProviders in interface Broker<BrokerImpl>

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<BrokerImpl>

Parameters:

e - open exception

logOperation

protected void logOperation(String operation)

Overrides:

logOperation in class AbstractConfiguredObject<BrokerImpl>

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.

Specified by:

registerMessageDelivered in interface StatisticsGatherer

Parameters:

messageSize - the size in bytes of the delivered message

registerTransactedMessageReceived

public void registerTransactedMessageReceived()

Specified by:

registerTransactedMessageReceived in interface StatisticsGatherer

registerTransactedMessageDelivered

public void registerTransactedMessageDelivered()

Specified by:

registerTransactedMessageDelivered in interface StatisticsGatherer

registerMessageReceived

public void registerMessageReceived(long messageSize)

Description copied from interface: StatisticsGatherer

This method is responsible for registering the receipt of a message with the counters.

Specified by:

registerMessageReceived in interface StatisticsGatherer

Parameters:

messageSize - the size in bytes of the delivered message

getFlowToDiskThreshold

public long getFlowToDiskThreshold()

Specified by:

getFlowToDiskThreshold in interface Broker<BrokerImpl>

getNumberOfBuffersInUse

public long getNumberOfBuffersInUse()

Specified by:

getNumberOfBuffersInUse in interface Broker<BrokerImpl>

getNumberOfBuffersInPool

public long getNumberOfBuffersInPool()

Specified by:

getNumberOfBuffersInPool in interface Broker<BrokerImpl>

getInboundMessageSizeHighWatermark

public long getInboundMessageSizeHighWatermark()

Specified by:

getInboundMessageSizeHighWatermark in interface Broker<BrokerImpl>

getMessagesIn

public long getMessagesIn()

Description copied from interface: StatisticsGatherer

Returns a number of received messages

Specified by:

getMessagesIn in interface Broker<BrokerImpl>

Specified by:

getMessagesIn in interface StatisticsGatherer

Returns:

the number of received messages

getBytesIn

public long getBytesIn()

Description copied from interface: StatisticsGatherer

Returns a number of received bytes

Specified by:

getBytesIn in interface Broker<BrokerImpl>

Specified by:

getBytesIn in interface StatisticsGatherer

Returns:

the number of received bytes

getMessagesOut

public long getMessagesOut()

Description copied from interface: StatisticsGatherer

Returns a number of delivered messages

Specified by:

getMessagesOut in interface Broker<BrokerImpl>

Specified by:

getMessagesOut in interface StatisticsGatherer

Returns:

the number of delivered messages

getBytesOut

public long getBytesOut()

Description copied from interface: StatisticsGatherer

Returns a number of delivered bytes

Specified by:

getBytesOut in interface Broker<BrokerImpl>

Specified by:

getBytesOut in interface StatisticsGatherer

Returns:

the number of delivered bytes

getTransactedMessagesIn

public long getTransactedMessagesIn()

Specified by:

getTransactedMessagesIn in interface Broker<BrokerImpl>

getTransactedMessagesOut

public long getTransactedMessagesOut()

Specified by:

getTransactedMessagesOut in interface Broker<BrokerImpl>

isVirtualHostPropertiesNodeEnabled

public boolean isVirtualHostPropertiesNodeEnabled()

Specified by:

isVirtualHostPropertiesNodeEnabled in interface Broker<BrokerImpl>

getManagementModeAuthenticationProvider

public AuthenticationProvider<?> getManagementModeAuthenticationProvider()

Specified by:

getManagementModeAuthenticationProvider in interface Broker<BrokerImpl>

Specified by:

getManagementModeAuthenticationProvider in interface Container<BrokerImpl>

getNetworkBufferSize

public int getNetworkBufferSize()

Specified by:

getNetworkBufferSize in interface Broker<BrokerImpl>

Specified by:

getNetworkBufferSize in interface Container<BrokerImpl>

getDocumentationUrl

public String getDocumentationUrl()

Specified by:

getDocumentationUrl in interface Broker<BrokerImpl>

resetStatistics

public void resetStatistics()

Specified by:

resetStatistics in interface Broker<BrokerImpl>

restart

public void restart()

Specified by:

restart in interface Broker<BrokerImpl>

getUser

public Principal getUser()

Specified by:

getUser in interface Broker<BrokerImpl>

getConnectionMetaData

public SocketConnectionMetaData getConnectionMetaData()

Specified by:

getConnectionMetaData in interface Broker<BrokerImpl>

getGroups

public Set<Principal> getGroups()

Specified by:

getGroups in interface Broker<BrokerImpl>

purgeUser

public void purgeUser(AuthenticationProvider<?> origin,
                      String username)

Specified by:

purgeUser in interface Broker<BrokerImpl>

getCompactMemoryThreshold

public long getCompactMemoryThreshold()

Specified by:

getCompactMemoryThreshold in interface Broker<BrokerImpl>

getCompactMemoryInterval

public long getCompactMemoryInterval()

Specified by:

getCompactMemoryInterval in interface Broker<BrokerImpl>

getSparsityFraction

public double getSparsityFraction()

Specified by:

getSparsityFraction in interface Broker<BrokerImpl>

getHousekeepingCheckPeriod

public long getHousekeepingCheckPeriod()

Specified by:

getHousekeepingCheckPeriod in interface Broker<BrokerImpl>

compactMemory

public void compactMemory()

Specified by:

compactMemory in interface Broker<BrokerImpl>