Package ch.qos.logback.access.spi
Class AccessContext
- java.lang.Object
-
- ch.qos.logback.core.ContextBase
-
- ch.qos.logback.access.spi.AccessContext
-
- All Implemented Interfaces:
Context
,AppenderAttachable<IAccessEvent>
,FilterAttachable<IAccessEvent>
,LifeCycle
,PropertyContainer
public class AccessContext extends ContextBase implements AppenderAttachable<IAccessEvent>, FilterAttachable<IAccessEvent>
A minimal context implementation used by certain logback-access components, mainly SocketServer.- Author:
- Sébastien Pennec
-
-
Field Summary
-
Fields inherited from class ch.qos.logback.core.ContextBase
scheduledFutures
-
-
Constructor Summary
Constructors Constructor Description AccessContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAppender(Appender<IAccessEvent> newAppender)
Add an appender.void
addFilter(Filter<IAccessEvent> newFilter)
Add a filter.void
callAppenders(IAccessEvent event)
void
clearAllFilters()
void
detachAndStopAllAppenders()
Detach and processPriorToRemoval all previously added appenders.boolean
detachAppender(Appender<IAccessEvent> appender)
Detach the appender passed as parameter from the list of appenders.boolean
detachAppender(java.lang.String name)
Detach the appender with the name passed as parameter from the list of appenders.Appender<IAccessEvent>
getAppender(java.lang.String name)
Get an appender by name.java.util.List<Filter<IAccessEvent>>
getCopyOfAttachedFiltersList()
Get a copy of all the filters contained within this FilterAttachable object.FilterReply
getFilterChainDecision(IAccessEvent event)
Loop through the filters in the chain.boolean
isAttached(Appender<IAccessEvent> appender)
Returnstrue
if the specified appender is in list of attached attached,false
otherwise.java.util.Iterator<Appender<IAccessEvent>>
iteratorForAppenders()
Get an iterator for appenders contained in the parent object.-
Methods inherited from class ch.qos.logback.core.ContextBase
addScheduledFuture, getBirthTime, getConfigurationLock, getCopyOfPropertyMap, getExecutorService, getName, getObject, getProperty, getScheduledExecutorService, getScheduledFutures, getStatusManager, initCollisionMaps, isStarted, putObject, putProperty, register, removeObject, reset, setName, setStatusManager, start, stop, toString
-
-
-
-
Method Detail
-
callAppenders
public void callAppenders(IAccessEvent event)
-
addAppender
public void addAppender(Appender<IAccessEvent> newAppender)
Description copied from interface:AppenderAttachable
Add an appender.- Specified by:
addAppender
in interfaceAppenderAttachable<IAccessEvent>
-
detachAndStopAllAppenders
public void detachAndStopAllAppenders()
Description copied from interface:AppenderAttachable
Detach and processPriorToRemoval all previously added appenders.- Specified by:
detachAndStopAllAppenders
in interfaceAppenderAttachable<IAccessEvent>
-
detachAppender
public boolean detachAppender(Appender<IAccessEvent> appender)
Description copied from interface:AppenderAttachable
Detach the appender passed as parameter from the list of appenders.- Specified by:
detachAppender
in interfaceAppenderAttachable<IAccessEvent>
-
detachAppender
public boolean detachAppender(java.lang.String name)
Description copied from interface:AppenderAttachable
Detach the appender with the name passed as parameter from the list of appenders.- Specified by:
detachAppender
in interfaceAppenderAttachable<IAccessEvent>
-
getAppender
public Appender<IAccessEvent> getAppender(java.lang.String name)
Description copied from interface:AppenderAttachable
Get an appender by name.- Specified by:
getAppender
in interfaceAppenderAttachable<IAccessEvent>
-
isAttached
public boolean isAttached(Appender<IAccessEvent> appender)
Description copied from interface:AppenderAttachable
Returnstrue
if the specified appender is in list of attached attached,false
otherwise.- Specified by:
isAttached
in interfaceAppenderAttachable<IAccessEvent>
-
iteratorForAppenders
public java.util.Iterator<Appender<IAccessEvent>> iteratorForAppenders()
Description copied from interface:AppenderAttachable
Get an iterator for appenders contained in the parent object.- Specified by:
iteratorForAppenders
in interfaceAppenderAttachable<IAccessEvent>
-
addFilter
public void addFilter(Filter<IAccessEvent> newFilter)
Description copied from interface:FilterAttachable
Add a filter.- Specified by:
addFilter
in interfaceFilterAttachable<IAccessEvent>
-
clearAllFilters
public void clearAllFilters()
- Specified by:
clearAllFilters
in interfaceFilterAttachable<IAccessEvent>
-
getCopyOfAttachedFiltersList
public java.util.List<Filter<IAccessEvent>> getCopyOfAttachedFiltersList()
Description copied from interface:FilterAttachable
Get a copy of all the filters contained within this FilterAttachable object.- Specified by:
getCopyOfAttachedFiltersList
in interfaceFilterAttachable<IAccessEvent>
- Returns:
- all attached filters as a list
-
getFilterChainDecision
public FilterReply getFilterChainDecision(IAccessEvent event)
Description copied from interface:FilterAttachable
Loop through the filters in the chain. As soon as a filter decides on ACCEPT or DENY, then that value is returned. If all of the filters return NEUTRAL, then NEUTRAL is returned.- Specified by:
getFilterChainDecision
in interfaceFilterAttachable<IAccessEvent>
-
-