se.sics.kompics.ComponentDefinition

public abstract class ComponentDefinition
extends Object

The ComponentDefinition class.

Version:: $Id$
Author:: Cosmin Arad <[email protected]>, Jim Dowling <[email protected]>, Lars Kroll <[email protected]>

Field Summary

Fields
Modifier and Type	Field	Description
`protected Negative<ControlPort>`	`control`	The components own control port.
`protected org.slf4j.Logger`	`logger`	Kompics provided slf4j logger with managed diagnostic context.
`protected Negative<LoopbackPort>`	`loopback`	The receiving side of the loopback port.
`static String`	`MDC_KEY_CID`	Pre-configured MDC key for the unique component id.
`static String`	`MDC_KEY_CSTATE`	Pre-configured MDC key for the current component lifecycle state.
`protected Positive<LoopbackPort>`	`onSelf`	The sending side of the loopback port.
`ComponentProxy`	`proxy`	The component's proxy instance for reflective configuration.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`ComponentDefinition()`	Instantiate a new component definition.
`protected`	`ComponentDefinition(Class<? extends ComponentCore> coreClass)`	Instantiate a new component definition.

Method Summary

Modifier and Type	Method	Description
`protected void`	`answer(Direct.Request<?> event)`	Reply to a request directly, using the stored origin and the preset response.
`protected void`	`answer(Direct.Request<?> req, Direct.Response resp)`	Reply to a request directly, using the stored origin and the given response.
`Config`	`config()`	Get the component's config instance.
`protected <P extends PortType> Channel<P>`	`connect(Negative<P> negative, Positive<P> positive)`	Deprecated. Use `connect(Positive, Negative, ChannelFactory)` with `Channel.TWO_WAY` instead
`protected <P extends PortType> Channel<P>`	`connect(Negative<P> negative, Positive<P> positive, ChannelFactory factory)`	Connect two ports via a channel.
`protected <P extends PortType> Channel<P>`	`connect(Negative<P> negative, Positive<P> positive, ChannelSelector<?,?> selector)`	Deprecated. Use `connect(Positive, Negative, ChannelSelector, ChannelFactory)` with `Channel.TWO_WAY` instead
`protected <P extends PortType> Channel<P>`	`connect(Negative<P> negative, Positive<P> positive, ChannelSelector<?,?> selector, ChannelFactory factory)`	Connect two ports via a channel.
`protected <P extends PortType> Channel<P>`	`connect(Positive<P> positive, Negative<P> negative)`	Deprecated. Use `connect(Positive, Negative, ChannelFactory)` with `Channel.TWO_WAY` instead
`protected <P extends PortType> Channel<P>`	`connect(Positive<P> positive, Negative<P> negative, ChannelFactory factory)`	Connect two ports via a channel.
`protected <P extends PortType> Channel<P>`	`connect(Positive<P> positive, Negative<P> negative, ChannelSelector<?,?> selector)`	Deprecated. Use `connect(Positive, Negative, ChannelSelector, ChannelFactory)` with `Channel.TWO_WAY` instead
`protected <P extends PortType> Channel<P>`	`connect(Positive<P> positive, Negative<P> negative, ChannelSelector<?,?> selector, ChannelFactory factory)`	Connect two ports via a channel.
`protected <T extends ComponentDefinition> Component`	`create(Class<T> definition, Init.None initEvent)`	Create a child component with no init event.
`protected <T extends ComponentDefinition> Component`	`create(Class<T> definition, Init.None initEvent, ConfigUpdate update)`	Create a child component with no init event and a configuration update.
`protected <T extends ComponentDefinition> Component`	`create(Class<T> definition, Init<T> initEvent)`	Create a child component with a given init event.
`protected <T extends ComponentDefinition> Component`	`create(Class<T> definition, Init<T> initEvent, ConfigUpdate update)`	Create a child component with a given init event and a configuration update.
`protected void`	`destroy(Component component)`	Force destruction of a child component.
`protected <P extends PortType> void`	`disconnect(Channel<P> channel)`	Disconnect a channel connecting two ports.
`protected <P extends PortType> void`	`disconnect(Negative<P> negative, Positive<P> positive)`	Deprecated. Use `disconnect(Channel)` or `Channel.disconnect()` instead
`protected <P extends PortType> void`	`disconnect(Positive<P> positive, Negative<P> negative)`	Deprecated. Use `disconnect(Channel)` or `Channel.disconnect()` instead
`ComponentCore`	`getComponentCore()`	Get the component's core instance.
`Negative<ControlPort>`	`getControlPort()`	Get the component's control port.
`protected <E extends KompicsEvent, P extends PortType> Handler<E>`	`handle(Port<P> port, Class<E> type, Consumer<E> fun)`	Create a functionl handler and automatically subscribe it to a port.
`Fault.ResolveAction`	`handleFault(Fault fault)`	Define how to handle a fault.
`UpdateAction`	`handleUpdate(ConfigUpdate update)`	Deal with a configuration update.
`UUID`	`id()`	Get the component's unique id.
`protected String`	`loggingContextGet(String key)`	Get the value associated with key in the current logging diagnostic context.
`protected void`	`loggingContextPut(String key, String value)`	Associate key with value in the logging diagnostic context.
`protected void`	`loggingContextPutAlways(String key, String value)`	Associate key permanently with value in the logging diagnostic context.
`protected void`	`loggingContextRemove(String key)`	Disassociate any value with the key in the logging diagnostic context.
`protected void`	`loggingContextReset()`	Reset the current logging diagnostic context.
`protected String`	`loggingCtxGet(String key)`	Deprecated. Since 1.2.0, use `loggingContextGet(String)` instead.
`protected void`	`loggingCtxPut(String key, String value)`	Deprecated. Since 1.2.0, use `loggingContextPut(String, String)` instead.
`protected void`	`loggingCtxPutAlways(String key, String value)`	Deprecated. Since 1.2.0, use `loggingContextPutAlways(String, String)` instead.
`protected void`	`loggingCtxRemove(String key)`	Deprecated. Since 1.2.0, use `loggingContextRemove(String)` instead.
`protected void`	`loggingCtxReset()`	Deprecated. Since 1.2.0, use `loggingContextReset()` instead.
`protected <P extends PortType> Negative<P>`	`negative(Class<P> portType)`	Create a negative (provided) port instance and return it.
`protected Handler<Kill>`	`onKill(Consumer<Kill> fun)`	Subscribe a handler to the `Kill` event.
`protected Handler<Start>`	`onStart(Consumer<Start> fun)`	Subscribe a handler to the `Start` event.
`protected Handler<Stop>`	`onStop(Consumer<Stop> fun)`	Subscribe a handler to the `Stop` event.
`protected <P extends PortType> Positive<P>`	`positive(Class<P> portType)`	Create a positive (required) port instance and return it.
`void`	`postUpdate()`	Override to perform actions after a ConfigUpdate was applied and forwarded.
`protected <P extends PortType> Negative<P>`	`provides(Class<P> portType)`	Create a provided (negative) port instance and return it.
`protected <P extends PortType> Positive<P>`	`requires(Class<P> portType)`	Create a required (positive) port instance and return it.
`boolean`	`separateConfigId()`	Override to allow components of this type to start their own independent `Config` id lines.
`protected void`	`setMDC()`	Should not be necessary to call usually, as ComponentCore will do it.
`protected <E extends KompicsEvent, P extends PortType> void`	`subscribe(Handler<E> handler, Port<P> port)`	Subscribe a handler to a port.
`protected void`	`subscribe(MatchedHandler<?,?,?> handler, Port<?> port)`	Subscribe a matched handler to a port.
`void`	`suicide()`	Send a kill event to the component itself.
`void`	`tearDown()`	Cleanup the component before shutdown.
`protected <P extends PortType> void`	`trigger(KompicsEvent event, Port<P> port)`	Trigger an event on a port instance.
`protected <E extends KompicsEvent, P extends PortType> void`	`unsubscribe(Handler<E> handler, Port<P> port)`	Unsubscribe a handler from a port
`protected void`	`unsubscribe(MatchedHandler<?,?,?> handler, Port<?> port)`	Unsubscribe a matched handler from a port
`void`	`updateConfig(ConfigUpdate update)`	Perform a configuration update.

Methods inherited from class java.lang.Object

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

Field Details
- control
 
 protected final Negative<ControlPort> control
 
 The components own control port.
- loopback
 
 protected final Negative<LoopbackPort> loopback
 
 The receiving side of the loopback port. The sending side is at onSelf.
- onSelf
 
 protected final Positive<LoopbackPort> onSelf
 
 The sending side of the loopback port. The receiving side is at loopback.
- proxy
 
 public final ComponentProxy proxy
 
 The component's proxy instance for reflective configuration.
- MDC_KEY_CID
 
 public static final String MDC_KEY_CID
 
 Pre-configured MDC key for the unique component id.
 See the logback manuel for how to use this with logback.
 
 See Also:
 
 Constant Field Values
- MDC_KEY_CSTATE
 
 public static final String MDC_KEY_CSTATE
 
 Pre-configured MDC key for the current component lifecycle state.
 See the logback manuel for how to use this with logback.
 
 See Also:
 
 Constant Field Values
- logger
 
 protected final org.slf4j.Logger logger
 
 Kompics provided slf4j logger with managed diagnostic context.
 See the logback manuel for how to use this with logback.
Constructor Details
- ComponentDefinition
 
 protected ComponentDefinition()
 
 Instantiate a new component definition.
- ComponentDefinition
 
 protected ComponentDefinition(Class<? extends ComponentCore> coreClass)
 
 Instantiate a new component definition.
 
 Parameters:
 
 coreClass - to use as the runtime core for the definition
