content: /**
   * 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.apex.examples.twitter;
  
  import org.apache.apex.malhar.contrib.kinesis.AbstractKinesisInputOperator;
  import org.apache.apex.malhar.contrib.kinesis.KinesisStringInputOperator;
  import org.apache.apex.malhar.contrib.kinesis.KinesisStringOutputOperator;
  import org.apache.apex.malhar.contrib.kinesis.ShardManager;
  import org.apache.apex.malhar.contrib.twitter.TwitterSampleInput;
  import org.apache.apex.malhar.lib.algo.UniqueCounter;
  import org.apache.apex.malhar.lib.io.ConsoleOutputOperator;
  import org.apache.apex.malhar.lib.io.PubSubWebSocketOutputOperator;
  import org.apache.apex.malhar.lib.utils.PubSubHelper;
  import org.apache.hadoop.conf.Configuration;
  
  import com.datatorrent.api.DAG;
  import com.datatorrent.api.DAG.Locality;
  import com.datatorrent.api.Operator.InputPort;
  import com.datatorrent.api.StreamingApplication;
  import com.datatorrent.api.annotation.ApplicationAnnotation;
  
  /**
   * Twitter Example Application: <br>
   * This example application samples random public status from twitter, send to Hashtag
   * extractor and extract the status and send it into kinesis <br>
   * Get the records from kinesis and converts into Hashtags. Top 10 Hashtag(s) mentioned in
   * tweets in last 5 mins are displayed on every window count (500ms).<br>
   * <br>
   *
   * Real Time Calculation :<br>
   * This application calculates top 10 Hashtag mentioned in tweets in last 5
   * minutes across a 1% random tweet sampling on a rolling window basis.<br>
   * <br>
   * Before running this application, you need to have a <a href="https://dev.twitter.com/apps">Twitter API account</a>,
   * <a href="https://http://aws.amazon.com/">AWS Account</a> and configure the authentication details.
   * For launch from CLI, those go into ~/.dt/dt-site.xml:
   * <pre>
   * {@code
   * <?xml version="1.0" encoding="UTF-8"?>
   * <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
   * <configuration>
   *
   *   <property> <name>dt.operator.TweetSampler.prop.consumerKey</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.TweetSampler.prop.consumerSecret</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.TweetSampler.prop.accessToken</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.TweetSampler.prop.accessTokenSecret</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.FromKinesis.streamName</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.FromKinesis.accessKey</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.FromKinesis.secretKey</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.ToKinesis.streamName</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.ToKinesis.accessKey</name>
   *   <value>TBD</value> </property>
   *
   *   <property> <name>dt.operator.ToKinesis.secretKey</name>
   *   <value>TBD</value> </property>
   *
   * </configuration>
   * }
   * </pre>
   * Custom Attributes: <br>
   * <b>topCounts operator : <b>
   * <ul>
   * <li>Top Count : 10, number of top unique Hashtag to be reported.</li>
   * <li>Sliding window count : 600, report over last 5 min (600 * .5 / 60 mins)</li>
   * <li>window slide value : 1</li>
   * </ul>
   * <p>
   * Running Java Test or Main app in IDE:
   *
   * <pre>
   * LocalMode.runApp(new Application(), 600000); // 10 min run
   * </pre>
   *
   * Run Success : <br>
   * For successful deployment and run, user should see similar output on console as below:
   *
   * <pre>
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * topHashtags: {"string": "{\"gameinsight\":\"12\",\"android\":\"8\",\"WotaJKT48alay\":\"12\",\"TernyataJKT48CyberItuForoumSampah\":\"8\",\"NHL15Subban\":\"30\",\"JKT48CYBERKeracunanCUKRIK\":\"8\",\"verifydjzoodel\":\"59\",\"androidgames\":\"9\",\"مع_الله\":\"10\",\"Jct48cyberTAIBABI\":\"10\"}"}
   * 2013-06-17 14:38:55,201 [main] INFO  stram.StramLocalCluster run - Application finished.
   * 2013-06-17 14:38:55,201 [container-2] INFO  stram.StramChild processHeartbeatResponse - Received shutdown request
   * </pre>
   *
   * Scaling Options : <br>
   * User can scale application by setting intial partition size > 1 on count
   * unique operator. <br>
   * <br>
   *
   * Application DAG : <br>
   * <img src="doc-files/Application.gif" width=600px > <br>
   * <br>
   *
   * Streaming Window Size : 500ms(default) <br>
   * Operator Details : <br>
   * <ul>
   * <li><b>The twitterFeed operator : </b> This operator samples random public
   * statues from twitter and emits to application. <br>
   * Class : org.apache.apex.examples.twitter.TwitterSampleInput <br>
   * StateFull : No, window count 1 <br>
   * </li>
   * <li><b>The HashtagExtractor operator : </b> This operator extracts Hashtag from
   * random sampled statues from twitter. <br>
   * Class : {@link TwitterStatusHashtagExtractor} <br>
   * StateFull : No, window count 1 <br>
   * </li>
   * <li><b>The outputOp operator : </b> This operator sent the tags into the kinesis. <br>
   * Class : {@link org.apache.apex.malhar.contrib.kinesis.KinesisStringOutputOperator} <br>
   * </li>
   * <li><b>The inputOp operator : </b> This operator fetches the records from kinesis and
   * converts into hastags and emits them. <br>
   * Class : {@link org.apache.apex.malhar.contrib.kinesis.KinesisStringOutputOperator} <br>
   * </li>
   * <li><b>The uniqueCounter operator : </b> This operator aggregates count for each
   * Hashtag extracted from random samples. <br>
   * Class : {@link org.apache.apex.malhar.lib.algo.UniqueCounter} <br>
   * StateFull : No, window count 1 <br>
   * </li>
   * <li><b> The topCounts operator : </b> This operator caluculates top Hashtag in last 1
   * min sliding window count 1. <br>
   * Class : org.apache.apex.malhar.lib.algo.WindowedTopCounter <br>
   * StateFull : Yes, sliding window count 120 (1 min) <br>
   * </li>
   * <li><b>The operator Console: </b> This operator just outputs the input tuples
   * to the console (or stdout). <br>
   * </li>
   * </ul>
   *
   * @since 2.0.0
   */
  @ApplicationAnnotation(name = "TwitterKinesisExample")
  public class KinesisHashtagsApplication implements StreamingApplication
  {
    private final Locality locality = null;
  
    private InputPort<Object> consoleOutput(DAG dag, String operatorName)
    {
      if (PubSubHelper.isGatewayConfigured(dag)) {
        String topic = "examples.twitter." + operatorName;
        //LOG.info("WebSocket with gateway at: {}", gatewayAddress);
        PubSubWebSocketOutputOperator<Object> wsOut = dag.addOperator(operatorName, new PubSubWebSocketOutputOperator<Object>());
        wsOut.setUri(PubSubHelper.getURI(dag));
        wsOut.setTopic(topic);
        return wsOut.input;
      }
      ConsoleOutputOperator operator = dag.addOperator(operatorName, new ConsoleOutputOperator());
      operator.setStringFormat(operatorName + ": %s");
      return operator.input;
    }
  
    @Override
    public void populateDAG(DAG dag, Configuration conf)
    {
      // Setup the operator to get the data from twitter sample stream injected into the system.
      TwitterSampleInput twitterFeed = new TwitterSampleInput();
      twitterFeed = dag.addOperator("TweetSampler", twitterFeed);
  
      //  Setup the operator to get the Hashtags extracted from the twitter statuses
      TwitterStatusHashtagExtractor HashtagExtractor = dag.addOperator("HashtagExtractor", TwitterStatusHashtagExtractor.class);
  
      //Setup the operator send the twitter statuses to kinesis
      KinesisStringOutputOperator outputOp = dag.addOperator("ToKinesis", new KinesisStringOutputOperator());
      outputOp.setBatchSize(500);
  
      // Feed the statuses from feed into the input of the Hashtag extractor.
      dag.addStream("TweetStream", twitterFeed.status, HashtagExtractor.input).setLocality(Locality.CONTAINER_LOCAL);
      //  Start counting the Hashtags coming out of Hashtag extractor
      dag.addStream("SendToKinesis", HashtagExtractor.hashtags, outputOp.inputPort).setLocality(locality);
  
      //------------------------------------------------------------------------------------------
  
      KinesisStringInputOperator inputOp = dag.addOperator("FromKinesis", new KinesisStringInputOperator());
      ShardManager shardStats = new ShardManager();
      inputOp.setShardManager(shardStats);
      inputOp.getConsumer().setRecordsLimit(600);
      inputOp.setStrategy(AbstractKinesisInputOperator.PartitionStrategy.MANY_TO_ONE.toString());
  
      // Setup a node to count the unique Hashtags within a window.
      UniqueCounter<String> uniqueCounter = dag.addOperator("UniqueHashtagCounter", new UniqueCounter<String>());
  
      // Get the aggregated Hashtag counts and count them over last 5 mins.
      WindowedTopCounter<String> topCounts = dag.addOperator("TopCounter", new WindowedTopCounter<String>());
      topCounts.setTopCount(10);
      topCounts.setSlidingWindowWidth(600);
      topCounts.setDagWindowWidth(1);
  
      dag.addStream("TwittedHashtags", inputOp.outputPort, uniqueCounter.data).setLocality(locality);
  
      // Count unique Hashtags
      dag.addStream("UniqueHashtagCounts", uniqueCounter.count, topCounts.input).setLocality(locality);
      // Count top 10
      dag.addStream("TopHashtags", topCounts.output, consoleOutput(dag, "topHashtags")).setLocality(locality);
    }
  }
  
  