com.highqsoft.xsd

Class AsamOdsHandler

java.lang.Object

java.util.logging.Handler

java.util.logging.StreamHandler

java.util.logging.ConsoleHandler

com.highqsoft.xsd.AsamOdsHandler

All Implemented Interfaces:

ImplementationIF

public abstract class AsamOdsHandler
extends java.util.logging.ConsoleHandler
implements ImplementationIF

This is an abstract logger for ASAM ODS. It uses the session descriptor to create a new session. The handler uses a default formatter, that returns the message only.

The session that is used by the handler, is stored as reference in context by the constant com.highqsoft.xsd.AsamOdsHandler.HANDLER_SESSION_KEY and can be reused for other purposes.

The object is able to consume the following properties:

Property Keyword	Datatype	Default	Description
TargetRef	String	none	The name of reference to the target ASAM ODS session.
ApplElemName	String	none	The name of application element htat should be used for logging.

The following table lists the properties that should be set in the main context.

Argument Keyword	Datatype	Default	Description
ERROR.MissingArgument	String	The argument {0} is missing.	The message that is used when an argument is missing.

Since:

$Date: 2018/09/12 14:38:34 $

Version:

$Revision: 1.16 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AsamOdsHandler.DefaultFormatter The default formatter.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationElement	aeObj The application element that should be used for logging.
protected T_LONGLONG	aid
protected AoSession	aoSession The ASAM ODS Session.
protected java.util.Properties	arguments The arguments of the implementation.
protected java.util.Vector<ElemId>	createdElems A vector that collects the created instance elements.
protected XSDContextIF	ctx The context.
protected java.lang.Object	descriptor The XML object descriptor.
static java.lang.String	HANDLER_SESSION_KEY
protected java.util.Vector<InstanceElement>	relIEs The related instance to that the log instances should be linked.
protected java.util.Map<InstanceElement,ApplicationRelation[]>	relMap The map that holds the relations to the instance elements.
protected boolean	requestToCloseSession

Constructor Summary

Constructors

Constructor and Description
AsamOdsHandler() Create the formatter.

Method Summary

Methods

Modifier and Type	Method and Description
int	addElement(ElemId elemId) Add an element to the created element array.
void	addRelatedInstance(ElemId relIe) Add a related instance element.
void	close() Override ConsoleHandler.close to close ASAM ODS session.
void	closeSession() Close the session.
T_LONGLONG	getAId() Get the application element id that should be used for logging.
ApplicationElement	getApplicationElement() Get the application element that should be used for logging.
XSDContextIF	getContext() Get the context.
ElemId[]	getCreatedElements() Get all created instances.
java.lang.Object	getDescriptor() Get the xml tree descriptor.
InstanceElement[]	getRelatedInstances() Get the instances to that the log entries should be linked to.
ApplicationRelation[]	getRelation(InstanceElement ieObj) Get the relation of the given element to the log application element.
AoSession	getSession() Get the ASAM ODS session.
void	init() Initialize the work.
abstract void	publish(java.util.logging.LogRecord record) Publish the log record to the stderr print stream.
void	removeElement(ElemId elemId) Remove an element from the created element array.
void	removeRelatedInstance(ElemId relIe) Remove a related instance element.
void	setArguments(java.util.Properties args) Set argument property map.
void	setContext(XSDContextIF ctx) Set the context.
void	setDescriptor(java.lang.Object descriptor) Set the xml tree descriptor.

Methods inherited from class java.util.logging.StreamHandler

flush, isLoggable, setEncoding, setOutputStream

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

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

Field Detail

HANDLER_SESSION_KEY

public static final java.lang.String HANDLER_SESSION_KEY

ctx

protected XSDContextIF ctx

The context.

arguments

protected java.util.Properties arguments

The arguments of the implementation.

aeObj

protected ApplicationElement aeObj

The application element that should be used for logging.

aid

protected T_LONGLONG aid

aoSession

