Skip to content
Snippets Groups Projects
Commit b7eed27d authored by Nils Christian Ehmke's avatar Nils Christian Ehmke
Browse files

Comments and minor refactoring

parent 9fe8d3e4
Branches
Tags
No related merge requests found
Showing
with 139 additions and 226 deletions
...@@ -40,18 +40,18 @@ import kieker.common.logging.LogImplWebguiLogging; ...@@ -40,18 +40,18 @@ import kieker.common.logging.LogImplWebguiLogging;
import kieker.webgui.common.exception.ReflectionException; import kieker.webgui.common.exception.ReflectionException;
/** /**
* The {@link ClassAndMethodContainer} is a container which contains - as the name already tells - various classes and methods. To be more precisely, it uses a * This is a container which contains various classes. It uses a given class loader to load the equivalence of specific classes via the Java reflection API. This
* given class loader to load the equivalence of specific classes via reflection within this application to ensure that comparisons, assignments and the use of * makes sure that comparisons and assignments can be done correctly. The whole procedure is necessary, as every project within this application has a various number
* specific methods will be done correctly. This is necessary as for every project within this application there will be a number of libraries which will be combined * of libraries and therefore another class loader. This results in multiple instances of the same class and has to be
* in one class loader. This will result in multiple version of one and the same class and therefore in problems, if one doesn't use the correct class version.<br> * managed correctly.<br>
* </br> * </br>
* *
* As we use the Mirror framework in this project (which simplifies some accesses to the Java reflection API) not all methods and classes have to be loaded in this * Not all classes and methods which are used in the web application are loaded in this container. Some other elements are accessed with the Mirror framework (which
* class. * simplifies the usage of the Java reflection API).
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
public class ClassAndMethodContainer { public class ClassContainer {
private Class<?> logImplWebguiLoggingClass; private Class<?> logImplWebguiLoggingClass;
private Class<?> analysisControllerWithMappingClass; private Class<?> analysisControllerWithMappingClass;
...@@ -85,14 +85,11 @@ public class ClassAndMethodContainer { ...@@ -85,14 +85,11 @@ public class ClassAndMethodContainer {
* If one or more of the classes or methods for this container could not be found. * If one or more of the classes or methods for this container could not be found.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public ClassAndMethodContainer(final ClassLoader classLoader) throws ReflectionException { public ClassContainer(final ClassLoader classLoader) throws ReflectionException {
try { try {
// Load the classes
// For the first: Use the classloader the load all classes we will need.
this.logImplWebguiLoggingClass = classLoader.loadClass(LogImplWebguiLogging.class.getName()); this.logImplWebguiLoggingClass = classLoader.loadClass(LogImplWebguiLogging.class.getName());
this.analysisControllerWithMappingClass = classLoader.loadClass(AnalysisControllerWithMapping.class.getName()); this.analysisControllerWithMappingClass = classLoader.loadClass(AnalysisControllerWithMapping.class.getName());
this.analysisControllerClass = classLoader.loadClass(AnalysisController.class.getName()); this.analysisControllerClass = classLoader.loadClass(AnalysisController.class.getName());
this.analysisControllerThreadClass = classLoader.loadClass(AnalysisControllerThread.class.getName()); this.analysisControllerThreadClass = classLoader.loadClass(AnalysisControllerThread.class.getName());
this.abstractFilterPluginClass = classLoader.loadClass(AbstractFilterPlugin.class.getName()); this.abstractFilterPluginClass = classLoader.loadClass(AbstractFilterPlugin.class.getName());
...@@ -116,13 +113,7 @@ public class ClassAndMethodContainer { ...@@ -116,13 +113,7 @@ public class ClassAndMethodContainer {
} catch (final ClassNotFoundException ex) { } catch (final ClassNotFoundException ex) {
// Something went wrong. We can do nothing except throwing an exception // Something went wrong. We can do nothing except throwing an exception
throw new ReflectionException("An error occured while loading the classes and methods.", ex); throw new ReflectionException("An error occured while loading the classes", ex);
} catch (final SecurityException ex) {
// Something went wrong. We can do nothing except throwing an exception
throw new ReflectionException("An error occured while loading the classes and methods.", ex);
} catch (final ClassCastException ex) {
// Something went wrong. We can do nothing except throwing an exception
throw new ReflectionException("An error occured while loading the classes and methods.", ex);
} }
} }
......
...@@ -23,8 +23,13 @@ import kieker.common.logging.Log; ...@@ -23,8 +23,13 @@ import kieker.common.logging.Log;
import kieker.common.logging.LogFactory; import kieker.common.logging.LogFactory;
/** /**
* This class is a context listener, which will be activated during the initialization of the application. It is used to initialize some environment properties for * This is a context listener, which will be activated during the initialization of the application. It initializes some environment properties, which are necessary
* the WebGUI. * for the web application.<br>
* </br>
*
* The only environment property which is currently set by this listener is the property for the web application logger. This makes sure that later created analyses
* use the correct logger, whose messages can be intercepted by this application. If this environment property is not set, the log entries of the analyses cannot be
* shown in the corresponding control panel.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -46,15 +51,18 @@ public class EnvironmentLoaderListener implements ServletContextListener { ...@@ -46,15 +51,18 @@ public class EnvironmentLoaderListener implements ServletContextListener {
@Override @Override
public void contextInitialized(final ServletContextEvent event) { public void contextInitialized(final ServletContextEvent event) {
EnvironmentLoaderListener.LOG.info("Starting Kieker.WebGUI environment initialization."); // We have to use the logger before setting the environment property. This makes sure, that our own logger is not initialized with the web application
final long tin = System.currentTimeMillis(); // logger. All components which are created later use the correct logger though (they are loaded with another class loader and use another instance of the
// logging factory class therefore).
LOG.info("Starting Kieker.WebGUI environment initialization.");
final long timeIn = System.currentTimeMillis();
// Set the system property to make sure that the webgui logger will be used
System.setProperty("kieker.common.logging.Log", "WEBGUI"); System.setProperty("kieker.common.logging.Log", "WEBGUI");
final long tout = System.currentTimeMillis(); final long timeOut = System.currentTimeMillis();
final long timeDelta = timeOut - timeIn;
EnvironmentLoaderListener.LOG.info(String.format("Kieker.WebGUI environment initialized in %d ms.", tout - tin)); LOG.info(String.format("Kieker.WebGUI environment initialized in %d ms.", timeDelta));
} }
} }
...@@ -17,7 +17,8 @@ ...@@ -17,7 +17,8 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This is the abstract base for all other exceptions used in this application. * This is the abstract base for all other exceptions used in this web application. The exceptions are checked exceptions and must therefore be explicitly thrown and
* caught.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +27,34 @@ public abstract class AbstractKiekerWebGUIException extends Exception { ...@@ -26,31 +27,34 @@ public abstract class AbstractKiekerWebGUIException extends Exception {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public AbstractKiekerWebGUIException() { public AbstractKiekerWebGUIException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public AbstractKiekerWebGUIException(final String msg) { public AbstractKiekerWebGUIException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public AbstractKiekerWebGUIException(final String msg, final Throwable cause) { public AbstractKiekerWebGUIException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This class represents an exception which can occur during the instantiation of an analysis. * This exception can be thrown if an analysis could not be initialized.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class AnalysisInitializationException extends AbstractKiekerWebGUIExcepti ...@@ -26,31 +26,34 @@ public class AnalysisInitializationException extends AbstractKiekerWebGUIExcepti
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public AnalysisInitializationException() { public AnalysisInitializationException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public AnalysisInitializationException(final String msg) { public AnalysisInitializationException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public AnalysisInitializationException(final String msg, final Throwable cause) { public AnalysisInitializationException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
/***************************************************************************
* Copyright 2013 Kieker Project (http://kieker-monitoring.net)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
***************************************************************************/
package kieker.webgui.common.exception;
/**
* This class represents an exception occurring when a component (filter, plugin) could not be initialized.
*
* @author Nils Christian Ehmke
*/
public class ComponentInitializationException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L;
/**
* Creates a new instance of this class.
*/
public ComponentInitializationException() {
super();
}
/**
* Creates a new instance of this class using the given parameters.
*
* @param msg
* The message used for the exception.
*/
public ComponentInitializationException(final String msg) {
super(msg);
}
/**
* Creates a new instance of this class using the given parameters.
*
* @param msg
* The message used for the exception.
* @param cause
* The cause for the exception.
*/
public ComponentInitializationException(final String msg, final Throwable cause) {
super(msg, cause);
}
}
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This class represents an exception occurring during an access to the database. * This exception can be thrown if an access to the data source failed. It should encapsulate more specific exceptions like {@link java.sql.SQLException}.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class DataAccessException extends AbstractKiekerWebGUIException { ...@@ -26,31 +26,34 @@ public class DataAccessException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public DataAccessException() { public DataAccessException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public DataAccessException(final String msg) { public DataAccessException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public DataAccessException(final String msg, final Throwable cause) { public DataAccessException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception occurs when a non existing display object has been ordered. * This exception can be thrown if an ordered display could not be found.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class DisplayNotFoundException extends AbstractKiekerWebGUIException { ...@@ -26,31 +26,34 @@ public class DisplayNotFoundException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public DisplayNotFoundException() { public DisplayNotFoundException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public DisplayNotFoundException(final String msg) { public DisplayNotFoundException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public DisplayNotFoundException(final String msg, final Throwable cause) { public DisplayNotFoundException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This class represents an exception which can occur during the auto layout of a graph. * This exception can be thrown if the layouting of a graph failed.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class GraphLayoutException extends AbstractKiekerWebGUIException { ...@@ -26,31 +26,34 @@ public class GraphLayoutException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public GraphLayoutException() { public GraphLayoutException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public GraphLayoutException(final String msg) { public GraphLayoutException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public GraphLayoutException(final String msg, final Throwable cause) { public GraphLayoutException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This class represents an exception occurring when the analysis is in an invalid state for the ordered action. * This exception can be thrown if the analysis is in an invalid state for the ordered operation.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class InvalidAnalysisStateException extends AbstractKiekerWebGUIException ...@@ -26,31 +26,34 @@ public class InvalidAnalysisStateException extends AbstractKiekerWebGUIException
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public InvalidAnalysisStateException() { public InvalidAnalysisStateException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public InvalidAnalysisStateException(final String msg) { public InvalidAnalysisStateException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public InvalidAnalysisStateException(final String msg, final Throwable cause) { public InvalidAnalysisStateException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
/***************************************************************************
* Copyright 2013 Kieker Project (http://kieker-monitoring.net)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
***************************************************************************/
package kieker.webgui.common.exception;
/**
* This exception shows that an error occurred while loading a library.
*
* @author Nils Christian Ehmke
*/
public class LibraryLoadException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L;
/**
* Creates a new instance of this class.
*/
public LibraryLoadException() {
super();
}
/**
* Creates a new instance of this class using the given parameters.
*
* @param msg
* The message used for the exception.
*/
public LibraryLoadException(final String msg) {
super(msg);
}
/**
* Creates a new instance of this class using the given parameters.
*
* @param msg
* The message used for the exception.
* @param cause
* The cause for the exception.
*/
public LibraryLoadException(final String msg, final Throwable cause) {
super(msg, cause);
}
}
...@@ -17,8 +17,8 @@ ...@@ -17,8 +17,8 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception shows that an attempt of saving a project has failed, because a newer version is available. In other words: The project has been modified in the * This exception can be thrown if a project could not be saved, because a newer version was available on the file system. In other words: It can indicate, that a
* meanwhile. * project has been modified in the meanwhile.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -27,31 +27,34 @@ public class NewerProjectException extends AbstractKiekerWebGUIException { ...@@ -27,31 +27,34 @@ public class NewerProjectException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public NewerProjectException() { public NewerProjectException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public NewerProjectException(final String msg) { public NewerProjectException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public NewerProjectException(final String msg, final Throwable cause) { public NewerProjectException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception shows that an project with the same name exists already. * This exception can be thrown to show, that a project with the given name exists already.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class ProjectAlreadyExistingException extends AbstractKiekerWebGUIExcepti ...@@ -26,31 +26,34 @@ public class ProjectAlreadyExistingException extends AbstractKiekerWebGUIExcepti
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public ProjectAlreadyExistingException() { public ProjectAlreadyExistingException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public ProjectAlreadyExistingException(final String msg) { public ProjectAlreadyExistingException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public ProjectAlreadyExistingException(final String msg, final Throwable cause) { public ProjectAlreadyExistingException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception occurs when something goes wrong during the loading/opening of a given project. * This exception can be thrown to show, that something went wrong while opening a given project.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -25,31 +25,34 @@ public class ProjectLoadException extends AbstractKiekerWebGUIException { ...@@ -25,31 +25,34 @@ public class ProjectLoadException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public ProjectLoadException() { public ProjectLoadException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public ProjectLoadException(final String msg) { public ProjectLoadException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public ProjectLoadException(final String msg, final Throwable cause) { public ProjectLoadException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception shows that a project with the given name does not exist or does no longer exist. * This exception can be thrown that a project with a given name does not or no longer exist.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -26,31 +26,34 @@ public class ProjectNotExistingException extends AbstractKiekerWebGUIException { ...@@ -26,31 +26,34 @@ public class ProjectNotExistingException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public ProjectNotExistingException() { public ProjectNotExistingException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public ProjectNotExistingException(final String msg) { public ProjectNotExistingException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public ProjectNotExistingException(final String msg, final Throwable cause) { public ProjectNotExistingException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
package kieker.webgui.common.exception; package kieker.webgui.common.exception;
/** /**
* This exception occurs when something goes wrong during reflection calls. * This exception can be thrown to show that something went wrong during a reflection call.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
...@@ -25,31 +25,34 @@ public class ReflectionException extends AbstractKiekerWebGUIException { ...@@ -25,31 +25,34 @@ public class ReflectionException extends AbstractKiekerWebGUIException {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new instance of this class. * Creates a new instance of this exception without detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
*/ */
public ReflectionException() { public ReflectionException() {
super(); super();
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message. The cause is not initialized, but can later be initialized using
* {@link Throwable#initCause(java.lang.Throwable)}.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
*/ */
public ReflectionException(final String msg) { public ReflectionException(final String msg) {
super(msg); super(msg);
} }
/** /**
* Creates a new instance of this class using the given parameters. * Creates a new instance of this class using the given detail message and cause.
* *
* @param msg * @param msg
* The message used for the exception. * The detail message of the exception.
* @param cause * @param cause
* The cause for the exception. * The cause for the exception.
*/ */
public ReflectionException(final String msg, final Throwable cause) { public ReflectionException(final String msg, final Throwable cause) {
super(msg, cause); super(msg, cause);
} }
} }
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
***************************************************************************/ ***************************************************************************/
/** /**
* This package contains the exceptions for the webgui. * This package contains the exceptions which are used through all layers of the web application.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
......
...@@ -15,7 +15,7 @@ ...@@ -15,7 +15,7 @@
***************************************************************************/ ***************************************************************************/
/** /**
* This package contains common and utility classes. * This package contains common classes which are used through all layers of the web application.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
......
...@@ -23,7 +23,7 @@ import kieker.webgui.domain.pluginDecorators.ReaderDecorator; ...@@ -23,7 +23,7 @@ import kieker.webgui.domain.pluginDecorators.ReaderDecorator;
import kieker.webgui.domain.pluginDecorators.RepositoryDecorator; import kieker.webgui.domain.pluginDecorators.RepositoryDecorator;
/** /**
* This class is a container for multiple {@link ReaderDecorator}, {@link FilterDecorator} or {@link RepositoryDecorator} instances. For each of the component type * This is a container for multiple {@link ReaderDecorator}, {@link FilterDecorator} or {@link RepositoryDecorator} instances. For each of the component type
* (reader, filter, repository) there is exactly one list available. This class will mostly be used to deliver a set of available components for a project. A bean * (reader, filter, repository) there is exactly one list available. This class will mostly be used to deliver a set of available components for a project. A bean
* can use the components as a prototype to copy new model instances. * can use the components as a prototype to copy new model instances.
* *
......
...@@ -24,14 +24,14 @@ package kieker.webgui.domain; ...@@ -24,14 +24,14 @@ package kieker.webgui.domain;
public enum DisplayType { public enum DisplayType {
/** Represents the plot display type. */ /** Represents the plot display type. */
TYPE_XY_PLOT, XY_PLOT,
/** Represents the plain text display type. */ /** Represents the plain text display type. */
TYPE_PLAIN_TEXT, PLAIN_TEXT,
/** Represents the Html text display type. */ /** Represents the html text display type. */
TYPE_HTML_TEXT, HTML_TEXT,
/** Represents the image display type. */ /** Represents the image display type. */
TYPE_IMAGE, IMAGE,
/** Represents the meter gauge display type. */ /** Represents the meter gauge display type. */
TYPE_METER_GAUGE METER_GAUGE
} }
...@@ -17,26 +17,17 @@ ...@@ -17,26 +17,17 @@
package kieker.webgui.domain; package kieker.webgui.domain;
/** /**
* This enum represents the available roles within the system. * This enumeration represents the available roles within the system.
* *
* @author Nils Christian Ehmke * @author Nils Christian Ehmke
*/ */
public enum Role { public enum Role {
/** Represents a guest within the system. */ /** Represents a guest within the system. */
GUEST(0), GUEST,
/** Represents an user within the system. */ /** Represents an user within the system. */
USER(1), USER,
/** Represents an administrator within the system. */ /** Represents an administrator within the system. */
ADMINISTRATOR(2); ADMINISTRATOR;
private int id;
private Role(final int id) {
this.id = id;
}
public int getID() {
return this.id;
}
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment