Technical Specification
Overview
This technical specification page will detail three areas of work to complete the Status Update change:
- The new classes required
- The additions to existing classes
- The deletions from existing classes
New classes
The new classes required draws on the design work already completed. The abstraction layer will be the new code created as part of this work. This can be split in to Interfaces and Classes.
Interface list
These interfaces form the abstraction layer.
Interface |
Description |
---|---|
LogActor |
Actor that is requesting the log to be performed. |
MessageStatusLogger |
Entity that wishes to provide log statements. |
MessageStatusLoggerFactory |
Factory to generate MSLoggers. |
RootMessageStatusLogger |
Root logger that performs logging. |
RawMessageLogger |
Wrapper for object that actually performs the logging. |
Class List
Implementation of the Actors
Class |
Description |
---|---|
ConnectionActor |
Responsible for providing data about the Connection when logging. |
ManagementConnectionActor |
Responsible for providing data about the Management Connection when logging. |
Implementation of the Loggers
Class |
Description |
---|---|
ConnectionMessageStatusLogger |
Logger responsible for the Connection format. |
ChannelMessageStatusLogger |
Logger responsible for the Channel format. |
QueueMessageStatusLogger |
Logger responsible for the Queue format. |
ExchangeMessageStatusLogger |
Logger responsible for the Exchange format. |
BindingMessageStatusLogger |
Logger responsible for the Binding format. |
SubscriptionMessageStatusLogger |
Logger responsible for the subscription format. |
MessageStoreMessageStatusLogger |
Logger responsible for the MessageStore format. |
RootMessageStatusLoggerImpl |
Base logger that performs the final message formatting before logging. |
MessageStatusLoggerFactoryImpl |
Factory to create the above Loggers. |
Logging
Class |
Description |
---|---|
Log4jRawMessageLogger |
Wrapper to use log4j as the output mechanism. |
TestRawMessageLogger |
Wrapper that provides an inspectable log for testing. |
Log Messages
Class |
Description |
---|---|
BrokerLogMessages |
A static class that contains accessors to the various parametrised log messages. |