Method Details
- negative
 
 protected final Negative negative(Class portType)
 
 Create a negative (provided) port instance and return it.
 
 Type Parameters:
 
 P - the type of the port type
 
 Parameters:
 
 portType - the class instance of the port type
 
 Returns:
 
 the new instance
- provides
 
 protected final Negative provides(Class portType)
 
 Create a provided (negative) port instance and return it. Same as negative(Class).
 
 Type Parameters:
 
 P - the type of the port type
 
 Parameters:
 
 portType - the class instance of the port type
 
 Returns:
 
 the new instance
- positive
 
 protected final Positive positive(Class portType)
 
 Create a positive (required) port instance and return it.
 
 Type Parameters:
 
 P - the type of the port type
 
 Parameters:
 
 portType - the class instance of the port type
 
 Returns:
 
 the new instance
- requires
 
 protected final Positive requires(Class portType)
 
 Create a required (positive) port instance and return it.
 
 Type Parameters:
 
 P - the type of the port type
 
 Parameters:
 
 portType - the class instance of the port type
 
 Returns:
 
 the new instance
- trigger
 
 protected final void trigger(KompicsEvent event, Port port)
 
 Trigger an event on a port instance.
 
 Type Parameters:
 
 P - type of the port type
 
 Parameters:
 
 event - the event to be triggered
 
 port - the port where the event is triggered on
- answer
 
 protected final void answer(Direct.Request<?> event)
 
 Reply to a request directly, using the stored origin and the preset response. The passed requests must have a preset response!
 
 Parameters:
 
 event - the request event to reply to
- answer
 
 protected final void answer(Direct.Request<?> req, Direct.Response resp)
 
 Reply to a request directly, using the stored origin and the given response. The passed requests must have a preset response!
 
 Parameters:
 
 req - the request event to reply to
 
 resp - the response to send
- handle
 
 protected final <E extends KompicsEvent, P extends PortType> Handler<E> handle(Port port, Class<E> type, Consumer<E> fun)
 
 Create a functionl handler and automatically subscribe it to a port.
 
 Type Parameters:
 
 E - type of the handled event
 
 P - type of the port being subscribed to
 
 Parameters:
 
 port - a port instance to subcribe the handler to
 
 type - a class instance of the handled event type
 
 fun - the handler function
 
 Returns:
 
 the newly created handler
- onStart
 
 protected final Handler<Start> onStart(Consumer<Start> fun)
 
 Subscribe a handler to the Start event.
 
 Parameters:
 
 fun - the handler function
 
 Returns:
 
 the newly created handler
- onStop
 
 protected final Handler<Stop> onStop(Consumer<Stop> fun)
 
 Subscribe a handler to the Stop event.
 
 Parameters:
 
 fun - the handler function
 
 Returns:
 
 the newly created handler
