Package org.apache.qpid.server.model

Interface Broker<X extends Broker<X>>

All Superinterfaces:

ConfiguredObject<X>, Container<X>, ContextProvider, EventLoggerProvider, PermissionedObject, StatisticsGatherer, TaskExecutorProvider, UserPreferencesCreator

All Known Implementing Classes:

BrokerImpl

public interface Broker<X extends Broker<X>>
extends ConfiguredObject<X>, EventLoggerProvider, StatisticsGatherer, Container<X>, UserPreferencesCreator

Field Summary

Fields

Modifier and Type	Field	Description
static String	BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE
static String	BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION
static String	BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD
static String	BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE
static String	BROKER_FLOW_TO_DISK_THRESHOLD
static String	BROKER_MESSAGE_COMPRESSION_ENABLED
static String	BROKER_MSG_AUTH
static String	BROKER_SHUTDOWN_TIMEOUT
static String	BROKER_STATISTICS_REPORING_PERIOD
static String	BROKER_TYPE
static String	BUILD_VERSION
static String	CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT
static String	COMPACT_MEMORY_INTERVAL
static String	COMPACT_MEMORY_THRESHOLD
static String	DEFAULT_AMQP_PORT_NUMBER
static int	DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE
static double	DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION
static boolean	DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD
static DescendantScope	DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE
static long	DEFAULT_BROKER_HOUSEKEEPING_CHECK_PERIOD
static boolean	DEFAULT_BROKER_MSG_AUTH
static String	DEFAULT_BROKER_NAME
static int	DEFAULT_BROKER_SHUTDOWN_TIMEOUT
static long	DEFAULT_CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT
static long	DEFAULT_COMPACT_MEMORY_INTERVAL
static long	DEFAULT_COMPACT_MEMORY_THRESHOLD
static String	DEFAULT_DOCUMENTATION_URL
static int	DEFAULT_FILESYSTEM_MAX_USAGE_PERCENT
static long	DEFAULT_FLOW_TO_DISK_THRESHOLD
static int	DEFAULT_HOUSEKEEPING_THREAD_COUNT
static String	DEFAULT_HTTP_PORT_NUMBER
static boolean	DEFAULT_MESSAGE_COMPRESSION_ENABLED
static int	DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE
static int	DEFAULT_NETWORK_BUFFER_SIZE
static String	DEFAULT_SECURITY_TLS_CIPHER_SUITE_ALLOW_LIST
static String	DEFAULT_SECURITY_TLS_CIPHER_SUITE_DENY_LIST
static String	DEFAULT_SECURITY_TLS_PROTOCOL_ALLOW_LIST
static String	DEFAULT_SECURITY_TLS_PROTOCOL_DENY_LIST
static String	DEFAULT_SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP
static int	DEFAULT_STATISTICS_REPORTING_PERIOD
static String	MESSAGE_COMPRESSION_THRESHOLD_SIZE
static int	MINIMUM_NETWORK_BUFFER_SIZE
static String	MODEL_VERSION
static String	NETWORK_BUFFER_SIZE
static String	OPERATING_SYSTEM
static String	PLATFORM
static String	PREFERENCE_STORE_ATTRIBUTES
static String	PROCESS_PID
static String	PRODUCT_VERSION
static String	PROPERTY_DISABLED_FEATURES
static String	QPID_AMQP_PORT
static String	QPID_BROKER_HOUSEKEEPING_CHECK_PERIOD
static String	QPID_DOCUMENTATION_URL
static String	QPID_HTTP_PORT
static String	SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP
static String	STATISTICS_REPORTING_PERIOD
static String	STORE_FILESYSTEM_MAX_USAGE_PERCENT
static String	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

Method Summary

