AtomPushBean (Apache CXF Runtime Web Management 2.4.7 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.management.web.logging.atom
Class AtomPushBean

java.lang.Object
  org.apache.cxf.management.web.logging.atom.AbstractAtomBean
      org.apache.cxf.management.web.logging.atom.AtomPushBean

public final class AtomPushBean
extends AbstractAtomBean
extends AbstractAtomBean

Bean used to configure JUL handler with Spring instead of properties file. See AtomPushHandler class for detailed description of parameters. Next to configuration of handler, Spring bean offers simple configuration of associated loggers that share ATOM push-style handler.

General rules:

When deliverer property is not set explicitly, URL must be set to create default deliverer.
When converter property is not set explicitly, default converter is created.
When loggers property is used, it overrides pair of logger and level properties; and vice versa.
When logger is not set, handler is attached to root logger (named ""); when level is not set for logger, default "INFO" level is used.
When batchSize property is not set or set to wrong value, default batch size of "1" is used.
When deliverer property is NOT set, use of "retryXxx" properties causes creation of retrying default deliverer.

Examples:

ATOM push handler with registered with root logger for all levels or log events, pushing one feed per event to specified URL, using default delivery and conversion methods:

   <bean class="org.apache.cxf.jaxrs.ext.logging.atom.AtomPushBean" 
     init-method="init">
       <property name="url" value="http://localhost:9080/feed"/>
       <property name="level" value="ALL" />
   </bean>

ATOM push handler registered with multiple loggers and listening for different levels (see loggers property description for syntax details). Custom deliverer will take care of feeds, each of which carries batch of 10 log events:

   <bean id="soapDeliverer" ...
   ...
   <bean class="org.apache.cxf.jaxrs.ext.logging.atom.AtomPushBean" 
     init-method="init">
       <property name="deliverer">
           <ref bean="soapDeliverer"/>
       </property>
       <property name="loggers" value="
           org.apache.cxf:DEBUG,
           org.apache.cxf.jaxrs,
           org.apache.cxf.bus:ERROR" />
       <property name="batchSize" value="10" />
   </bean>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.management.web.logging.atom.AbstractAtomBean
`AbstractAtomBean.LoggerLevel`

Constructor Summary
`AtomPushBean()` Creates unconfigured and uninitialized bean.

Method Summary
`protected Handler`	`createHandler()`
`void`	`setBatchCleanupTime(String batchCleanupTime)` Batch cleanup time in minutes
`void`	`setBatchSize(String batchSize)` Size of batch; empty string for default one element batch.
`void`	`setConverter(Converter converter)` Set initialized converter.
`void`	`setDeliverer(Deliverer deliverer)` Set initialized deliverer.
`void`	`setFormat(String format)` Entry data format: "content" or "extension".
`void`	`setMultiplicity(String multiplicity)` Multiplicity of subelement of output: "one" or "many".
`void`	`setOutput(String output)` Conversion output type: "feed" or "entry".
`void`	`setRetryPause(String retryPause)` Retry pause calculation strategy, either "linear" or "exponential".
`void`	`setRetryPauseTime(String time)` Retry pause time (in seconds).
`void`	`setRetryTimeout(String timeout)` Retry timeout (in seconds).
`void`	`setUrl(String url)` Set URL used when custom deliverer is not set (default deliverer is being created).

Methods inherited from class org.apache.cxf.management.web.logging.atom.AbstractAtomBean
`checkInit, getBus, getLoggers, init, setBus, setLevel, setLogger, setLoggers`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AtomPushBean

public AtomPushBean()

Creates unconfigured and uninitialized bean. To configure setters must be used, then AbstractAtomBean.init() must be called.

Method Detail

setUrl

public void setUrl(String url)

Set URL used when custom deliverer is not set (default deliverer is being created).

setDeliverer

public void setDeliverer(Deliverer deliverer)

Set initialized deliverer.

setConverter

public void setConverter(Converter converter)

Set initialized converter.

setBatchSize

public void setBatchSize(String batchSize)

Size of batch; empty string for default one element batch.

setBatchCleanupTime

public void setBatchCleanupTime(String batchCleanupTime)

Batch cleanup time in minutes

setRetryPause

public void setRetryPause(String retryPause)

Retry pause calculation strategy, either "linear" or "exponential".

setRetryPauseTime

public void setRetryPauseTime(String time)

Retry pause time (in seconds).

setRetryTimeout

public void setRetryTimeout(String timeout)

Retry timeout (in seconds).

setOutput

public void setOutput(String output)

Conversion output type: "feed" or "entry".

setMultiplicity

public void setMultiplicity(String multiplicity)

Multiplicity of subelement of output: "one" or "many".

setFormat

public void setFormat(String format)

Entry data format: "content" or "extension".

createHandler

protected Handler createHandler()

Specified by:: createHandler in class AbstractAtomBean