- onKill
 
 protected final Handler<Kill> onKill(Consumer<Kill> fun)
 
 Subscribe a handler to the Kill event.
 
 Parameters:
 
 fun - the handler function
 
 Returns:
 
 the newly created handler
- subscribe
 
 protected final <E extends KompicsEvent, P extends PortType> void subscribe(Handler<E> handler, Port port)
 
 Subscribe a handler to a port.
 
 Type Parameters:
 
 E - the type of event to subscribe to
 
 P - the type of port to subscribe to
 
 Parameters:
 
 handler - the handler to subcribe
 
 port - the port to subcribe to
 
 Throws:
 
 ConfigurationException - when trying to subscribe on instances that aren't of type JavaPort
- subscribe
 
 protected final void subscribe(MatchedHandler<?,?,?> handler, Port<?> port)
 
 Subscribe a matched handler to a port.
 
 Parameters:
 
 handler - the handler to subcribe
 
 port - the port to subcribe to
 
 Throws:
 
 ConfigurationException - when trying to subscribe on foreign ports or instances that aren't of type JavaPort
- unsubscribe
 
 protected final void unsubscribe(MatchedHandler<?,?,?> handler, Port<?> port)
 
 Unsubscribe a matched handler from a port
 
 Parameters:
 
 handler - the handler to unsubcribe
 
 port - the port to unsubcribe from
 
 Throws:
 
 ConfigurationException - when trying to subscribe on instances that aren't of type JavaPort
- unsubscribe
 
 protected final <E extends KompicsEvent, P extends PortType> void unsubscribe(Handler<E> handler, Port port) throws ConfigurationException
 
 Unsubscribe a handler from a port
 
 Type Parameters:
 
 E - the event type of the handle to subscribe
 
 P - the port type to subscribe to
 
 Parameters:
 
 handler - the handler to unsubcribe
 
 port - the port to unsubcribe from
 
 Throws:
 
 ConfigurationException - when trying to subscribe on instances that aren't of type JavaPort
- create
 
 protected final <T extends ComponentDefinition> Component create(Class<T> definition, Init<T> initEvent)
 
 Create a child component with a given init event.
 
 Type Parameters:
 
 T - the type of the child component
 
 Parameters:
 
 definition - the component definition of the child component
 
 initEvent - init event to be passed to constructor
 
 Returns:
 
 the newly created component
- create
 
 protected final <T extends ComponentDefinition> Component create(Class<T> definition, Init.None initEvent)
 
 Create a child component with no init event. Use `Init.NONE` for the instance.
 
 Type Parameters:
 
 T - the type of the child component
 
 Parameters:
 
 definition - the component definition of the child component
 
 initEvent - special Init.None event to be passed to constructor
 
 Returns:
 
 the newly created component
- create
 
 protected final <T extends ComponentDefinition> Component create(Class<T> definition, Init<T> initEvent, ConfigUpdate update)
 
 Create a child component with a given init event and a configuration update.
 
 Type Parameters:
 
 T - the type of the child component
 
 Parameters:
 
 definition - the component definition of the child component
 
 initEvent - init event to be passed to constructor
 
 update - a configuration update to pass to the child
 
 Returns:
 
 the newly created component
- create
 
 protected final <T extends ComponentDefinition> Component create(Class<T> definition, Init.None initEvent, ConfigUpdate update)
 
 Create a child component with no init event and a configuration update. Use `Init.NONE` for the instance.
 
 Type Parameters:
 
 T - the type of the child component
 
 Parameters:
 
 definition - the component definition of the child component
 
 initEvent - special Init.None event to be passed to constructor
 
 update - a configuration update to pass to the child
 
 Returns:
 
 the newly created component
- destroy
 
 protected final void destroy(Component component)
 
 Force destruction of a child component. Only ever call this on a component in the PASSIVE state!
 
 Parameters:
 
 component - the child component to destroy
- connect
 
 @Deprecated protected final Channel connect(Positive positive, Negative negative)
 
 Deprecated.
 Use connect(Positive, Negative, ChannelFactory) with `Channel.TWO_WAY` instead
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 Returns:
 
 the newly created channel intance
