Merge pull request #17 from rwth-acis/development

Development

Author: derjasper

build.xml

@@ -5,7 +5,7 @@
 	<property name="ivy.organisation" value="i5" />
 	<property name="ivy.module" value="las2peer" />
 	<property name="ivy.revision" value="0.5" />
-	<property name="ivy.build.number" value="4" />
+	<property name="ivy.build.number" value="5" />
 	<property name="ivy.deliver.revision" value="${ivy.revision}" />
 	<property name="ivy.pom.version" value="${ivy.revision}" />
 

src/main/java/i5/las2peer/api/Service.java

@@ -8,6 +8,7 @@
 import i5.las2peer.execution.L2pServiceException;
 import i5.las2peer.execution.L2pThread;
 import i5.las2peer.execution.NoSuchServiceMethodException;
+import i5.las2peer.logging.L2pLogger;
 import i5.las2peer.logging.NodeObserver.Event;
 import i5.las2peer.p2p.AgentNotKnownException;
 import i5.las2peer.p2p.Node;
@@ -403,7 +404,7 @@ public void close() {
 	}
 
 	/**
-	 * @deprecated Use {@link i5.las2peer.logging.L2pLogger#logEvent(Event, String)} with {@link Event#SERVICE_MESSAGE}
+	 * @deprecated Use {@link L2pLogger#logEvent(Event, String)} with {@link Event#SERVICE_MESSAGE}
 	 *             instead!
 	 *             <p>
 	 *             Writes a log message.
@@ -416,7 +417,7 @@ protected void logMessage(String message) {
 	}
 
 	/**
-	 * @deprecated Use {@link i5.las2peer.logging.L2pLogger#logEvent(Event, Agent, String)} instead!
+	 * @deprecated Use {@link L2pLogger#logEvent(Event, Agent, String)} instead!
 	 *             <p>
 	 *             Writes a log message. The given index (1-99) can be used to differentiate between different log
 	 *             messages.
@@ -441,7 +442,7 @@ protected void logMessage(int index, Agent actingUser, String message) {
 	}
 
 	/**
-	 * @deprecated Use {@link i5.las2peer.logging.L2pLogger#logEvent(Event, String)} with {@link Event#SERVICE_ERROR}
+	 * @deprecated Use {@link L2pLogger#logEvent(Event, String)} with {@link Event#SERVICE_ERROR}
 	 *             instead!
 	 *             <p>
 	 *             Writes an error log message.
@@ -454,7 +455,7 @@ protected void logError(String message) {
 	}
 
 	/**
-	 * @deprecated Use {@link i5.las2peer.logging.L2pLogger#logEvent(Event, Agent, String)} instead!
+	 * @deprecated Use {@link L2pLogger#logEvent(Event, Agent, String)} instead!
 	 *             <p>
 	 *             Writes an error message. The given index (1-99) can be used to differentiate between different log
 	 *             messages.
@@ -479,7 +480,7 @@ protected void logError(int index, Agent actingUser, String message) {
 	}
 
 	/**
-	 * @deprecated Use {@link i5.las2peer.logging.L2pLogger} instead!
+	 * @deprecated Use {@link L2pLogger} instead!
 	 *             <p>
 	 *             Writes an exception log message Additionally the stack trace is printed.
 	 * 

src/main/java/i5/las2peer/logging/L2pLogger.java

@@ -142,7 +142,7 @@ public String format(LogRecord record) {
 
 	/**
 	 * Prints a stack trace as nicely as {@code e.printStackTrace()}, but uses the logging system as output.
-	 * 
+	 *
 	 * @param e A {@code Throwable} thats stack trace should be printed.
 	 */
 	public synchronized void printStackTrace(Throwable e) {
@@ -153,7 +153,7 @@ public synchronized void printStackTrace(Throwable e) {
 
 	/**
 	 * Appends the stack trace for the given {@link Throwable} to the given {@link StringBuilder}.
-	 * 
+	 *
 	 * @param sb {@code StringBuilder} as output for the stack trace.
 	 * @param e A {@code Throwable} which stack trace should be appended. If {@code null} given, nothing is appended.
 	 */
@@ -168,7 +168,7 @@ protected static void printStackTrace(StringBuilder sb, Throwable e) {
 
 	/**
 	 * Just calls the parent constructor and adds the new instance to the LogManager.
-	 * 
+	 *
 	 * @param name A name for the logger. This should be a dot-separated name and should normally be based on the
 	 *            package name or class name of the subsystem, such as java.net or javax.swing. It may be null for
 	 *            anonymous Loggers.
@@ -190,7 +190,7 @@ protected L2pLogger(String name, String resourceBundleName) throws IllegalArgume
 
 	/**
 	 * Same as {@link #setLogDirectory(String)} for the global static instance.
-	 * 
+	 *
 	 * @param directory A directory path given as String. {@code null} is equal to "" and the class loader directory.
 	 * @throws IOException
 	 */
@@ -200,7 +200,7 @@ public static void setGlobalLogDirectory(String directory) throws IOException {
 
 	/**
 	 * Sets the directory to store log files.
-	 * 
+	 *
 	 * @param directory A directory path given as String. {@code null} is equal to "" and the class loader directory.
 	 * @throws IOException
 	 */
@@ -218,7 +218,7 @@ public synchronized void setLogDirectory(String directory) throws IOException {
 
 	/**
 	 * Same as {@link #setLogfilePrefix(String)} for global static instance.
-	 * 
+	 *
 	 * @param prefix If {@code null} is given, file logging will be disabled.
 	 * @throws IOException
 	 */
@@ -228,7 +228,7 @@ public static void setGlobalLogfilePrefix(String prefix) throws IOException {
 
 	/**
 	 * Sets the prefix used to generate log files.
-	 * 
+	 *
 	 * @param prefix If {@code null} is given, file logging will be disabled.
 	 * @throws IOException
 	 */
@@ -243,7 +243,7 @@ public synchronized void setLogfilePrefix(String prefix) throws IOException {
 
 	/**
 	 * This method must be called each time the log file target is changed.
-	 * 
+	 *
 	 * @throws IOException
 	 */
 	private synchronized void updateLogfileHandler() throws IOException {
@@ -277,7 +277,7 @@ private synchronized void updateLogfileHandler() throws IOException {
 
 	/**
 	 * This method ensures that the given directory is actually a directory and exists.
-	 * 
+	 *
 	 * @param dir A path given as String for the desired directory
 	 * @throws IOException return null;
 	 */
@@ -290,7 +290,7 @@ private static void createDir(String dir) throws IOException {
 
 	/**
 	 * Same as {@link #setConsoleLevel(Level)} for the global static instance.
-	 * 
+	 *
 	 * @param level The log level to set.
 	 */
 	public static void setGlobalConsoleLevel(Level level) {
@@ -299,7 +299,7 @@ public static void setGlobalConsoleLevel(Level level) {
 
 	/**
 	 * Sets the log level for the console output of this logger.
-	 * 
+	 *
 	 * @param level The log level to set.
 	 */
 	public synchronized void setConsoleLevel(Level level) {
@@ -309,7 +309,7 @@ public synchronized void setConsoleLevel(Level level) {
 
 	/**
 	 * Same as {@link #setLogfileLevel(Level)} for global static instance.
-	 * 
+	 *
 	 * @param level The log level to set.
 	 */
 	public static void setGlobalLogfileLevel(Level level) {
@@ -318,7 +318,7 @@ public static void setGlobalLogfileLevel(Level level) {
 
 	/**
 	 * Sets the log level for the log files used in this logger.
-	 * 
+	 *
 	 * @param level The log level to set.
 	 */
 	public synchronized void setLogfileLevel(Level level) {
@@ -361,7 +361,7 @@ public void log(LogRecord record) {
 
 	/**
 	 * Writes a log message. The given event can be used to differentiate between different log messages.
-	 * 
+	 *
 	 * @param event used to differentiate between different log messages
 	 * @param message
 	 */
@@ -371,7 +371,7 @@ public static void logEvent(Event event, String message) {
 
 	/**
 	 * Writes a log message. The given event can be used to differentiate between different log messages.
-	 * 
+	 *
 	 * @param event used to differentiate between different log messages
 	 * @param actingUser can be set to null if unknown / not desired
 	 * @param message
@@ -389,10 +389,10 @@ public static void logEvent(Event event, Agent actingUser, String message) {
 
 	/**
 	 * Logs a message to the l2p system using the observers.
-	 * 
+	 *
 	 * Since this method will/should only be used in an L2pThread, the message will come from a service or a helper, so
 	 * a SERVICE_MESSAGE is assumed. Then this message will not be monitored by the monitoring observer.
-	 * 
+	 *
 	 * @param from the calling class
 	 * @param event used to differentiate between different log messages
 	 * @param message
@@ -405,11 +405,11 @@ public static void logEvent(Object from, Event event, String message) {
 	 * Writes a log message. The given event can be used to differentiate between different log messages. The
 	 * serviceAgent and actingUser can be set to {@code null} if not known. Then this message will not be monitored by
 	 * the monitoring observer.
-	 * 
+	 *
 	 * This method replaces: {@link Context#logMessage(Object, int, String, Agent, Agent)},
 	 * {@link Context#logMessage(Object, String)}, {@link Context#logError(Object, int, String, Agent, Agent)},
 	 * {@link Context#logError(Object, String)}, {@link Service#logError(String message)}
-	 * 
+	 *
 	 * @param from the calling class
 	 * @param event used to differentiate between different log messages
 	 * @param message
@@ -430,7 +430,7 @@ public static void logEvent(Object from, Event event, String message, Agent serv
 	 * Writes a log message. The given event can be used to differentiate between different log messages. The
 	 * serviceAgent and actingUser can be set to {@code null} if not known. Then this message will not be monitored by
 	 * the monitoring observer.
-	 * 
+	 *
 	 * @param node
 	 * @param from the calling class
 	 * @param event used to differentiate between different log messages
@@ -466,20 +466,21 @@ public void log(Long timestamp, Event event, String sourceNode, Long sourceAgent
 
 	/**
 	 * Simple method for one log line entry. Null will be printed as "-". All values will be followed by a tab char.
-	 * 
+	 *
 	 * @param o
 	 * @return a string
 	 */
 	private static String appendPart(Object o) {
-		if (o == null)
+		if (o == null) {
 			return "-\t";
-		else
+		} else {
 			return "" + o + "\t";
+		}
 	}
 
 	/**
 	 * This method returns the default {@link Formatter} currently used to format log output for console.
-	 * 
+	 *
 	 * @return Returns the console formatter.
 	 */
 	public static Formatter getGlobalConsoleFormatter() {
@@ -488,25 +489,38 @@ public static Formatter getGlobalConsoleFormatter() {
 
 	/**
 	 * This method returns the default {@link Formatter} currently used to format log output for log files.
-	 * 
+	 *
 	 * @return Returns the log file formatter.
 	 */
 	public static Formatter getGlobalLogfileFormatter() {
 		return GLOBAL_INSTANCE.logfileFormatter;
 	}
 
 	/**
-	 * This method is the recommended way to retrieve a L2pLogger instance.
-	 * 
+	 * This method is used to retrieve a L2pLogger instance.
+	 *
+	 * @param cls Should be the class this instance is used with.
+	 * @return Returns a L2pLogger instance for the given class.
+	 * @throws ClassCastException If someone overloaded the loggers instance by adding some other logger implementation
+	 *             with the same name. In this case you may use Java native method by calling
+	 *             {@link Logger#getLogger(String)}.
+	 */
+	public static L2pLogger getInstance(Class<?> cls) throws ClassCastException {
+		return getInstance(cls.getCanonicalName());
+	}
+
+	/**
+	 * This method is used to retrieve a L2pLogger instance.
+	 *
 	 * @param name A name for the new logger instance. Should be the name of your current class by default. Like
-	 *            L2pLogger.class.getName()
+	 *            L2pLogger.class.getCanonicalName()
 	 * @return Returns a L2pLogger instance for the given name.
 	 * @throws ClassCastException If someone overloaded the loggers instance by adding some other logger implementation
 	 *             with the same name. In this case you may use Java native method by calling
 	 *             {@link Logger#getLogger(String)}.
 	 */
 	public static L2pLogger getInstance(String name) throws ClassCastException {
-		if (name == null || name.isEmpty() || "i5.las2peer".equals(name) || !name.startsWith("i5.las2peer")) {
+		if (name == null || name.isEmpty() || "i5.las2peer".equals(name)) {
 			throw new IllegalArgumentException("Invalid logger name '" + name + "' given!");
 		}
 		L2pLogger result = null;

src/main/java/i5/las2peer/persistency/Envelope.java

@@ -1,5 +1,20 @@
 package i5.las2peer.persistency;
 
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectStreamClass;
+import java.io.Serializable;
+import java.nio.charset.StandardCharsets;
+import java.util.Date;
+import java.util.Enumeration;
+import java.util.Hashtable;
+import java.util.Random;
+
+import javax.crypto.SecretKey;
+
+import org.apache.commons.codec.binary.Base64;
+
 import i5.las2peer.execution.L2pThread;
 import i5.las2peer.p2p.ArtifactNotFoundException;
 import i5.las2peer.p2p.StorageException;
@@ -17,21 +32,6 @@
 import i5.simpleXML.Parser;
 import i5.simpleXML.XMLSyntaxException;
 
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.ObjectInputStream;
-import java.io.ObjectStreamClass;
-import java.io.Serializable;
-import java.nio.charset.StandardCharsets;
-import java.util.Date;
-import java.util.Enumeration;
-import java.util.Hashtable;
-import java.util.Random;
-
-import javax.crypto.SecretKey;
-
-import org.apache.commons.codec.binary.Base64;
-
 /**
  * An envelope provides a secure storage for any {@link Serializable} content within the LAS2peer network.
  *