You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by oh...@apache.org on 2007/01/13 18:06:30 UTC
svn commit: r495926 - in
/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event:
ConfigurationErrorEvent.java ConfigurationErrorListener.java
Author: oheger
Date: Sat Jan 13 09:06:29 2007
New Revision: 495926
URL: http://svn.apache.org/viewvc?view=rev&rev=495926
Log:
CONFIGURATION-245: New event and listener classes for configuration errors
Added:
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java (with props)
jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java (with props)
Added: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java?view=auto&rev=495926
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java (added)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java Sat Jan 13 09:06:29 2007
@@ -0,0 +1,94 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.configuration.event;
+
+/**
+ * <p>
+ * An event class that is used for reporting errors that occurred while
+ * processing configuration properties.
+ * </p>
+ * <p>
+ * Some configuration implementations (e.g.
+ * <code>{@link org.apache.commons.configuration.DatabaseConfiguration}</code>
+ * or <code>{@link org.apache.commons.configuration.JNDIConfiguration}</code>
+ * use an underlying storage that can throw an exception on each property
+ * access. In earlier versions of this library such exceptions were logged and
+ * then silently ignored. This makes it impossible for a client to find out that
+ * something went wrong.
+ * </p>
+ * <p>
+ * To give clients better control over the handling of errors that occur during
+ * access of a configuration object a new event listener mechanism specific for
+ * exceptions is introduced: Clients can register itself at a configuration
+ * object as an <em>error listener</em> and are then notified about all
+ * internal errors related to the source configuration object.
+ * </p>
+ * <p>
+ * By inheriting from <code>ConfigurationEvent</code> this event class
+ * supports all properties that describe an operation on a configuration
+ * instance. In addition a <code>Throwable</code> object is available
+ * representing the occurred error. The event's type determines the operation
+ * that caused the error. Note that depending on the event type and the occurred
+ * exception not all of the other properties (e.g. name of the affected property
+ * or its value) may be available.
+ * </p>
+ *
+ * @author <a
+ * href="http://jakarta.apache.org/commons/configuration/team-list.html">Commons
+ * Configuration team</a>
+ * @version $Id$
+ * @since 1.4
+ * @see ConfigurationEvent
+ */
+public class ConfigurationErrorEvent extends ConfigurationEvent
+{
+ /**
+ * The serial version UID.
+ */
+ private static final long serialVersionUID = -7433184493062648409L;
+
+ /** Stores the exception that caused this event. */
+ private Throwable cause;
+
+ /**
+ * Creates a new instance of <code>ConfigurationErrorEvent</code> and
+ * initializes it.
+ *
+ * @param source the event source
+ * @param type the event's type
+ * @param propertyName the name of the affected property
+ * @param propertyValue the value of the affected property
+ * @param cause the exception object that caused this event
+ */
+ public ConfigurationErrorEvent(Object source, int type,
+ String propertyName, Object propertyValue, Throwable cause)
+ {
+ super(source, type, propertyName, propertyValue, true);
+ this.cause = cause;
+ }
+
+ /**
+ * Returns the cause of this error event. This is the <code>Throwable</code>
+ * object that caused this event to be fired.
+ *
+ * @return the cause of this error event
+ */
+ public Throwable getCause()
+ {
+ return cause;
+ }
+}
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorEvent.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java?view=auto&rev=495926
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java (added)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java Sat Jan 13 09:06:29 2007
@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.commons.configuration.event;
+
+/**
+ * <p>
+ * An event listener interface to be implemented by observers that are
+ * interested in internal errors caused by processing of configuration
+ * properties.
+ * </p>
+ * <p>
+ * Some configuration classes use an underlying storage where each access of a
+ * property can cause an exception. In earlier versions of this library such
+ * exceptions were typically ignored. By implementing this interface and
+ * registering at a configuration object as an error listener it is now possible
+ * for clients to receive notifications about those internal problems.
+ * </p>
+ *
+ * @author <a
+ * href="http://jakarta.apache.org/commons/configuration/team-list.html">Commons
+ * Configuration team</a>
+ * @version $Id$
+ * @since 1.4
+ * @see ConfigurationErrorEvent
+ */
+public interface ConfigurationErrorListener
+{
+ /**
+ * Notifies this listener that in an observed configuration an error
+ * occurred. All information available about this error, including the
+ * causing <code>Throwable</code> object, can be obtained from the passed
+ * in event object.
+ *
+ * @param event the event object with information about the error
+ */
+ void configurationError(ConfigurationErrorEvent event);
+}
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/event/ConfigurationErrorListener.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org