- connect
 
 @Deprecated protected final Channel connect(Negative negative, Positive positive)
 
 Deprecated.
 Use connect(Positive, Negative, ChannelFactory) with `Channel.TWO_WAY` instead
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 Returns:
 
 the newly created channel intance
- connect
 
 @Deprecated protected Channel connect(Positive positive, Negative negative, ChannelSelector<?,?> selector)
 
 Deprecated.
 Use connect(Positive, Negative, ChannelSelector, ChannelFactory) with `Channel.TWO_WAY` instead
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 selector - the channel selector to use
 
 Returns:
 
 the newly created channel intance
- connect
 
 @Deprecated protected Channel connect(Negative negative, Positive positive, ChannelSelector<?,?> selector)
 
 Deprecated.
 Use connect(Positive, Negative, ChannelSelector, ChannelFactory) with `Channel.TWO_WAY` instead
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 selector - the channel selector to use
 
 Returns:
 
 the newly created channel intance
- connect
 
 protected Channel connect(Negative negative, Positive positive, ChannelSelector<?,?> selector, ChannelFactory factory)
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 selector - the channel selector to use
 
 factory - a one-way or two-way factory (see Channel)
 
 Returns:
 
 the newly created channel intance
- connect
 
 protected Channel connect(Positive positive, Negative negative, ChannelSelector<?,?> selector, ChannelFactory factory)
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 selector - the channel selector to use
 
 factory - a one-way or two-way factory (see Channel)
 
 Returns:
 
 the newly created channel intance
- connect
 
 protected Channel connect(Negative negative, Positive positive, ChannelFactory factory)
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 factory - a one-way or two-way factory (see Channel)
 
 Returns:
 
 the newly created channel intance
- connect
 
 protected Channel connect(Positive positive, Negative negative, ChannelFactory factory)
 
 Connect two ports via a channel.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
 
 factory - a one-way or two-way factory (see Channel)
 
 Returns:
 
 the newly created channel intance
- disconnect
 
 @Deprecated protected final void disconnect(Negative negative, Positive positive)
 
 Deprecated.
 Use disconnect(Channel) or Channel.disconnect() instead
 
 Disconnect two ports that are connected via a channel. This is very inefficient, as it needs to find a matching channel first. Use disconnect(Channel) or Channel.disconnect() instead.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
- disconnect
 
 @Deprecated protected final void disconnect(Positive positive, Negative negative)
 
 Deprecated.
 Use disconnect(Channel) or Channel.disconnect() instead
 
 Disconnect two ports that are connected via a channel. This is very inefficient, as it needs to find a matching channel first. Use disconnect(Channel) or Channel.disconnect() instead.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 negative - the negative port instance
 
 positive - the positive port instance
- disconnect
 
 protected final void disconnect(Channel channel)
 
 Disconnect a channel connecting two ports.
 
 Type Parameters:
 
 P - the shared port type
 
 Parameters:
 
 channel - the channel to drop
- getControlPort
 
 public final Negative<ControlPort> getControlPort()
 
 Get the component's control port.
 
 Returns:
 
 the control port
- getComponentCore
 
 public final ComponentCore getComponentCore()
 
 Get the component's core instance.
 
 Returns:
 
 the component core
- config
 
 public final Config config()
 
 Get the component's config instance.
 
 Returns:
 
 the config instance
- id
 
 public final UUID id()
 
 Get the component's unique id.
 
 Returns:
 
 the component id
- suicide
 
 public final void suicide()
 
 Send a kill event to the component itself. Only valid if the component's state is active!
- tearDown
 
 public void tearDown()
 
 Cleanup the component before shutdown. Use for custom cleanup. Will be called after all child components have stopped, but before sending a Stopped message to the parent. Does nothings by default.
- handleFault
 
 public Fault.ResolveAction handleFault(Fault fault)
 Define how to handle a fault.
 Override this method for custom error handling.
 Default action is ESCALATE.
 Possible actions are:
 
 ESCALATE: Forward fault to parent.
 IGNORE: Drop fault. Resume component as if nothing happened.
 RESOLVED: Fault has been handled by user. Don't do anything else.
 Parameters:
 
 fault - the fault that must be handled
 
 Returns:
 
 the action to take
