org.smartfrog.sfcore.logging
Class SFPrimLogImpl

java.lang.Object
  org.smartfrog.sfcore.reference.RemoteReferenceResolverHelperImpl
      org.smartfrog.sfcore.prim.PrimImpl
          org.smartfrog.sfcore.logging.SFPrimLogImpl

All Implemented Interfaces:

java.rmi.Remote, MessageKeys, Log, LogRemote, SFPrimLog, Diagnostics, Liveness, Prim, RemoteReferenceResolver, RemoteReferenceResolverHelper

public class SFPrimLogImpl
extends PrimImpl
implements Prim, SFPrimLog, Log

Implementation for SFLog component.

Field Summary

Fields inherited from class org.smartfrog.sfcore.prim.PrimImpl

refLivenessDelay, refLivenessFactor, sfCompleteName, sfContext, sfDeployHooks, sfDeployWithHooks, sfExportRef, sfIsDeployed, sfIsStarted, sfIsTerminated, sfIsTerminating, sfLivenessCount, sfLivenessDelay, sfLivenessFactor, sfLivenessSender, sfParent, sfStartHooks, sfTerminateWithHooks, termLock

Fields inherited from interface org.smartfrog.sfcore.logging.SFPrimLog

ATR_LOG_ASYNCH, ATR_LOG_FROM, ATR_LOG_LEVEL, ATR_LOG_NAME, ATR_LOG_TO, ATR_LOGGER_CLASS

Fields inherited from interface org.smartfrog.sfcore.common.MessageKeys

CANNOT_LINK_TO_PREDICATE, COMPONENT_TERMINATED, COPY_FAILED, COPY_SERIALIZE_FAILED, ERROR_NO_SECURITY_BUT_REQUIRED, ILLEGAL_BOOLEAN_PARAMETER, ILLEGAL_NUMERIC_PARAMETER, ILLEGAL_STRING_PARAMETER, ILLEGAL_VECTOR_PARAMETER, LIVENESS_SEND_FAILURE, LIVENESS_SEND_FAILURE_IN, MISSING_PARAMETER, MSG_CLASS_NOT_FOUND, MSG_CONNECT_ERR, MSG_CONT_OTHER_DEPLOY, MSG_DEPLOY_COMP_TERMINATED, MSG_DEPLOY_SUCCESS, MSG_DEPLOYWITH_PHASE_FAILED, MSG_DETACH_SUCCESS, MSG_DETACH_TERMINATE_SUCCESS, MSG_ERR_DEPLOY_FROM_URL, MSG_ERR_PARSE, MSG_ERR_RESOLVE_PHASE, MSG_ERR_SF_RUNNING, MSG_ERR_TERM, MSG_FAILED_INET_ADDRESS_LOOKUP, MSG_FAILED_TO_CONTACT_PARENT, MSG_FILE_NOT_FOUND, MSG_HOOK_ACTION_FAILED, MSG_ILLEGAL_ACCESS, MSG_ILLEGAL_CLASS_TYPE, MSG_ILLEGAL_CLASS_TYPE_EXPECTING_GOT, MSG_ILLEGAL_REFERENCE, MSG_INPUTSTREAM_NULL, MSG_INSTANTIATION_ERROR, MSG_INVALID_OBJECT_TYPE, MSG_INVOCATION_TARGET, MSG_LANG_NOT_FOUND, MSG_LIVENESS_START_FAILED, MSG_LOADING_URL, MSG_METHOD_NOT_FOUND, MSG_NON_REP_ATTRIB, MSG_NOT_COMPONENT_REFERENCE, MSG_NOT_FOUND_ATTRIBUTE, MSG_NOT_FOUND_REFERENCE, MSG_NOT_VALUE_REFERENCE, MSG_NULL_DEF_METHOD, MSG_NULL_URL, MSG_OBJECT_REGISTRATION_FAILED, MSG_PARENT_LOCATION_FAILED, MSG_PING_SUCCESS, MSG_RANDM_ERR, MSG_REMOTE_CONNECT_ERR, MSG_REPEATED_ATTRIBUTE, MSG_SF_DEAD, MSG_SF_READY, MSG_SF_TERMINATED, MSG_STACKTRACE_FOLLOWS, MSG_START_COMP_TERMINATED, MSG_TERMINATE_SUCCESS, MSG_UNHANDLED_EXCEPTION, MSG_UNKNOWN_HOST, MSG_UNRESOLVED_REFERENCE, MSG_UNRESOLVED_REFERENCE_IN, MSG_UPDATE_SUCCESS, MSG_URL_NOT_FOUND, MSG_URL_TO_PARSE_NOT_FOUND, MSG_WARNING_LIVENESS_ENABLED, MSG_WARNING_STACKTRACE_DISABLED, MSG_WARNING_STACKTRACE_ENABLED, ROOT_MUST_BE_COMPONENT, WARN_NO_SECURITY