Modifier and Type	Method	Description
void	assignTargetSizes()
void	compactMemory()
Map<String,Object>	extractConfig(boolean includeSecureAttributes)
VirtualHostNode	findDefautVirtualHostNode()
Content	findThreadStackTraces(String threadNameFindExpression)
VirtualHost<?>	findVirtualHostByName(String name)
Collection<AccessControlProvider<?>>	getAccessControlProviders()
Collection<AuthenticationProvider<?>>	getAuthenticationProviders()
String	getBuildVersion()
long	getBytesIn()	Returns a number of received bytes
long	getBytesOut()	Returns a number of delivered bytes
long	getCompactMemoryInterval()
long	getCompactMemoryThreshold()
String	getConfidentialConfigurationEncryptionProvider()
SocketConnectionMetaData	getConnectionMetaData()
long	getDirectMemoryTotalCapacity()
String	getDocumentationUrl()
EventLogger	getEventLogger()
long	getFlowToDiskThreshold()
Collection<GroupProvider<?>>	getGroupProviders()
Set<Principal>	getGroups()
long	getHousekeepingCheckPeriod()
int	getHousekeepingThreadCount()
long	getInboundMessageSizeHighWatermark()
List<String>	getJvmArguments()
Collection<KeyStore<?>>	getKeyStores()
AuthenticationProvider<?>	getManagementModeAuthenticationProvider()
long	getMaximumDirectMemorySize()
long	getMaximumHeapMemorySize()
long	getMessagesIn()	Returns a number of received messages
long	getMessagesOut()	Returns a number of delivered messages
String	getModelVersion()
int	getNetworkBufferSize()
long	getNumberOfBuffersInPool()
long	getNumberOfBuffersInUse()
int	getNumberOfCores()
int	getNumberOfLiveThreads()
int	getNumberOfObjectsPendingFinalization()
String	getOperatingSystem()
String	getPlatform()
Collection<Port<?>>	getPorts()
String	getProcessPid()
String	getProductVersion()
int	getShutdownTimeout()
double	getSparsityFraction()
int	getStatisticsReportingPeriod()
NamedAddressSpace	getSystemAddressSpace(String name)
Content	getThreadStackTraces(boolean appendToLog)
long	getTransactedMessagesIn()
long	getTransactedMessagesOut()
Collection<TrustStore<?>>	getTrustStores()
long	getUsedDirectMemorySize()
long	getUsedHeapMemorySize()
Principal	getUser()
Collection<VirtualHostNode<?>>	getVirtualHostNodes()
void	initiateShutdown()
boolean	isManagementMode()
boolean	isMessageCompressionEnabled()
boolean	isVirtualHostPropertiesNodeEnabled()
void	performGC()
void	purgeUser(AuthenticationProvider<?> origin, String username)
void	resetStatistics()
void	restart()
ScheduledFuture<?>	scheduleHouseKeepingTask(long period, TimeUnit unit, Runnable task)
ScheduledFuture<?>	scheduleTask(long delay, TimeUnit unit, Runnable task)
void	setEventLogger(EventLogger eventLogger)

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.stats.StatisticsGatherer

registerMessageDelivered, registerMessageReceived, registerTransactedMessageDelivered, registerTransactedMessageReceived

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

getTaskExecutor

Methods inherited from interface org.apache.qpid.server.store.preferences.UserPreferencesCreator

createUserPreferences

Field Detail

BROKER_TYPE

static final String BROKER_TYPE

See Also:

Constant Field Values

BUILD_VERSION

static final String BUILD_VERSION

See Also:

Constant Field Values

OPERATING_SYSTEM

static final String OPERATING_SYSTEM

See Also:

Constant Field Values

PLATFORM

static final String PLATFORM

See Also:

Constant Field Values

PROCESS_PID

static final String PROCESS_PID

See Also:

Constant Field Values

PRODUCT_VERSION

static final String PRODUCT_VERSION

See Also:

Constant Field Values

STATISTICS_REPORTING_PERIOD

static final String STATISTICS_REPORTING_PERIOD

See Also:

Constant Field Values

STORE_PATH

static final String STORE_PATH

See Also:

Constant Field Values

MODEL_VERSION

static final String MODEL_VERSION

See Also:

Constant Field Values

PREFERENCE_STORE_ATTRIBUTES

static final String PREFERENCE_STORE_ATTRIBUTES

See Also:

Constant Field Values

CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT

static final String CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT

See Also:

Constant Field Values

BROKER_FLOW_TO_DISK_THRESHOLD

static final String BROKER_FLOW_TO_DISK_THRESHOLD

See Also:

Constant Field Values

BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD

static final String BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD

See Also:

Constant Field Values

BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE

static final String BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE

See Also:

Constant Field Values

BROKER_MSG_AUTH

static final String BROKER_MSG_AUTH

See Also:

Constant Field Values

STORE_FILESYSTEM_MAX_USAGE_PERCENT

static final String STORE_FILESYSTEM_MAX_USAGE_PERCENT

See Also:

Constant Field Values

QPID_AMQP_PORT

static final String QPID_AMQP_PORT

See Also:

Constant Field Values

QPID_HTTP_PORT

static final String QPID_HTTP_PORT

See Also:

Constant Field Values

QPID_DOCUMENTATION_URL

static final String QPID_DOCUMENTATION_URL

See Also:

Constant Field Values

BROKER_SHUTDOWN_TIMEOUT

static final String BROKER_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

BROKER_STATISTICS_REPORING_PERIOD

static final String BROKER_STATISTICS_REPORING_PERIOD

See Also:

Constant Field Values

NETWORK_BUFFER_SIZE

static final String NETWORK_BUFFER_SIZE

See Also:

Constant Field Values

MINIMUM_NETWORK_BUFFER_SIZE

static final int MINIMUM_NETWORK_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_NETWORK_BUFFER_SIZE

static final int DEFAULT_NETWORK_BUFFER_SIZE

See Also:

Constant Field Values

DEFAULT_BROKER_NAME

static final String DEFAULT_BROKER_NAME

See Also:

Constant Field Values

DEFAULT_AMQP_PORT_NUMBER

static final String DEFAULT_AMQP_PORT_NUMBER

See Also:

Constant Field Values

DEFAULT_HTTP_PORT_NUMBER

static final String DEFAULT_HTTP_PORT_NUMBER

See Also:

Constant Field Values

DEFAULT_FLOW_TO_DISK_THRESHOLD

static final long DEFAULT_FLOW_TO_DISK_THRESHOLD

COMPACT_MEMORY_THRESHOLD

static final String COMPACT_MEMORY_THRESHOLD

See Also:

Constant Field Values

DEFAULT_COMPACT_MEMORY_THRESHOLD

static final long DEFAULT_COMPACT_MEMORY_THRESHOLD

COMPACT_MEMORY_INTERVAL

static final String COMPACT_MEMORY_INTERVAL

See Also:

Constant Field Values

DEFAULT_COMPACT_MEMORY_INTERVAL

static final long DEFAULT_COMPACT_MEMORY_INTERVAL

See Also:

Constant Field Values

DEFAULT_CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT

static final long DEFAULT_CHANNEL_FLOW_CONTROL_ENFORCEMENT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_FILESYSTEM_MAX_USAGE_PERCENT

static final int DEFAULT_FILESYSTEM_MAX_USAGE_PERCENT

See Also:

Constant Field Values

DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD

static final boolean DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD

See Also:

Constant Field Values

DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE

static final DescendantScope DEFAULT_BROKER_FAIL_STARTUP_WITH_ERRORED_CHILD_SCOPE

DEFAULT_BROKER_MSG_AUTH

static final boolean DEFAULT_BROKER_MSG_AUTH

See Also:

Constant Field Values

DEFAULT_SECURITY_TLS_PROTOCOL_ALLOW_LIST

static final String DEFAULT_SECURITY_TLS_PROTOCOL_ALLOW_LIST

DEFAULT_SECURITY_TLS_PROTOCOL_DENY_LIST

static final String DEFAULT_SECURITY_TLS_PROTOCOL_DENY_LIST

DEFAULT_SECURITY_TLS_CIPHER_SUITE_ALLOW_LIST

static final String DEFAULT_SECURITY_TLS_CIPHER_SUITE_ALLOW_LIST

See Also:

Constant Field Values

DEFAULT_SECURITY_TLS_CIPHER_SUITE_DENY_LIST

