org.eclipse.hyades.logging.adapter.outputters
Class CBELogOutputter

java.lang.Object
  org.eclipse.hyades.logging.adapter.impl.Component
      org.eclipse.hyades.logging.adapter.impl.ProcessUnit
          org.eclipse.hyades.logging.adapter.impl.Outputter
              org.eclipse.hyades.logging.adapter.outputters.CBELogOutputter

All Implemented Interfaces:

IComponent, IOutputter, IProcessUnit

public class CBELogOutputter

extends Outputter

implements IOutputter

This outputter writes CommonBaseEvent's to a logging agent

Field Summary

Fields inherited from class org.eclipse.hyades.logging.adapter.impl.ProcessUnit

flushingMode

Fields inherited from class org.eclipse.hyades.logging.adapter.impl.Component

logger, status, stopping

Constructor Summary

CBELogOutputter()

Method Summary

java.lang.String	getAgentName() Gets the name of the logging agent.
int	getBufferSize() Gets the buffer size (i.e., the number of records buffered while the logging agent is not connected to the RAC).
long	getWaitTime() Gets the logging agent wait time.
java.lang.Object[]	processEventItems(java.lang.Object[] msgs) This implementation processes messages represented by an array of CommonBaseEvent objects where each CommonBaseEvent represents a message.
void	setAgentName(java.lang.String aName) Sets the name of the logging agent to write to
void	setBufferSize(int bufSize) Sets the buffer size of the logging agent (i.e., the number of records buffered while the logging agent is not connected to the RAC).
void	setWaitTime(long wTime) Sets the logging agent wait time.
void	stop() Stops the logging agent outputter which includes cleaning up the logging agent.
java.lang.Object[]	testProcessEventItems(java.lang.Object[] msgs) Simulate processing messages as CommonBaseEvent objects.
void	update() update the configuration based on the configuration Element

Methods inherited from class org.eclipse.hyades.logging.adapter.impl.ProcessUnit

flushEventItems, getProperties, setProperties

Methods inherited from class org.eclipse.hyades.logging.adapter.impl.Component

clean, getComponents, getComponentStatus, getConfiguration, getContextConfiguration, getDescription, getEventFactory, getExecutableClassName, getImplementationCreationDate, getImplementationVersion, getImplementationVersionDescription, getItemsProcessedCount, getLogger, getLoggingLevel, getName, getParent, getRole, getRoleCreationDate, getRoleVersion, getRoleVersionDescription, getUniqueID, incrementItemsProcessedCount, incrementItemsProcessedCount, init, isStopping, log, log, setComponents, setConfiguration, setContextConfiguration, setDescription, setExecutableClassName, setImplemenationCreationDate, setImplementationVersion, setImplementationVersionDescription, setLogger, setLoggingLevel, setName, setParent, setRole, setRoleCreationDate, setRoleVersion, setRoleVersionDescription, setStopping, setUniqueID, start, stop, trace, trace, trace, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.hyades.logging.adapter.IProcessUnit

flushEventItems

Methods inherited from interface org.eclipse.hyades.logging.adapter.IComponent

getComponents, getConfiguration, getContextConfiguration, getDescription, getExecutableClassName, getImplementationCreationDate, getImplementationVersion, getImplementationVersionDescription, getLogger, getLoggingLevel, getName, getParent, getRole, getRoleCreationDate, getRoleVersion, getRoleVersionDescription, getUniqueID, init, log, log, setComponents, setConfiguration, setContextConfiguration, setDescription, setExecutableClassName, setImplemenationCreationDate, setImplementationVersion, setImplementationVersionDescription, setLogger, setLoggingLevel, setName, setParent, setRole, setRoleCreationDate, setRoleVersion, setRoleVersionDescription, setUniqueID, start, update

Constructor Detail

CBELogOutputter

public CBELogOutputter()

Method Detail

processEventItems

public java.lang.Object[] processEventItems(java.lang.Object[] msgs)

This implementation processes messages represented by an array of CommonBaseEvent objects where each CommonBaseEvent represents a message. Each CommonBaseEvent is written to a logging agent.

Specified by:

processEventItems in interface IProcessUnit

Overrides:

processEventItems in class ProcessUnit

Parameters:

msgs - - an array of CommonBaseEvent objects representing messages

Returns:

the same array of CommonBaseEvent objects that was passed in.

See Also:

IProcessUnit.processEventItems(java.lang.Object[])

testProcessEventItems

public java.lang.Object[] testProcessEventItems(java.lang.Object[] msgs)
                                         throws AdapterInvalidConfig

Simulate processing messages as CommonBaseEvent objects.

Specified by:

testProcessEventItems in interface IProcessUnit

Overrides:

testProcessEventItems in class ProcessUnit

Parameters:

msgs - - array of Objects to process

Returns:

the same array of Objects

Throws:

AdapterInvalidConfig

See Also:

IProcessUnit.testProcessEventItems(java.lang.Object[])

update

public void update()
            throws AdapterInvalidConfig

update the configuration based on the configuration Element

Specified by:

update in interface IComponent

Overrides:

update in class Outputter

Throws:

AdapterInvalidConfig

See Also:

IComponent.update()

setAgentName

public void setAgentName(java.lang.String aName)

Sets the name of the logging agent to write to

Parameters:

aName - - the name of the logging agent

getAgentName

public java.lang.String getAgentName()

Gets the name of the logging agent.

Returns:

the name of the logging agent.

setBufferSize

public void setBufferSize(int bufSize)

Sets the buffer size of the logging agent (i.e., the number of records buffered while the logging agent is not connected to the RAC).

Parameters:

bufSize - - logging agent buffer size.

getBufferSize

public int getBufferSize()

Gets the buffer size (i.e., the number of records buffered while the logging agent is not connected to the RAC).

Returns:

the logging agent buffer size (as an int)

setWaitTime

public void setWaitTime(long wTime)

Sets the logging agent wait time. This is the time the logging agent will wait for a client to attach and start monitoring before it starts writing events.

Parameters:

wTime - - the logging agent wait time

getWaitTime

public long getWaitTime()

Gets the logging agent wait time. This is the time the logging agent will wait for a client to attach and start monitoring before it starts writing events.

Returns:

the logging agent wait time.

stop

public void stop()

Stops the logging agent outputter which includes cleaning up the logging agent.

Specified by:

stop in interface IComponent

Overrides:

stop in class Component

See Also:

IComponent.stop()