Constructor Summary

SFPrimLogImpl()
Constructor for the SFLogImpl object.

Method Summary

void	debug(java.lang.Object message) Log a message with debug log level.
void	debug(java.lang.Object message, java.lang.Throwable t) Log an error with debug log level.
void	error(java.lang.Object message) Log a message with error log level.
void	error(java.lang.Object message, java.lang.Throwable t) Log an error with error log level.
void	fatal(java.lang.Object message) Log a message with fatal log level.
void	fatal(java.lang.Object message, java.lang.Throwable t) Log an error with fatal log level.
void	info(java.lang.Object message) Log a message with info log level.
void	info(java.lang.Object message, java.lang.Throwable t) Log an error with info log level.
boolean	isDebugEnabled() Is debug logging currently enabled?
boolean	isErrorEnabled() Is error logging currently enabled?
boolean	isFatalEnabled() Is fatal logging currently enabled?
boolean	isInfoEnabled() Is info logging currently enabled?
boolean	isTraceEnabled() Is trace logging currently enabled?
boolean	isWarnEnabled() Is warning logging currently enabled?
protected void	readConfiguration() Reads optional and mandatory attributes.
void	sfDeploy() Called after instantiation for deployment purposes.
Log	sfResolve(Reference reference, Log defaultValue, boolean mandatory) Resolves given reference and gets a Log.
Log	sfResolve(java.lang.String referencePart, Log defaultValue, boolean mandatory) Resolves a referencePart given a string and gets a Log.
void	sfTerminateWith(TerminationRecord t) Provides hook for subclasses to implement useful termination behavior.
void	trace(java.lang.Object message) Log a message with trace log level.
void	trace(java.lang.Object message, java.lang.Throwable t) Log an error with trace log level.
void	warn(java.lang.Object message) Log a message with warn log level.
void	warn(java.lang.Object message, java.lang.Throwable t) Log an error with warn log level.

Methods inherited from class org.smartfrog.sfcore.prim.PrimImpl

equals, hashCode, registerWithProcessCompound, sfAddAttribute, sfAttributeKeyFor, sfAttributes, sfCompleteName, sfCompleteNameSafe, sfContainsAttribute, sfContainsValue, sfContext, sfDeployedHost, sfDeployedProcessName, sfDeployWith, sfDetach, sfDetachAndTerminate, sfDiagnosticsReport, sfDumpState, sfExport, sfExportRef, sfExportRef, sfGetApplicationLog, sfGetCoreLog, sfGetLog, sfIsDeployed, sfIsRemote, sfIsStarted, sfIsTerminated, sfIsTerminating, sfLivenessFailure, sfLog, sfParent, sfParentageChanged, sfPing, sfRemoveAttribute, sfReplaceAttribute, sfResolve, sfResolve, sfResolveHere, sfResolveHere, sfResolveParent, sfSetLog, sfStart, sfStartLivenessSender, sfStopLivenessSender, sfTerminate, sfTerminatedWith, sfTerminateQuietlyWith, sfValues, terminateComponent, terminateNotifying, toString

