You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gr...@apache.org on 2014/02/07 22:32:16 UTC
svn commit: r1565821 - in
/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb:
./ CouchDBConnection.java CouchDBObject.java CouchDBProvider.java
package-info.java
Author: grobmeier
Date: Fri Feb 7 21:32:15 2014
New Revision: 1565821
URL: http://svn.apache.org/r1565821
Log:
changed package name to match product name
Added:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java (with props)
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java (with props)
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java (with props)
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java (with props)
Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java?rev=1565821&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java Fri Feb 7 21:32:15 2014
@@ -0,0 +1,72 @@
+/*
+ * 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.logging.log4j.core.appender.db.nosql.couchdb;
+
+import java.util.Map;
+
+import org.apache.logging.log4j.core.appender.AppenderLoggingException;
+import org.apache.logging.log4j.core.appender.db.nosql.NoSQLConnection;
+import org.apache.logging.log4j.core.appender.db.nosql.NoSQLObject;
+import org.lightcouch.CouchDbClient;
+import org.lightcouch.Response;
+
+/**
+ * The Apache CouchDB implementation of {@link NoSQLConnection}.
+ */
+public final class CouchDBConnection implements NoSQLConnection<Map<String, Object>, CouchDBObject> {
+ private final CouchDbClient client;
+ private boolean closed = false;
+
+ public CouchDBConnection(final CouchDbClient client) {
+ this.client = client;
+ }
+
+ @Override
+ public CouchDBObject createObject() {
+ return new CouchDBObject();
+ }
+
+ @Override
+ public CouchDBObject[] createList(final int length) {
+ return new CouchDBObject[length];
+ }
+
+ @Override
+ public void insertObject(final NoSQLObject<Map<String, Object>> object) {
+ try {
+ final Response response = this.client.save(object.unwrap());
+ if (response.getError() != null && response.getError().length() > 0) {
+ throw new AppenderLoggingException("Failed to write log event to CouchDB due to error: " +
+ response.getError() + ".");
+ }
+ } catch (final Exception e) {
+ throw new AppenderLoggingException("Failed to write log event to CouchDB due to error: " + e.getMessage(),
+ e);
+ }
+ }
+
+ @Override
+ public synchronized void close() {
+ this.closed = true;
+ this.client.shutdown();
+ }
+
+ @Override
+ public synchronized boolean isClosed() {
+ return this.closed;
+ }
+}
Propchange: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBConnection.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java?rev=1565821&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java Fri Feb 7 21:32:15 2014
@@ -0,0 +1,64 @@
+/*
+ * 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.logging.log4j.core.appender.db.nosql.couchdb;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.logging.log4j.core.appender.db.nosql.NoSQLObject;
+
+/**
+ * The Apache CouchDB implementation of {@link NoSQLObject}.
+ */
+public final class CouchDBObject implements NoSQLObject<Map<String, Object>> {
+ private final Map<String, Object> map;
+
+ public CouchDBObject() {
+ this.map = new HashMap<String, Object>();
+ }
+
+ @Override
+ public void set(final String field, final Object value) {
+ this.map.put(field, value);
+ }
+
+ @Override
+ public void set(final String field, final NoSQLObject<Map<String, Object>> value) {
+ this.map.put(field, value.unwrap());
+ }
+
+ @Override
+ public void set(final String field, final Object[] values) {
+ this.map.put(field, Arrays.asList(values));
+ }
+
+ @Override
+ public void set(final String field, final NoSQLObject<Map<String, Object>>[] values) {
+ final ArrayList<Map<String, Object>> list = new ArrayList<Map<String, Object>>();
+ for (final NoSQLObject<Map<String, Object>> value : values) {
+ list.add(value.unwrap());
+ }
+ this.map.put(field, list);
+ }
+
+ @Override
+ public Map<String, Object> unwrap() {
+ return this.map;
+ }
+}
Propchange: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBObject.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java?rev=1565821&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java Fri Feb 7 21:32:15 2014
@@ -0,0 +1,164 @@
+/*
+ * 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.logging.log4j.core.appender.db.nosql.couchdb;
+
+import java.lang.reflect.Method;
+
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.core.appender.AbstractAppender;
+import org.apache.logging.log4j.core.appender.db.nosql.NoSQLProvider;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginFactory;
+import org.apache.logging.log4j.core.helpers.NameUtil;
+import org.apache.logging.log4j.core.helpers.Strings;
+import org.apache.logging.log4j.status.StatusLogger;
+import org.lightcouch.CouchDbClient;
+import org.lightcouch.CouchDbProperties;
+
+/**
+ * The Apache CouchDB implementation of {@link NoSQLProvider}.
+ */
+@Plugin(name = "CouchDB", category = "Core", printObject = true)
+public final class CouchDBProvider implements NoSQLProvider<CouchDBConnection> {
+ private static final int HTTP = 80;
+ private static final int HTTPS = 443;
+ private static final Logger LOGGER = StatusLogger.getLogger();
+
+ private final CouchDbClient client;
+ private final String description;
+
+ private CouchDBProvider(final CouchDbClient client, final String description) {
+ this.client = client;
+ this.description = "couchDb{ " + description + " }";
+ }
+
+ @Override
+ public CouchDBConnection getConnection() {
+ return new CouchDBConnection(this.client);
+ }
+
+ @Override
+ public String toString() {
+ return this.description;
+ }
+
+ /**
+ * Factory method for creating an Apache CouchDB provider within the plugin manager.
+ *
+ * @param databaseName The name of the database to which log event documents will be written.
+ * @param protocol Either "http" or "https," defaults to "http" and mutually exclusive with
+ * {@code factoryClassName&factoryMethodName!=null}.
+ * @param server The host name of the CouchDB server, defaults to localhost and mutually exclusive with
+ * {@code factoryClassName&factoryMethodName!=null}.
+ * @param port The port that CouchDB is listening on, defaults to 80 if {@code protocol} is "http" and 443 if
+ * {@code protocol} is "https," and mutually exclusive with
+ * {@code factoryClassName&factoryMethodName!=null}.
+ * @param username The username to authenticate against the MongoDB server with, mutually exclusive with
+ * {@code factoryClassName&factoryMethodName!=null}.
+ * @param password The password to authenticate against the MongoDB server with, mutually exclusive with
+ * {@code factoryClassName&factoryMethodName!=null}.
+ * @param factoryClassName A fully qualified class name containing a static factory method capable of returning a
+ * {@link CouchDbClient} or {@link CouchDbProperties}.
+ * @param factoryMethodName The name of the public static factory method belonging to the aforementioned factory
+ * class.
+ * @return a new Apache CouchDB provider.
+ */
+ @PluginFactory
+ public static CouchDBProvider createNoSQLProvider(
+ @PluginAttribute("databaseName") final String databaseName,
+ @PluginAttribute("protocol") String protocol,
+ @PluginAttribute("server") String server,
+ @PluginAttribute("port") final String port,
+ @PluginAttribute("username") final String username,
+ @PluginAttribute("password") final String password,
+ @PluginAttribute("factoryClassName") final String factoryClassName,
+ @PluginAttribute("factoryMethodName") final String factoryMethodName) {
+ CouchDbClient client;
+ String description;
+ if (factoryClassName != null && factoryClassName.length() > 0 &&
+ factoryMethodName != null && factoryMethodName.length() > 0) {
+ try {
+ final Class<?> factoryClass = Class.forName(factoryClassName);
+ final Method method = factoryClass.getMethod(factoryMethodName);
+ final Object object = method.invoke(null);
+
+ if (object instanceof CouchDbClient) {
+ client = (CouchDbClient) object;
+ description = "uri=" + client.getDBUri();
+ } else if (object instanceof CouchDbProperties) {
+ final CouchDbProperties properties = (CouchDbProperties) object;
+ client = new CouchDbClient(properties);
+ description = "uri=" + client.getDBUri() + ", username=" + properties.getUsername()
+ + ", passwordHash=" + NameUtil.md5(password + CouchDBProvider.class.getName())
+ + ", maxConnections=" + properties.getMaxConnections() + ", connectionTimeout="
+ + properties.getConnectionTimeout() + ", socketTimeout=" + properties.getSocketTimeout();
+ } else if (object == null) {
+ LOGGER.error("The factory method [{}.{}()] returned null.", factoryClassName, factoryMethodName);
+ return null;
+ } else {
+ LOGGER.error("The factory method [{}.{}()] returned an unsupported type [{}].", factoryClassName,
+ factoryMethodName, object.getClass().getName());
+ return null;
+ }
+ } catch (final ClassNotFoundException e) {
+ LOGGER.error("The factory class [{}] could not be loaded.", factoryClassName, e);
+ return null;
+ } catch (final NoSuchMethodException e) {
+ LOGGER.error("The factory class [{}] does not have a no-arg method named [{}].", factoryClassName,
+ factoryMethodName, e);
+ return null;
+ } catch (final Exception e) {
+ LOGGER.error("The factory method [{}.{}()] could not be invoked.", factoryClassName, factoryMethodName,
+ e);
+ return null;
+ }
+ } else if (databaseName != null && databaseName.length() > 0) {
+ if (protocol != null && protocol.length() > 0) {
+ protocol = protocol.toLowerCase();
+ if (!protocol.equals("http") && !protocol.equals("https")) {
+ LOGGER.error("Only protocols [http] and [https] are supported, [{}] specified.", protocol);
+ return null;
+ }
+ } else {
+ protocol = "http";
+ LOGGER.warn("No protocol specified, using default port [http].");
+ }
+
+ final int portInt = AbstractAppender.parseInt(port, protocol.equals("https") ? HTTPS : HTTP);
+
+ if (Strings.isEmpty(server)) {
+ server = "localhost";
+ LOGGER.warn("No server specified, using default server localhost.");
+ }
+
+ if (Strings.isEmpty(username) || Strings.isEmpty(password)) {
+ LOGGER.error("You must provide a username and password for the CouchDB provider.");
+ return null;
+ }
+
+ client = new CouchDbClient(databaseName, false, protocol, server, portInt, username, password);
+ description = "uri=" + client.getDBUri() + ", username=" + username + ", passwordHash="
+ + NameUtil.md5(password + CouchDBProvider.class.getName());
+ } else {
+ LOGGER.error("No factory method was provided so the database name is required.");
+ return null;
+ }
+
+ return new CouchDBProvider(client, description);
+ }
+}
Propchange: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/CouchDBProvider.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java?rev=1565821&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java Fri Feb 7 21:32:15 2014
@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+/**
+ * The classes in this package contain the Apache CouchDB provider for the NoSQL Appender.
+ */
+package org.apache.logging.log4j.core.appender.db.nosql.couchdb;
Propchange: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/db/nosql/couchdb/package-info.java
------------------------------------------------------------------------------
svn:eol-style = native