- handleUpdate
 
 public UpdateAction handleUpdate(ConfigUpdate update)
 
 Deal with a configuration update.
 Override for custom update handling.
 Default action is to propagate the original everywhere and apply to self
 
 Parameters:
 
 update - the update to be handled
 
 Returns:
 
 the action to be taken
- postUpdate
 
 public void postUpdate()
 
 Override to perform actions after a ConfigUpdate was applied and forwarded.
- updateConfig
 
 public final void updateConfig(ConfigUpdate update)
 
 Perform a configuration update.
 
 Parameters:
 
 update - the update to perform
- separateConfigId
 
 public boolean separateConfigId()
 
 Override to allow components of this type to start their own independent Config id lines.
 This is helpful in simulation, when simulating multiple independent nodes. Make sure that no ConfigUpdates are passed to siblings or parents of such nodes! (Override handleUpdate(se.sics.kompics.config.ConfigUpdate))
 
 Returns:
 
 Whether to create a new config id line for this component (default: true)
- setMDC
 
 protected void setMDC()
 
 Should not be necessary to call usually, as ComponentCore will do it.
 Protected mainly for use by Kompics Scala.
 Can also be used to set component MDC when executing related off-kompics work (check for concurrency issues, though!).
- loggingCtxPut
 
 @Deprecated protected void loggingCtxPut(String key, String value)
 
 Deprecated.
 Since 1.2.0, use loggingContextPut(String, String) instead.
 
 Associate key with value in the logging diagnostic context.
 See the logback manuel for how to use this with logback.
 
 Parameters:
 
 key - the key to use
 
 value - the value to associate with the key
- loggingContextPut
 
 protected void loggingContextPut(String key, String value)
 
 Associate key with value in the logging diagnostic context.
 See the logback manuel for how to use this with logback.
 
 Parameters:
 
 key - the key to use
 
 value - the value to associate with the key
- loggingCtxPutAlways
 
 protected void loggingCtxPutAlways(String key, String value)
 
 Deprecated.
 Since 1.2.0, use loggingContextPutAlways(String, String) instead.
 
 Associate key permanently with value in the logging diagnostic context.
 Keys set in this way are not removed by loggingContextReset() or loggingContextRemove(String).
 See the logback manuel for how to use this with logback.
 
 Parameters:
 
 key - the key to use
 
 value - the value to associate with the key
- loggingContextPutAlways
 
 protected void loggingContextPutAlways(String key, String value)
 
 Associate key permanently with value in the logging diagnostic context.
 Keys set in this way are not removed by loggingContextReset() or loggingContextRemove(String).
 See the logback manuel for how to use this with logback.
 
 Parameters:
 
 key - the key to use
 
 value - the value to associate with the key
- loggingCtxRemove
 
 @Deprecated protected void loggingCtxRemove(String key)
 
 Deprecated.
 Since 1.2.0, use loggingContextRemove(String) instead.
 
 Disassociate any value with the key in the logging diagnostic context.
 
 Parameters:
 
 key - the key to remove
- loggingContextRemove
 
 protected void loggingContextRemove(String key)
 
 Disassociate any value with the key in the logging diagnostic context.
 
 Parameters:
 
 key - the key to remove
- loggingCtxGet
 
 @Deprecated protected String loggingCtxGet(String key)
 
 Deprecated.
 Since 1.2.0, use loggingContextGet(String) instead.
 
 Get the value associated with key in the current logging diagnostic context.
 
 Parameters:
 
 key - the key to fetch the value for
 
 Returns:
 
 the value associated with key
- loggingContextGet
 
 protected String loggingContextGet(String key)
 
 Get the value associated with key in the current logging diagnostic context.
 
 Parameters:
 
 key - the key to fetch the value for
 
 Returns:
 
 the value associated with key
- loggingCtxReset
 
 @Deprecated protected void loggingCtxReset()
 
 Deprecated.
 Since 1.2.0, use loggingContextReset() instead.
 
 Reset the current logging diagnostic context.
 Removes all items added to context by the user that weren't set with loggingContextPutAlways(String, String)
- loggingContextReset
 
 protected void loggingContextReset()
 
 Reset the current logging diagnostic context.
 Removes all items added to context by the user that weren't set with loggingContextPutAlways(String, String)

Class ComponentDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details