protected AoSession aoSession

The ASAM ODS Session.

requestToCloseSession

protected boolean requestToCloseSession

descriptor

protected java.lang.Object descriptor

The XML object descriptor.

createdElems

protected java.util.Vector<ElemId> createdElems

A vector that collects the created instance elements.

relIEs

protected java.util.Vector<InstanceElement> relIEs

The related instance to that the log instances should be linked.

relMap

protected java.util.Map<InstanceElement,ApplicationRelation[]> relMap

The map that holds the relations to the instance elements.

Constructor Detail

AsamOdsHandler

public AsamOdsHandler()

Create the formatter.

Method Detail

setContext

public void setContext(XSDContextIF ctx)

Set the context.

Specified by:

setContext in interface ImplementationIF

Parameters:

ctx - the context.

getContext

public XSDContextIF getContext()

Get the context.

Specified by:

getContext in interface ImplementationIF

Returns:

ctx the context.

setArguments

public void setArguments(java.util.Properties args)
                  throws InvalidArgumentException

Set argument property map.

Specified by:

setArguments in interface ImplementationIF

Parameters:

args - the property map

Throws:

InvalidArgumentException - if the arguments are not valid.

setDescriptor

public void setDescriptor(java.lang.Object descriptor)
                   throws InvalidDescriptorException

Set the xml tree descriptor.

Specified by:

setDescriptor in interface ImplementationIF

Parameters:

descriptor - the tree node.

Throws:

InvalidDescriptorException - if the descriptor isn't valid.

getDescriptor

public java.lang.Object getDescriptor()

Get the xml tree descriptor.

Specified by:

getDescriptor in interface ImplementationIF

Returns:

the tree node.

init

public void init()
          throws InitializationFailedException

Initialize the work.

Specified by:

init in interface ImplementationIF

Throws:

InitializationFailedException - if the initialization fails.

getSession

public AoSession getSession()
                     throws AoException

Get the ASAM ODS session.

Returns:

the session. It may be null if the connection is currently not established.

Throws:

AoException

closeSession

public void closeSession()
                  throws AoException

Close the session.

Throws:

AoException

close

public void close()

Override ConsoleHandler.close to close ASAM ODS session.

Overrides:

close in class java.util.logging.ConsoleHandler

getApplicationElement

public ApplicationElement getApplicationElement()
                                         throws AoException

Get the application element that should be used for logging.

Returns:

the application element.

Throws:

AoException

getAId

public T_LONGLONG getAId()
                  throws AoException

Get the application element id that should be used for logging.

Returns:

the application element id.

Throws:

AoException

publish

public abstract void publish(java.util.logging.LogRecord record)

Publish the log record to the stderr print stream.

Overrides:

publish in class java.util.logging.ConsoleHandler

Parameters:

record - the log record.

getCreatedElements

public ElemId[] getCreatedElements()

Get all created instances.

Returns:

an array containing all created ElemId objects of the instance elements.

addElement

public int addElement(ElemId elemId)

Add an element to the created element array.

Parameters:

elemId - an ElemId object of the instance element.

Returns:

the index of the newly inserted element.

removeElement

public void removeElement(ElemId elemId)

Remove an element from the created element array.

Parameters:

index - the index of the instance element to be removed.

addRelatedInstance

public void addRelatedInstance(ElemId relIe)
                        throws AoException

Add a related instance element.

Parameters:

relIe - the related instance.

Throws:

AoException

removeRelatedInstance

public void removeRelatedInstance(ElemId relIe)
                           throws AoException

Remove a related instance element.

Parameters:

relIe - the related instance.

Throws:

AoException

getRelatedInstances

public InstanceElement[] getRelatedInstances()

Get the instances to that the log entries should be linked to.

Returns:

an array of the elements.

getRelation

public ApplicationRelation[] getRelation(InstanceElement ieObj)
                                  throws AoException

Get the relation of the given element to the log application element.

Throws:

AoException