static final String DEFAULT_SECURITY_TLS_CIPHER_SUITE_DENY_LIST

See Also:

Constant Field Values

DEFAULT_DOCUMENTATION_URL

static final String DEFAULT_DOCUMENTATION_URL

See Also:

Constant Field Values

DEFAULT_BROKER_SHUTDOWN_TIMEOUT

static final int DEFAULT_BROKER_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

DEFAULT_STATISTICS_REPORTING_PERIOD

static final int DEFAULT_STATISTICS_REPORTING_PERIOD

See Also:

Constant Field Values

PROPERTY_DISABLED_FEATURES

static final String PROPERTY_DISABLED_FEATURES

See Also:

Constant Field Values

DEFAULT_HOUSEKEEPING_THREAD_COUNT

static final int DEFAULT_HOUSEKEEPING_THREAD_COUNT

See Also:

Constant Field Values

QPID_BROKER_HOUSEKEEPING_CHECK_PERIOD

static final String QPID_BROKER_HOUSEKEEPING_CHECK_PERIOD

See Also:

Constant Field Values

DEFAULT_BROKER_HOUSEKEEPING_CHECK_PERIOD

static final long DEFAULT_BROKER_HOUSEKEEPING_CHECK_PERIOD

See Also:

Constant Field Values

BROKER_MESSAGE_COMPRESSION_ENABLED

static final String BROKER_MESSAGE_COMPRESSION_ENABLED

See Also:

Constant Field Values

DEFAULT_MESSAGE_COMPRESSION_ENABLED

static final boolean DEFAULT_MESSAGE_COMPRESSION_ENABLED

See Also:

Constant Field Values

MESSAGE_COMPRESSION_THRESHOLD_SIZE

static final String MESSAGE_COMPRESSION_THRESHOLD_SIZE

See Also:

Constant Field Values

DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE

static final int DEFAULT_MESSAGE_COMPRESSION_THRESHOLD_SIZE

See Also:

Constant Field Values

SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP

static final String SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP

See Also:

Constant Field Values

DEFAULT_SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP

static final String DEFAULT_SEND_QUEUE_DELETE_OK_REGARDLESS_CLIENT_VER_REGEXP

See Also:

Constant Field Values

BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE

static final String BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE

See Also:

Constant Field Values

DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE

static final int DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SIZE

See Also:

Constant Field Values

BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION

static final String BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION

See Also:

Constant Field Values

DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION

static final double DEFAULT_BROKER_DIRECT_BYTE_BUFFER_POOL_SPARSITY_REALLOCATION_FRACTION

See Also:

Constant Field Values

Method Detail

getBuildVersion

String getBuildVersion()

getOperatingSystem

String getOperatingSystem()

getPlatform

String getPlatform()

getProcessPid

String getProcessPid()

getProductVersion

String getProductVersion()

getNumberOfCores

int getNumberOfCores()

getShutdownTimeout

int getShutdownTimeout()

getStatisticsReportingPeriod

int getStatisticsReportingPeriod()

getHousekeepingThreadCount

int getHousekeepingThreadCount()

isMessageCompressionEnabled

boolean isMessageCompressionEnabled()

getConfidentialConfigurationEncryptionProvider

String getConfidentialConfigurationEncryptionProvider()

getModelVersion

String getModelVersion()

getBytesIn

long getBytesIn()

Description copied from interface: StatisticsGatherer

Returns a number of received bytes

Specified by:

getBytesIn in interface StatisticsGatherer

Returns:

the number of received bytes

getBytesOut

long getBytesOut()

Description copied from interface: StatisticsGatherer

Returns a number of delivered bytes

Specified by:

getBytesOut in interface StatisticsGatherer

Returns:

the number of delivered bytes

getMessagesIn

long getMessagesIn()

Description copied from interface: StatisticsGatherer

Returns a number of received messages

Specified by:

getMessagesIn in interface StatisticsGatherer

Returns:

the number of received messages

getMessagesOut

long getMessagesOut()

Description copied from interface: StatisticsGatherer

Returns a number of delivered messages