Methods inherited from class org.smartfrog.sfcore.reference.RemoteReferenceResolverHelperImpl

sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolveWithParser

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.smartfrog.sfcore.prim.Prim

sfAddAttribute, sfAttributeKeyFor, sfAttributes, sfCompleteName, sfContainsAttribute, sfContainsValue, sfContext, sfDeployedHost, sfDeployedProcessName, sfDeployWith, sfDetach, sfDetachAndTerminate, sfDumpState, sfIsDeployed, sfIsStarted, sfIsTerminated, sfIsTerminating, sfParent, sfParentageChanged, sfRemoveAttribute, sfReplaceAttribute, sfStart, sfTerminate, sfTerminatedWith, sfTerminateQuietlyWith, sfValues

Methods inherited from interface org.smartfrog.sfcore.prim.Liveness

sfPing

Methods inherited from interface org.smartfrog.sfcore.reference.RemoteReferenceResolver

sfResolve, sfResolve, sfResolveHere, sfResolveHere, sfResolveParent

Methods inherited from interface org.smartfrog.sfcore.reference.RemoteReferenceResolverHelper

sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolve, sfResolveWithParser

Methods inherited from interface org.smartfrog.sfcore.prim.Diagnostics

sfDiagnosticsReport

Constructor Detail

SFPrimLogImpl

public SFPrimLogImpl()
              throws java.rmi.RemoteException

Constructor for the SFLogImpl object.

Throws:

java.rmi.RemoteException - In case of network/rmi error

Method Detail

sfDeploy

public void sfDeploy()
              throws SmartFrogException,
                     java.rmi.RemoteException

Description copied from class: PrimImpl

Called after instantiation for deployment purposes. Heart monitor is started and if there is a parent the deployed component is added to the heartbeat. Subclasses can override to provide additional deployment behavior.

Specified by:

sfDeploy in interface Prim

Overrides:

sfDeploy in class PrimImpl

Throws:

SmartFrogException - In case of error in deploying

java.rmi.RemoteException - In case of network/rmi error

sfTerminateWith

public void sfTerminateWith(TerminationRecord t)

Description copied from class: PrimImpl

Provides hook for subclasses to implement useful termination behavior. Deregisters component from local process compound (if ever registered)

Overrides:

sfTerminateWith in class PrimImpl

Parameters:

t - TerminationRecord object

readConfiguration

protected void readConfiguration()
                          throws SmartFrogException,
                                 java.rmi.RemoteException

Reads optional and mandatory attributes.

Throws:

SmartFrogException - error while reading attributes

java.rmi.RemoteException - In case of network/rmi error

isDebugEnabled

public boolean isDebugEnabled()

Is debug logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than debug.

Specified by:

isDebugEnabled in interface Log

Specified by:

isDebugEnabled in interface LogRemote

Returns:

boolean true if debug level is currently enabled

isErrorEnabled

public boolean isErrorEnabled()

Is error logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than error.

Specified by:

isErrorEnabled in interface Log

Specified by:

isErrorEnabled in interface LogRemote

Returns:

boolean true if error level is currently enabled

isFatalEnabled

public boolean isFatalEnabled()

Is fatal logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than fatal.

Specified by:

isFatalEnabled in interface Log

Specified by:

isFatalEnabled in interface LogRemote

Returns:

boolean true if fatal level is currently enabled

isInfoEnabled

public boolean isInfoEnabled()

Is info logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than info.

Specified by:

isInfoEnabled in interface Log

Specified by:

isInfoEnabled in interface LogRemote

Returns:

boolean true if info level is currently enabled

isTraceEnabled

public boolean isTraceEnabled()

Is trace logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than trace.

Specified by:

isTraceEnabled in interface Log

Specified by:

isTraceEnabled in interface LogRemote

Returns:

boolean true if trace level is currently enabled

isWarnEnabled

public boolean isWarnEnabled()

Is warning logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

