info.soaj.core.plugin
Class SjPluginLoggingSystemOut

java.lang.Object
  info.soaj.core.plugin.SjBasePlugin
      info.soaj.core.plugin.SjAbstractPluginLogging
          info.soaj.core.plugin.SjPluginLoggingSystemOut

All Implemented Interfaces:

java.io.Serializable

public class SjPluginLoggingSystemOut
extends SjAbstractPluginLogging

This SOAj plugin supports logging via System Out when no logging plugin is available. Typically, it is (only) used during application startup (the plugin activation sequence).

Copyright (c) 2006 - 2009 by Global Technology Consulting Group, Inc. at gtcGroup.com .

Since:

v. 1.0

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Field Summary

protected SjLoggerSystemOut	logger Logger
private static long	serialVersionUID UID

Fields inherited from class info.soaj.core.plugin.SjAbstractPluginLogging

throwableEmailPluginKey, throwableLogPluginKey

Constructor Summary

SjPluginLoggingSystemOut(SjPopulatedPluginKey pluginKey)
Constructor - protected

Method Summary

void	config(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
SjBaseMetadata	createPluginMetadataCB() This method
void	entering(java.lang.String CLASS_NAME, java.lang.String Method_Name)
void	exiting(java.lang.String CLASS_NAME, java.lang.String Method_Name)
void	fine(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
void	finer(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
void	finest(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
SjPluginProperties	getPluginProperties() This method returns the declared plugin properties.
void	info(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
boolean	isLoggable(java.util.logging.Level level)
boolean	isLoggerInitialized() This method indicates whether the encapsulated logger is initialized.
void	logDeclarative(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message, java.lang.String propertyKey) This method supplements standard level based logging.
void	logp(java.util.logging.Level level, java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message)
void	logp(java.util.logging.Level level, java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message, java.lang.Throwable thrown)
void	logrb(java.util.logging.Level level, java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String bundleName, java.lang.String message)
void	logrb(java.util.logging.Level level, java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String bundleName, java.lang.String message, java.lang.Throwable thrown)
void	severe(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.
boolean	verifyCB() This callback method is invoked exactly once upon application server startup AFTER the initCB() methods complete successfully for ALL plugins.
void	warning(java.lang.String CLASS_NAME, java.lang.String Method_Name, java.lang.String message) Requires context.

Methods inherited from class info.soaj.core.plugin.SjAbstractPluginLogging

initCB

Methods inherited from class info.soaj.core.plugin.SjBasePlugin

getPluginMetadata, getPopulatedPluginKey

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID

See Also:

Constant Field Values

logger

protected SjLoggerSystemOut logger

Logger

Constructor Detail

SjPluginLoggingSystemOut

public SjPluginLoggingSystemOut(SjPopulatedPluginKey pluginKey)

Constructor - protected

The SOAj plugin pattern enforces instantiation of a plugin via the General Store. Concrete class constructors should be coded as 'protected'.

Parameters:

pluginKey - The 'Key' defined in the descriptor document.

Method Detail

createPluginMetadataCB

public SjBaseMetadata createPluginMetadataCB()

Description copied from class: SjBasePlugin

This method

Specified by:

createPluginMetadataCB in class SjBasePlugin

Returns:

SjBaseMetadata - The wrapper object containing plugin information.

See Also:

SjBasePlugin.createPluginMetadataCB()

verifyCB

public boolean verifyCB()

This callback method is invoked exactly once upon application server startup AFTER the initCB() methods complete successfully for ALL plugins. This method provides an opportunity for a onetime execution of verification logic to ensure the integrity (or fitness) of a plugin for use. As an example, a sophisticated implementation might fire all of the plugin methods (perhaps using mock objects) to ensure the plugin is 100% operational.

Overrides:

verifyCB in class SjAbstractPluginLogging

Returns:

boolean - 'True' indicates the plugin is "good to go"!

getPluginProperties

public SjPluginProperties getPluginProperties()

Description copied from class: SjBasePlugin

This method returns the declared plugin properties.

Overrides:

getPluginProperties in class SjBasePlugin

Returns:

SjPluginProperties

See Also:

SjBasePlugin.getPluginProperties()

isLoggerInitialized

public boolean isLoggerInitialized()

Description copied from class: SjAbstractPluginLogging

This method indicates whether the encapsulated logger is initialized.

Specified by:

isLoggerInitialized in class SjAbstractPluginLogging

Returns:

boolean - 'True' indicates the logger is initialized.

See Also:

SjAbstractPluginLogging.isLoggerInitialized()

logDeclarative

public void logDeclarative(java.lang.String CLASS_NAME,
                           java.lang.String Method_Name,
                           java.lang.String message,
                           java.lang.String propertyKey)

This method supplements standard level based logging. Instead of level, logging (or not) is a binary declaration using a property in the descriptor document. This method defaults to logging if no property key is found.

Specified by:

logDeclarative in class SjAbstractPluginLogging

Parameters:

propertyKey -

CLASS_NAME -

Method_Name -

message -

entering

public void entering(java.lang.String CLASS_NAME,
                     java.lang.String Method_Name)

Specified by:

entering in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

exiting

public void exiting(java.lang.String CLASS_NAME,
                    java.lang.String Method_Name)

Specified by:

exiting in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

finest

public void finest(java.lang.String CLASS_NAME,
                   java.lang.String Method_Name,
                   java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

finest in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

finer

public void finer(java.lang.String CLASS_NAME,
                  java.lang.String Method_Name,
                  java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

finer in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

fine

public void fine(java.lang.String CLASS_NAME,
                 java.lang.String Method_Name,
                 java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

fine in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

config

public void config(java.lang.String CLASS_NAME,
                   java.lang.String Method_Name,
                   java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

config in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

info

public void info(java.lang.String CLASS_NAME,
                 java.lang.String Method_Name,
                 java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

info in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

warning

public void warning(java.lang.String CLASS_NAME,
                    java.lang.String Method_Name,
                    java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

warning in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

severe

public void severe(java.lang.String CLASS_NAME,
                   java.lang.String Method_Name,
                   java.lang.String message)

Requires context. (The JDK does not require source class and source method.)

Specified by:

severe in class SjAbstractPluginLogging

Parameters:

CLASS_NAME -

Method_Name -

message -

isLoggable

public boolean isLoggable(java.util.logging.Level level)

Specified by:

isLoggable in class SjAbstractPluginLogging

Parameters:

level -

Returns:

boolean

logp

public void logp(java.util.logging.Level level,
                 java.lang.String CLASS_NAME,
                 java.lang.String Method_Name,
                 java.lang.String message)

Specified by:

logp in class SjAbstractPluginLogging

Parameters:

level -

CLASS_NAME -

Method_Name -

message -

logp

public void logp(java.util.logging.Level level,
                 java.lang.String CLASS_NAME,
                 java.lang.String Method_Name,
                 java.lang.String message,
                 java.lang.Throwable thrown)

Specified by:

logp in class SjAbstractPluginLogging

Parameters:

level -

CLASS_NAME -

Method_Name -

message -

thrown -

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String CLASS_NAME,
                  java.lang.String Method_Name,
                  java.lang.String bundleName,
                  java.lang.String message)

Specified by:

logrb in class SjAbstractPluginLogging

Parameters:

level -

CLASS_NAME -

Method_Name -

bundleName -

message -

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String CLASS_NAME,
                  java.lang.String Method_Name,
                  java.lang.String bundleName,
                  java.lang.String message,
                  java.lang.Throwable thrown)

Specified by:

logrb in class SjAbstractPluginLogging

Parameters:

level -

CLASS_NAME -

Method_Name -

bundleName -

message -

thrown -