| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender.nosql;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.Closeable;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>/**<a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * Represents a connection to the NoSQL database. Serves as a factory for new (empty) objects and an endpoint for<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * inserted objects.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> *<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * @param <T> Specifies which implementation of {@link NoSqlObject} this connection provides.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * @param <W> Specifies which type of database object is wrapped by the {@link NoSqlObject} implementation provided.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> */<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>public interface NoSqlConnection<W, T extends NoSqlObject<W>> extends Closeable {<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> /**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Instantiates and returns a {@link NoSqlObject} instance whose properties can be configured before ultimate<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * insertion via {@link #insertObject(NoSqlObject)}.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * @return a new object.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @see NoSqlObject<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> T createObject();<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Creates an array of the specified length typed to match the {@link NoSqlObject} implementation appropriate for<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * this provider.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param length the length of the array to create.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @return a new array.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @see NoSqlObject<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> T[] createList(int length);<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Inserts the given object into the underlying NoSQL database.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> *<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param object The object to insert.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> void insertObject(NoSqlObject<W> object);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Closes the underlying connection. This method call should be idempotent. Only the first call should have any<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * effect; all further calls should be ignored. It's possible the underlying connection is stateless (such as an<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * HTTP web service), in which case this method would be a no-op. This method should also commit any open<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * transactions, if applicable and if not already committed.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * If this connection is part of a connection pool, executing this method should commit the transaction and return<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * the connection to the pool, but it should not actually close the underlying connection.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * </p><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> @Override<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> void close();<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Indicates whether the underlying connection is closed. If the underlying connection is stateless (such as an<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * HTTP web service), this method would likely always return true. Essentially, this method should only return<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * {@code true} if a call to {@link #insertObject(NoSqlObject)} <b>will</b> fail due to the state of this object.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return {@code true} if this object is considered closed.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> boolean isClosed();<a name="line.75"></a> |
| <span class="sourceLineNo">076</span>}<a name="line.76"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