Specified by:

isWarnEnabled in interface Log

Specified by:

isWarnEnabled in interface LogRemote

Returns:

boolean true if warn level is currently enabled

trace

public void trace(java.lang.Object message)

Log a message with trace log level.

Specified by:

trace in interface Log

Specified by:

trace in interface LogRemote

Parameters:

message - log this message

trace

public void trace(java.lang.Object message,
                  java.lang.Throwable t)

Log an error with trace log level.

Specified by:

trace in interface Log

Specified by:

trace in interface LogRemote

Parameters:

message - log this message

t - log this cause

debug

public void debug(java.lang.Object message)

Log a message with debug log level.

Specified by:

debug in interface Log

Specified by:

debug in interface LogRemote

Parameters:

message - log this message

debug

public void debug(java.lang.Object message,
                  java.lang.Throwable t)

Log an error with debug log level.

Specified by:

debug in interface Log

Specified by:

debug in interface LogRemote

Parameters:

message - log this message

t - log this cause

info

public void info(java.lang.Object message)

Log a message with info log level.

Specified by:

info in interface Log

Specified by:

info in interface LogRemote

Parameters:

message - log this message

info

public void info(java.lang.Object message,
                 java.lang.Throwable t)

Log an error with info log level.

Specified by:

info in interface Log

Specified by:

info in interface LogRemote

Parameters:

message - log this message

t - log this cause

warn

public void warn(java.lang.Object message)

Log a message with warn log level.

Specified by:

warn in interface Log

Specified by:

warn in interface LogRemote

Parameters:

message - log this message

warn

public void warn(java.lang.Object message,
                 java.lang.Throwable t)

Log an error with warn log level.

Specified by:

warn in interface Log

Specified by:

warn in interface LogRemote

Parameters:

message - log this message

t - log this cause

error

public void error(java.lang.Object message)

Log a message with error log level.

Specified by:

error in interface Log

Specified by:

error in interface LogRemote

Parameters:

message - log this message

error

public void error(java.lang.Object message,
                  java.lang.Throwable t)

Log an error with error log level.

Specified by:

error in interface Log

Specified by:

error in interface LogRemote

Parameters:

message - log this message

t - log this cause

fatal

public void fatal(java.lang.Object message)

Log a message with fatal log level.

Specified by:

fatal in interface Log

Specified by:

fatal in interface LogRemote

Parameters:

message - log this message

fatal

public void fatal(java.lang.Object message,
                  java.lang.Throwable t)

Log an error with fatal log level.

Specified by:

fatal in interface Log

Specified by:

fatal in interface LogRemote

Parameters:

message - log this message

t - log this cause

sfResolve

public Log sfResolve(Reference reference,
                     Log defaultValue,
                     boolean mandatory)
              throws SmartFrogResolutionException,
                     java.rmi.RemoteException

Resolves given reference and gets a Log. Utility method to resolve an attribute with a Log value.

Parameters:

reference - reference

defaultValue - Log default value that is returned when reference is not found and it is not mandatory

mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a ResolutionException

Returns:

Log for attribute value or defaultValue if not found

Throws:

SmartFrogResolutionException - illegal reference or reference not resolvable

java.rmi.RemoteException - in cae of Remote/Network error

sfResolve

public Log sfResolve(java.lang.String referencePart,
                     Log defaultValue,
                     boolean mandatory)
              throws SmartFrogResolutionException,
                     java.rmi.RemoteException

Resolves a referencePart given a string and gets a Log. Utility method to resolve an attribute with a Log value.

Parameters:

referencePart - string field reference

defaultValue - Log default value that is returned when reference is not found and it is not mandatory

mandatory - boolean that indicates if this attribute must be present in the description. If it is mandatory and not found it triggers a SmartFrogResolutionException

Returns:

Log for attribute value or defaultValue if not found

Throws:

SmartFrogResolutionException - illegal reference or reference not resolvable

java.rmi.RemoteException - in cae of Remote/Network error