src/main/java/net/pterodactylus/sonitus/data/sink/FileSink.java

   1 /*
   2  * Sonitus - FileSink.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data.sink;
  19
  20 import java.io.FileOutputStream;
  21 import java.io.IOException;
  22 import java.util.Collections;
  23 import java.util.List;
  24 import java.util.logging.Logger;
  25
  26 import net.pterodactylus.sonitus.data.Controller;
  27 import net.pterodactylus.sonitus.data.Metadata;
  28 import net.pterodactylus.sonitus.data.Sink;
  29 import net.pterodactylus.sonitus.data.event.MetadataUpdated;
  30
  31 import com.google.common.eventbus.EventBus;
  32
  33 /**
  34  * {@link net.pterodactylus.sonitus.data.Sink} that writes all received data
  35  * into a file.
  36  *
  37  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  38  */
  39 public class FileSink implements Sink {
  40
  41         /** The logger. */
  42         private static final Logger logger = Logger.getLogger(FileSink.class.getName());
  43
  44         /** The event bus. */
  45         private final EventBus eventBus;
  46
  47         /** The path of the file to write to. */
  48         private final String path;
  49
  50         /** The output stream writing to the file. */
  51         private FileOutputStream fileOutputStream;
  52
  53         /** The current metadata. */
  54         private Metadata metadata;
  55
  56         /**
  57          * Creates a new file sink that will write to the given path.
  58          *
  59          * @param eventBus
  60          *              The event bus
  61          * @param path
  62          *              The path of the file to write to
  63          */
  64         public FileSink(EventBus eventBus, String path) {
  65                 this.eventBus = eventBus;
  66                 this.path = path;
  67         }
  68
  69         //
  70         // CONTROLLED METHODS
  71         //
  72
  73         @Override
  74         public String name() {
  75                 return path;
  76         }
  77
  78         @Override
  79         public Metadata metadata() {
  80                 return metadata;
  81         }
  82
  83         @Override
  84         public List<Controller<?>> controllers() {
  85                 return Collections.emptyList();
  86         }
  87
  88         //
  89         // SINK METHODS
  90         //
  91
  92         @Override
  93         public void open(Metadata metadata) throws IOException {
  94                 fileOutputStream = new FileOutputStream(path);
  95                 metadataUpdated(metadata);
  96         }
  97
  98         @Override
  99         public void close() {
 100                 try {
 101                         fileOutputStream.close();
 102                 } catch (IOException e) {
 103                         /* ignore. */
 104                 }
 105         }
 106
 107         @Override
 108         public void metadataUpdated(Metadata metadata) {
 109                 this.metadata = metadata;
 110                 eventBus.post(new MetadataUpdated(this, metadata));
 111         }
 112
 113         @Override
 114         public void process(byte[] buffer) throws IOException {
 115                 fileOutputStream.write(buffer);
 116                 logger.finest(String.format("FileSink: Wrote %d Bytes.", buffer.length));
 117         }
 118
 119 }