Specified by:

getMessagesOut in interface StatisticsGatherer

Returns:

the number of delivered messages

getTransactedMessagesIn

long getTransactedMessagesIn()

getTransactedMessagesOut

long getTransactedMessagesOut()

resetStatistics

void resetStatistics()

initiateShutdown

void initiateShutdown()

extractConfig

Map<String,Object> extractConfig(boolean includeSecureAttributes)

getMaximumHeapMemorySize

long getMaximumHeapMemorySize()

getMaximumDirectMemorySize

long getMaximumDirectMemorySize()

getJvmArguments

List<String> getJvmArguments()

getDocumentationUrl

String getDocumentationUrl()

getNumberOfLiveThreads

int getNumberOfLiveThreads()

getUsedHeapMemorySize

long getUsedHeapMemorySize()

getUsedDirectMemorySize

long getUsedDirectMemorySize()

getDirectMemoryTotalCapacity

long getDirectMemoryTotalCapacity()

getNumberOfObjectsPendingFinalization

int getNumberOfObjectsPendingFinalization()

getNumberOfBuffersInUse

long getNumberOfBuffersInUse()

getNumberOfBuffersInPool

long getNumberOfBuffersInPool()

getInboundMessageSizeHighWatermark

long getInboundMessageSizeHighWatermark()

restart

void restart()

performGC

void performGC()

getThreadStackTraces

Content getThreadStackTraces(boolean appendToLog)

findThreadStackTraces

Content findThreadStackTraces(String threadNameFindExpression)

getUser

Principal getUser()

getConnectionMetaData

SocketConnectionMetaData getConnectionMetaData()

getGroups

Set<Principal> getGroups()

purgeUser

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

getVirtualHostNodes

Collection<VirtualHostNode<?>> getVirtualHostNodes()

getPorts

Collection<Port<?>> getPorts()

getAuthenticationProviders

Collection<AuthenticationProvider<?>> getAuthenticationProviders()

getAccessControlProviders

Collection<AccessControlProvider<?>> getAccessControlProviders()

getSystemAddressSpace

NamedAddressSpace getSystemAddressSpace(String name)

getGroupProviders

Collection<GroupProvider<?>> getGroupProviders()

findVirtualHostByName

VirtualHost<?> findVirtualHostByName(String name)

findDefautVirtualHostNode

VirtualHostNode findDefautVirtualHostNode()

getKeyStores

Collection<KeyStore<?>> getKeyStores()

getTrustStores

Collection<TrustStore<?>> getTrustStores()

isManagementMode

boolean isManagementMode()

getEventLogger

EventLogger getEventLogger()

Specified by:

getEventLogger in interface Container<X extends Broker<X>>

Specified by:

getEventLogger in interface EventLoggerProvider

setEventLogger

void setEventLogger(EventLogger eventLogger)

Specified by:

setEventLogger in interface Container<X extends Broker<X>>

isVirtualHostPropertiesNodeEnabled

boolean isVirtualHostPropertiesNodeEnabled()

getManagementModeAuthenticationProvider

AuthenticationProvider<?> getManagementModeAuthenticationProvider()

Specified by:

getManagementModeAuthenticationProvider in interface Container<X extends Broker<X>>

assignTargetSizes

void assignTargetSizes()

getNetworkBufferSize

int getNetworkBufferSize()

Specified by:

getNetworkBufferSize in interface Container<X extends Broker<X>>

scheduleHouseKeepingTask

ScheduledFuture<?> scheduleHouseKeepingTask(long period,
                                            TimeUnit unit,
                                            Runnable task)

scheduleTask

ScheduledFuture<?> scheduleTask(long delay,
                                TimeUnit unit,
                                Runnable task)

getFlowToDiskThreshold

long getFlowToDiskThreshold()

getCompactMemoryThreshold

long getCompactMemoryThreshold()

getCompactMemoryInterval

long getCompactMemoryInterval()

getSparsityFraction

double getSparsityFraction()

getHousekeepingCheckPeriod

long getHousekeepingCheckPeriod()

compactMemory

void compactMemory()