com.jalios.jstore.jsync

Class JSyncLogger

java.lang.Object

com.jalios.jstore.jsync.JSyncLogger

All Implemented Interfaces:

JSyncConstants, JaliosConstants

public class JSyncLogger
extends java.lang.Object
implements JSyncConstants

This class writes logs JSyncReplica actions such as join, disjoin, update, etc.

Version:

$Revision: 21412 $

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Fields inherited from interface com.jalios.jstore.jsync.JSyncConstants

SC_BAD_ADDRESS, SC_BAD_LEADER, SC_BAD_MESSAGE, SC_INTERNAL_SERVER_ERROR, SC_JOIN_REJECTED, SC_LEADER_CANNOT_JOIN, SC_NO_ACK, SC_NO_SEND, SC_OK, SC_UNKNOWN, SC_UNKNOWN_URID, SC_URID_ALREADY_ADDED, STATUS_LEADER, STATUS_LONE, STATUS_MEMBER, STATUS_SUBLEADER

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

Constructors

Constructor and Description
JSyncLogger(java.io.File logDir) Constructs a new JSyncLogger

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String type, java.lang.String action, java.lang.String urid, int sc, long duration, java.util.TreeMap<java.lang.String,java.lang.String> extra) Generic method to add a new entry in the log
void	addDisjoinIn(java.lang.String urid, int sc, long duration) Logs an incoming disjoin
void	addDisjoinOut(java.lang.String urid, int sc, long duration) Logs an outgoing disjoin
void	addJoinIn(java.lang.String urid, int sc, long duration) Logs an incoming join
void	addJoinOut(java.lang.String urid, int sc, long duration) Logs an outgoind join
void	addRejectedMessage(java.lang.String urid, int sc) Logs an internal message rejecting
void	addRemoveReplica(java.lang.String urid) Logs an internal replica removing
void	addSuggestJoinIn(java.lang.String urid, int sc, long duration) Logs an incoming suggestjoin
void	addSuggestJoinOut(java.lang.String urid, int sc, long duration) Logs an outging suggestjoin
void	addUpdateIn(java.lang.String urid, int sc, long duration, int nbOps, int nbFiles, boolean merge, int nbUU, int nbUD, int nbDU, int nbDD) Logs an incoming update
void	addUpdateOut(java.lang.String urid, int sc, long duration, int nbOps, int nbFiles, boolean partial) Logs an outgoing update
java.io.File	getLogFile(java.util.Date date) Return the log file for the given date
java.util.List<java.io.File>	getLogFileList(java.util.Date beginDate, java.util.Date endDate) Return a list of log file for the given date range
java.lang.String	getStatusLabel(int sc, java.util.Locale locale) Return the label of the given status code

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

JSyncLogger

public JSyncLogger(java.io.File logDir)

Constructs a new JSyncLogger

Parameters:

logDir - the log directory

Since:

jcms-4.1

Method Detail

getLogFile

public java.io.File getLogFile(java.util.Date date)

Return the log file for the given date

Parameters:

date - the date

Returns:

the log file for the given date

Since:

jcms-4.1

getLogFileList

public java.util.List<java.io.File> getLogFileList(java.util.Date beginDate,
                                          java.util.Date endDate)

Return a list of log file for the given date range

Parameters:

beginDate - the begin date

endDate - the end date

Returns:

a List of File objects

Since:

jcms-4.1

getStatusLabel

public java.lang.String getStatusLabel(int sc,
                              java.util.Locale locale)

Return the label of the given status code

Parameters:

sc - the status code (must be a new status code value (e.g. 1101, 1200, ...)

locale - the locale to be used

Returns:

the status label

Since:

jcms-4.1

add

public void add(java.lang.String type,
       java.lang.String action,
       java.lang.String urid,
       int sc,
       long duration,
       java.util.TreeMap<java.lang.String,java.lang.String> extra)

Generic method to add a new entry in the log

Parameters:

type - the type of the log (in, out, internal)

action - the action (join, disjoin, update, ...)

urid - the urid

sc - the status code

duration - the duration

extra - an extra map of attributes

Since:

jcms-4.1

addJoinIn

public void addJoinIn(java.lang.String urid,
             int sc,
             long duration)

Logs an incoming join

Parameters:

urid - the urid of the replica which has sent the join message

sc - the status code sent

duration - the duration

Since:

jcms-4.1

addSuggestJoinIn

public void addSuggestJoinIn(java.lang.String urid,
                    int sc,
                    long duration)

Logs an incoming suggestjoin

Parameters:

urid - the urid of the replica which has sent the join message

sc - the status code sent

duration - the duration

Since:

jcms-5.7.4

addSuggestJoinOut

public void addSuggestJoinOut(java.lang.String urid,
                     int sc,
                     long duration)

Logs an outging suggestjoin

Parameters:

urid - the urid of the replica which has sent the join message

sc - the status code sent

duration - the duration

Since:

jcms-5.7.4

addJoinOut

public void addJoinOut(java.lang.String urid,
              int sc,
              long duration)

Logs an outgoind join

Parameters:

urid - the urid of the leader

sc - the status code received

duration - the duration

Since:

jcms-4.1

addDisjoinIn

public void addDisjoinIn(java.lang.String urid,
                int sc,
                long duration)

Logs an incoming disjoin

Parameters:

urid - the urid of the replica which has sent the disjoin message

sc - the status code sent

duration - the duration

Since:

jcms-4.1

addDisjoinOut

public void addDisjoinOut(java.lang.String urid,
                 int sc,
                 long duration)

Logs an outgoing disjoin

Parameters:

urid - the urid of the leader

sc - the status code received

duration - the duration

Since:

jcms-4.1

addUpdateIn

public void addUpdateIn(java.lang.String urid,
               int sc,
               long duration,
               int nbOps,
               int nbFiles,
               boolean merge,
               int nbUU,
               int nbUD,
               int nbDU,
               int nbDD)

Logs an incoming update

Parameters:

urid - the urid of the replica which has sent the update message

sc - the status code sent

duration - the duration

nbOps - the number of operations

nbFiles - the number of files

merge - true if the 2 divergents store suffix have been merged

nbUU - the number of U/U conflicts

nbUD - the number of U/D conflicts

nbDU - the number of D/U conflicts

nbDD - the number of D/D conflicts

Since:

jcms-4.1

addUpdateOut

public void addUpdateOut(java.lang.String urid,
                int sc,
                long duration,
                int nbOps,
                int nbFiles,
                boolean partial)

Logs an outgoing update

Parameters:

urid - the urid of the replica the message has been sent

sc - the status code received

duration - the duration

nbOps - the number of operations

nbFiles - the number of files

partial - true if this is a partial update

Since:

jcms-4.1

addRemoveReplica

public void addRemoveReplica(java.lang.String urid)

Logs an internal replica removing

Parameters:

urid - the urid of the replica removed

Since:

jcms-4.1

addRejectedMessage

public void addRejectedMessage(java.lang.String urid,
                      int sc)

Logs an internal message rejecting

Parameters:

urid - the urid of the replica rejected

sc - the status code sent

Since:

jcms-4.1