http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/jobs/logging.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/jobs/logging.md b/docs/learn/documentation/0.7.0/jobs/logging.md deleted file mode 100644 index 5b78d7f..0000000 --- a/docs/learn/documentation/0.7.0/jobs/logging.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -layout: page -title: Logging ---- -<!-- - 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. ---> - -Samza uses [SLF4J](http://www.slf4j.org/) for all of its logging. By default, Samza only depends on slf4j-api, so you must add an SLF4J runtime dependency to your Samza packages for whichever underlying logging platform you wish to use. - -### Log4j - -The [hello-samza](/startup/hello-samza/0.7.0) project shows how to use [log4j](http://logging.apache.org/log4j/1.2/) with Samza. To turn on log4j logging, you just need to make sure slf4j-log4j12 is in your SamzaContainer's classpath. In Maven, this can be done by adding the following dependency to your Samza package project. - -{% highlight xml %} -<dependency> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-log4j12</artifactId> - <scope>runtime</scope> - <version>1.6.2</version> -</dependency> -{% endhighlight %} - -If you're not using Maven, just make sure that slf4j-log4j12 ends up in your Samza package's lib directory. - -#### Log4j configuration - -Samza's [run-class.sh](packaging.html) script will automatically set the following setting if log4j.xml exists in your [Samza package's](packaging.html) lib directory. - -{% highlight bash %} --Dlog4j.configuration=file:$base_dir/lib/log4j.xml -{% endhighlight %} - -The [run-class.sh](packaging.html) script will also set the following Java system properties: - -{% highlight bash %} --Dsamza.log.dir=$SAMZA_LOG_DIR -Dsamza.container.name=$SAMZA_CONTAINER_NAME= -{% endhighlight %} - -These settings are very useful if you're using a file-based appender. For example, you can use a daily rolling appender by configuring log4j.xml like this: - -{% highlight xml %} -<appender name="RollingAppender" class="org.apache.log4j.DailyRollingFileAppender"> - <param name="File" value="${samza.log.dir}/${samza.container.name}.log" /> - <param name="DatePattern" value="'.'yyyy-MM-dd" /> - <layout class="org.apache.log4j.PatternLayout"> - <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %c{1} [%p] %m%n" /> - </layout> -</appender> -{% endhighlight %} - -Setting up a file-based appender is recommended as a better alternative to using standard out. Standard out log files (see below) don't roll, and can get quite large if used for logging. - -**NOTE:** If you use the `task.opts` configuration property, the log configuration is disrupted. This is a known bug; please see [SAMZA-109](https://issues.apache.org/jira/browse/SAMZA-109) for a workaround. - -### Log Directory - -Samza will look for the `SAMZA_LOG_DIR` environment variable when it executes. If this variable is defined, all logs will be written to this directory. If the environment variable is empty, or not defined, then Samza will use /tmp. This environment variable can also be referenced inside log4j.xml files (see above). - -### Garbage Collection Logging - -Samza's will automatically set the following garbage collection logging setting, and will output it to `$SAMZA_LOG_DIR/gc.log`. - -{% highlight bash %} --XX:+PrintGCDateStamps -Xloggc:$SAMZA_LOG_DIR/gc.log -{% endhighlight %} - -#### Rotation - -In older versions of Java, it is impossible to have GC logs roll over based on time or size without the use of a secondary tool. This means that your GC logs will never be deleted until a Samza job ceases to run. As of [Java 6 Update 34](http://www.oracle.com/technetwork/java/javase/2col/6u34-bugfixes-1733379.html), and [Java 7 Update 2](http://www.oracle.com/technetwork/java/javase/7u2-relnotes-1394228.html), [new GC command line switches](http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6941923) have been added to support this functionality. If you are using a version of Java that supports GC log rotation, it's highly recommended that you turn it on. - -### YARN - -When a Samza job executes on a YARN grid, the `$SAMZA_LOG_DIR` environment variable will point to a directory that is secured such that only the user executing the Samza job can read and write to it, if YARN is [securely configured](http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/ClusterSetup.html). - -#### STDOUT - -Samza's [ApplicationMaster](../yarn/application-master.html) pipes all STDOUT and STDERR output to logs/stdout and logs/stderr, respectively. These files are never rotated. - -## [Reprocessing »](reprocessing.html)
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/jobs/packaging.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/jobs/packaging.md b/docs/learn/documentation/0.7.0/jobs/packaging.md deleted file mode 100644 index 9e55f9a..0000000 --- a/docs/learn/documentation/0.7.0/jobs/packaging.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: page -title: Packaging ---- -<!-- - 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 [JobRunner](job-runner.html) page talks about run-job.sh, and how it's used to start a job either locally (ProcessJobFactory/ThreadJobFactory) or with YARN (YarnJobFactory). In the diagram that shows the execution flow, it also shows a run-container.sh script. This script, along with a run-am.sh script, are what Samza actually calls to execute its code. - -``` -bin/run-am.sh -bin/run-container.sh -``` - -The run-container.sh script is responsible for starting the [SamzaContainer](../container/samza-container.html). The run-am.sh script is responsible for starting Samza's application master for YARN. Thus, the run-am.sh script is only used by the YarnJob, but both YarnJob and ProcessJob use run-container.sh. - -Typically, these two scripts are bundled into a tar.gz file that has a structure like this: - -``` -bin/run-am.sh -bin/run-class.sh -bin/run-job.sh -bin/run-container.sh -lib/*.jar -``` - -To run a Samza job, you un-zip its tar.gz file, and execute the run-job.sh script, as defined in the JobRunner section. There are a number of interesting implications from this packaging scheme. First, you'll notice that there is no configuration in the package. Second, you'll notice that the lib directory contains all JARs that you'll need to run your Samza job. - -The reason that configuration is decoupled from your Samza job packaging is that it allows configuration to be updated without having to re-build the entire Samza package. This makes life easier for everyone when you just need to tweak one parameter, and don't want to have to worry about which branch your package was built from, or whether trunk is in a stable state. It also has the added benefit of forcing configuration to be fully resolved at runtime. This means that that the configuration for a job is resolved at the time run-job.sh is called (using --config-path and --config-provider parameters), and from that point on, the configuration is immutable, and passed where it needs to be by Samza (and YARN, if you're using it). - -The second statement, that your Samza package contains all JARs that it needs to run, means that a Samza package is entirely self contained. This allows Samza jobs to run on independent Samza versions without conflicting with each other. This is in contrast to Hadoop, where JARs are pulled in from the local machine that the job is running on (using environment variables). With Samza, you might run your job on version 0.7.0, and someone else might run their job on version 0.8.0. There is no problem with this. - -## [YARN Jobs »](yarn-jobs.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/jobs/reprocessing.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/jobs/reprocessing.md b/docs/learn/documentation/0.7.0/jobs/reprocessing.md deleted file mode 100644 index 28d9925..0000000 --- a/docs/learn/documentation/0.7.0/jobs/reprocessing.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -layout: page -title: Reprocessing previously processed data ---- -<!-- - 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. ---> - -From time to time you may want to deploy a new version of your Samza job that computes results differently. Perhaps you fixed a bug or introduced a new feature. For example, say you have a Samza job that classifies messages as spam or not-spam, using a machine learning model that you train offline. Periodically you want to deploy an updated version of your Samza job which includes the latest classification model. - -When you start up a new version of your job, a question arises: what do you want to do with messages that were previously processed with the old version of your job? The answer depends on the behavior you want: - -1. **No reprocessing:** By default, Samza assumes that messages processed by the old version don't need to be processed again. When the new version starts up, it will resume processing at the point where the old version left off (assuming you have [checkpointing](../container/checkpointing.html) enabled). If this is the behavior you want, there's nothing special you need to do. - -2. **Simple rewind:** Perhaps you want to go back and re-process old messages using the new version of your job. For example, maybe the old version of your classifier marked things as spam too aggressively, so you now want to revisit its previous spam/not-spam decisions using an improved classifier. You can do this by restarting the job at an older point in time in the stream, and running through all the messages since that time. Thus your job starts off reprocessing messages that it has already seen, but it then seamlessly continues with new messages when the reprocessing is done. - - This approach requires an input system such as Kafka, which allows you to jump back in time to a previous point in the stream. We discuss below how this works in practice. - -3. **Parallel rewind:** This approach avoids a downside of the *simple rewind* approach. With simple rewind, any new messages that appear while the job is reprocessing old data are queued up, and are processed when the reprocessing is done. The queueing delay needn't be long, because Samza can stream through historical data very quickly, but some latency-sensitive applications need to process messages faster. - - In the *parallel rewind* approach, you run two jobs in parallel: one job continues to handle live updates with low latency (the *real-time job*), while the other is started at an older point in the stream and reprocesses historical data (the *reprocessing job*). The two jobs consume the same input stream at different points in time, and eventually the reprocessing job catches up with the real-time job. - - There are a few details that you need to think through before deploying parallel rewind, which we discuss below. - -### Jumping Back in Time - -A common aspect of the *simple rewind* and *parallel rewind* approaches is: you have a job which jumps back to an old point in time in the input streams, and consumes all messages since that time. You achieve this by working with Samza's checkpoints. - -Normally, when a Samza job starts up, it reads the latest checkpoint to determine at which offset in the input streams it needs to resume processing. If you need to rewind to an earlier time, you do that in one of two ways: - -1. You can stop the job, manipulate its last checkpoint to point to an older offset, and start the job up again. Samza includes a command-line tool called [CheckpointTool](../container/checkpointing.html#toc_0) which you can use to manipulate checkpoints. -2. You can start a new job with a different *job.name* or *job.id* (e.g. increment *job.id* every time you need to jump back in time). This gives the job a new checkpoint stream, with none of the old checkpoint information. You also need to set [samza.offset.default=oldest](../container/checkpointing.html), so that when the job starts up without checkpoint, it starts consuming at the oldest offset available. - -With either of these approaches you can get Samza to reprocess the entire history of messages in the input system. Input systems such as Kafka can retain a large amount of history — see discussion below. In order to speed up the reprocessing of historical data, you can increase the container count (*yarn.container.count* if you're running Samza on YARN) to boost your job's computational resources. - -If your job maintains any [persistent state](../container/state-management.html), you need to be careful when jumping back in time: resetting a checkpoint does not automatically change persistent state, so you could end up reprocessing old messages while using state from a later point in time. In most cases, a job that jumps back in time should start with an empty state. You can reset the state by deleting the changelog topic, or by changing the name of the changelog topic in your job configuration. - -When you're jumping back in time, you're using Samza somewhat like a batch processing framework (e.g. MapReduce) — with the difference that your job doesn't stop when it has processed all the historical data, but instead continues running, incrementally processing the stream of new messages as they come in. This has the advantage that you don't need to write and maintain separate batch and streaming versions of your job: you can just use the same Samza API for processing both real-time and historical data. - -### Retention of history - -Samza doesn't maintain history itself — that is the responsibility of the input system, such as Kafka. How far back in time you can jump depends on the amount of history that is retained in that system. - -Kafka is designed to keep a fairly large amount of history: it is common for Kafka brokers to keep one or two weeks of message history accessible, even for high volume topics. The retention period is mostly determined by how much disk space you have available. Kafka's performance [remains high](http://engineering.linkedin.com/kafka/benchmarking-apache-kafka-2-million-writes-second-three-cheap-machines) even if you have terabytes of history. - -There are two different kinds of history which require different configuration: - -* **Activity events** are things like user tracking events, web server log events and the like. This kind of stream is typically configured with a time-based retention, e.g. a few weeks. Events older than the retention period are deleted (or archived in an offline system such as HDFS). -* **Database changes** are events that show inserts, updates and deletes in a database. In this kind of stream, each event typically has a primary key, and a newer event for a key overwrites any older events for the same key. If the same key is updated many times, you're only really interested in the most recent value. (The [changelog streams](../container/state-management.html) used by Samza's persistent state fall in this category.) - -In a database change stream, when you're reprocessing data, you typically want to reprocess the entire database. You don't want to miss a value just because it was last updated more than a few weeks ago. In other words, you don't want change events to be deleted just because they are older than some threshold. In this case, when you're jumping back in time, you need to rewind to the *beginning of time*, to the first change ever made to the database (known in Kafka as "offset 0"). - -Fortunately this can be done efficiently, using a Kafka feature called [log compaction](http://kafka.apache.org/documentation.html#compaction). - -For example, imagine your database contains counters: every time something happens, you increment the appropriate counters and update the database with the new counter values. Every update is sent to the changelog, and because there are many updates, the changelog stream will take up a lot of space. With log compaction turned on, Kafka deduplicates the stream in the background, keeping only the most recent counter value for each key, and deleting any old values for the same counter. This reduces the size of the stream so much that you can keep the most recent update for every key, even if it was last updated long ago. - -With log compaction enabled, the stream of database changes becomes a full copy of the entire database. By jumping back to offset 0, your Samza job can scan over the entire database and reprocess it. This is a very powerful way of building scalable applications. - -### Details of Parallel Rewind - -If you are taking the *parallel rewind* approach described above, running two jobs in parallel, you need to configure them carefully to avoid problems. In particular, some things to look out for: - -* Make sure that the two jobs don't interfere with each other. They need different *job.name* or *job.id* configuration properties, so that each job gets its own checkpoint stream. If the jobs maintain [persistent state](../container/state-management.html), each job needs its own changelog (two different jobs writing to the same changelog produces undefined results). -* What happens to job output? If the job sends its results to an output stream, or writes to a database, then the easiest solution is for each job to have a separate output stream or database table. If they write to the same output, you need to take care to ensure that newer data isn't overwritten with older data (due to race conditions between the two jobs). -* Do you need to support A/B testing between the old and the new version of your job, e.g. to test whether the new version improves your metrics? Parallel rewind is ideal for this: each job writes to a separate output, and clients or consumers of the output can read from either the old or the new version's output, depending on whether a user is in test group A or B. -* Reclaiming resources: you might want to keep the old version of your job running for a while, even when the new version has finished reprocessing historical data (especially if the old version's output is being used in an A/B test). However, eventually you'll want to shut it down, and delete the checkpoint and changelog streams belonging to the old version. - -Samza gives you a lot of flexibility for reprocessing historical data, and you don't need to program against a separate batch processing API to take advantage of it. If you're mindful of these issues, you can build a data system that is very robust, but still gives you lots of freedom to change your processing logic in future. - -## [Application Master »](../yarn/application-master.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/jobs/yarn-jobs.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/jobs/yarn-jobs.md b/docs/learn/documentation/0.7.0/jobs/yarn-jobs.md deleted file mode 100644 index 58ca50d..0000000 --- a/docs/learn/documentation/0.7.0/jobs/yarn-jobs.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: page -title: YARN Jobs ---- -<!-- - 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. ---> - -When you define `job.factory.class=org.apache.samza.job.yarn.YarnJobFactory` in your job's configuration, Samza will use YARN to execute your job. The YarnJobFactory will use the YARN_HOME environment variable on the machine that run-job.sh is executed on to get the appropriate YARN configuration, which will define where the YARN resource manager is. The YarnJob will work with the resource manager to get your job started on the YARN cluster. - -If you want to use YARN to run your Samza job, you'll also need to define the location of your Samza job's package. For example, you might say: - -{% highlight jproperties %} -yarn.package.path=http://my.http.server/jobs/ingraphs-package-0.0.55.tgz -{% endhighlight %} - -This .tgz file follows the conventions outlined on the [Packaging](packaging.html) page (it has bin/run-am.sh and bin/run-container.sh). YARN NodeManagers will take responsibility for downloading this .tgz file on the appropriate machines, and untar'ing them. From there, YARN will execute run-am.sh or run-container.sh for the Samza Application Master, and SamzaContainer, respectively. - -<!-- TODO document yarn.container.count and other key configs --> - -## [Logging »](logging.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/operations/kafka.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/operations/kafka.md b/docs/learn/documentation/0.7.0/operations/kafka.md deleted file mode 100644 index 29833e4..0000000 --- a/docs/learn/documentation/0.7.0/operations/kafka.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: page -title: Kafka ---- -<!-- - 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. ---> - -<!-- TODO kafka page should be fleshed out a bit --> - -<!-- TODO when 0.8.1 is released, update with state management config information --> - -Kafka has a great [operations wiki](http://kafka.apache.org/08/ops.html), which provides some detail on how to operate Kafka at scale. - -### Auto-Create Topics - -Kafka brokers should be configured to automatically create topics. Without this, it's going to be very cumbersome to run Samze jobs, since jobs will write to arbitrary (and sometimes new) topics. - -{% highlight jproperties %} -auto.create.topics.enable=true -{% endhighlight %} http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/operations/security.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/operations/security.md b/docs/learn/documentation/0.7.0/operations/security.md deleted file mode 100644 index b7ef24e..0000000 --- a/docs/learn/documentation/0.7.0/operations/security.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: page -title: Security ---- -<!-- - 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. ---> - -Samza provides no security. All security is implemented in the stream system, or in the environment that Samza containers run. - -### Securing Streaming Systems - -Samza does not provide any security at the stream system level. It is up to individual streaming systems to enforce their own security. If a stream system requires usernames and passwords in order to consume from specific streams, these values must be supplied via configuration, and used at the StreamConsumer/StreamConsumerFactory implementation. The same holds true if the streaming system uses SSL certificates or Kerberos. The environment in which Samza runs must provide the appropriate certificate or Kerberos ticket, and the StreamConsumer must be implemented to use these certificates or tickets. - -#### Securing Kafka - -Kafka provides no security for its topics, and therefore Samza doesn't provide any security when using Kafka topics. - -### Securing Samza's Environment - -The most important thing to keep in mind when securing an environment that Samza containers run in is that **Samza containers execute arbitrary user code**. They must considered an adversarial application, and the environment must be locked down accordingly. - -#### Configuration - -Samza reads all configuration at the time a Samza job is started using the run-job.sh script. If configuration contains sensitive information, then care must be taken to provide the JobRunner with the configuration. This means implementing a ConfigFactory that understands the configuration security model, and resolves configuration to Samza's Config object in a secure way. - -During the duration of a Samza job's execution, the configuration is kept in memory. The only time configuration is visible is: - -1. When configuration is resolved using a ConfigFactory. -2. The configuration is printed to STDOUT when run-job.sh is run. -3. The configuration is written to the logs when a Samza container starts. - -If configuration contains sensitive data, then these three points must be secured. - -#### Ports - -The only port that a Samza container opens by default is an un-secured JMX port that is randomly selected at start time. If this is not desired, JMX can be disabled through configuration. See the [Configuration](configuration.html) page for details. - -Users might open ports from inside a Samza container. If this is not desired, then the user that executes the Samza container must have the appropriate permissions revoked, usually using iptables. - -#### Logs - -Samza container logs contain configuration, and might contain arbitrary sensitive data logged by the user. A secure log directory must be provided to the Samza container. - -#### Starting a Samza Job - -If operators do not wish to allow Samza containers to be executed by arbitrary users, then the mechanism that Samza containers are deployed must secured. Usually, this means controlling execution of the run-job.sh script. The recommended pattern is to lock down the machines that Samza containers run on, and execute run-job.sh from either a blessed web service or special machine, and only allow access to the service or machine by specific users. - -#### Shell Scripts - -Please see the [Packaging](packaging.html) section for details on the the shell scripts that Samza uses. Samza containers allow users to execute arbitrary shell commands, so user permissions must be locked down to prevent users from damaging the environment or reading sensitive data. - -#### YARN - -<!-- TODO make the security page link to the actual YARN security document, when we write it. --> - -Samza provides out-of-the-box YARN integration. Take a look at Samza's YARN Security page for details. - -## [Kafka »](kafka.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/yarn/application-master.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/yarn/application-master.md b/docs/learn/documentation/0.7.0/yarn/application-master.md deleted file mode 100644 index 6b81805..0000000 --- a/docs/learn/documentation/0.7.0/yarn/application-master.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: page -title: Application Master ---- -<!-- - 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. ---> - -YARN is Hadoop's next-generation cluster manager. It allows developers to deploy and execute arbitrary commands on a grid. If you're unfamiliar with YARN, or the concept of an ApplicationMaster (AM), please read Hadoop's [YARN](http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/YARN.html) page. - -### Integration - -Samza's main integration with YARN comes in the form of a Samza ApplicationMaster. This is the chunk of code responsible for managing a Samza job in a YARN grid. It decides what to do when a stream processor fails, which machines a Samza job's [containers](../container/samza-container.html) should run on, and so on. - -When the Samza ApplicationMaster starts up, it does the following: - -1. Receives configuration from YARN via the STREAMING_CONFIG environment variable. -2. Starts a JMX server on a random port. -3. Instantiates a metrics registry and reporters to keep track of relevant metrics. -4. Registers the AM with YARN's RM. -5. Get the total number of partitions for the Samza job using each input stream's PartitionManager (see the [Streams](../container/streams.html) page for details). -6. Read the total number of containers requested from the Samza job's configuration. -7. Assign each partition to a container (called a Task Group in Samza's AM dashboard). -8. Make a [ResourceRequest](http://hadoop.apache.org/docs/current/api/org/apache/hadoop/yarn/api/records/ResourceRequest.html) to YARN for each container. -9. Poll the YARN RM every second to check for allocated and released containers. - -From this point on, the ApplicationMaster just reacts to events from the RM. - -### Fault Tolerance - -Whenever a container is allocated, the AM will work with the YARN NM to start a SamzaContainer (with appropriate partitions assigned to it) in the container. If a container fails with a non-zero return code, the AM will request a new container, and restart the SamzaContainer. If a SamzaContainer fails too many times, too quickly, the ApplicationMaster will fail the whole Samza job with a non-zero return code. See the yarn.container.retry.count and yarn.container.retry.window.ms [configuration](../jobs/configuration.html) parameters for details. - -When the AM receives a reboot signal from YARN, it will throw a SamzaException. This will trigger a clean and successful shutdown of the AM (YARN won't think the AM failed). - -If the AM, itself, fails, YARN will handle restarting the AM. When the AM is restarted, all containers that were running will be killed, and the AM will start from scratch. The same list of operations, shown above, will be executed. The AM will request new containers for its SamzaContainers, and proceed as though it has just started for the first time. YARN has a yarn.resourcemanager.am.max-retries configuration parameter that's defined in [yarn-site.xml](http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-common/yarn-default.xml). This configuration defaults to 1, which means that, by default, a single AM failure will cause your Samza job to stop running. - -### Dashboard - -Samza's ApplicationMaster comes with a dashboard to show useful information such as: - -1. Where containers are located. -2. Links to logs. -3. The Samza job's configuration. -4. Container failure count. - -You can find this dashboard by going to your YARN grid's ResourceManager page (usually something like [http://localhost:8088/cluster](http://localhost:8088/cluster)), and clicking on the "ApplicationMaster" link of a running Samza job. - -<img src="/img/0.7.0/learn/documentation/yarn/samza-am-dashboard.png" alt="Screenshot of ApplicationMaster dashboard" class="diagram-large"> - -### Security - -The Samza dashboard's HTTP access is currently un-secured, even when using YARN in secure-mode. This means that users with access to a YARN grid could port-scan a Samza ApplicationMaster's HTTP server, and open the dashboard in a browser to view its contents. Sensitive configuration can be viewed by anyone, in this way, and care should be taken. There are plans to secure Samza's ApplicationMaster using [Hadoop's security](http://docs.hortonworks.com/HDPDocuments/HDP1/HDP-1.3.0/bk_installing_manually_book/content/rpm-chap14-2-3-1.html) features ([SPENAGO](http://en.wikipedia.org/wiki/SPNEGO)). - -See Samza's [security](../operations/security.html) page for more details. - -## [Isolation »](isolation.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/0.7.0/yarn/isolation.md ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/0.7.0/yarn/isolation.md b/docs/learn/documentation/0.7.0/yarn/isolation.md deleted file mode 100644 index 1eb3bf5..0000000 --- a/docs/learn/documentation/0.7.0/yarn/isolation.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: page -title: Isolation ---- -<!-- - 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. ---> - -When running Samza jobs in a shared, distributed environment, the stream processors can have an impact on one another's performance. A stream processor that uses 100% of a machine's CPU will slow down all other stream processors on the machine. - -One of [YARN](http://hadoop.apache.org/docs/current/hadoop-yarn/hadoop-yarn-site/YARN.html)'s responsibilities is to manage resources so that this doesn't happen. Each of YARN's Node Managers (NM) has a chunk of "resources" dedicated to it. The YARN Resource Manager (RM) will only allow a container to be allocated on a NM if it has enough resources to satisfy the container's needs. - -YARN currently supports resource management for memory and CPU. - -### Memory - -YARN will automatically enforce memory limits for all containers that it executes. All containers must have a max-memory size defined when they're created. If the sum of all memory usage for processes associated with a single YARN container exceeds this maximum, YARN will kill the container. - -Samza supports memory limits using the yarn.container.memory.mb and yarn.am.container.memory.mb configuration parameters. Keep in mind that this is simply the amount of memory YARN will allow a [SamzaContainer](../container/samza-container.html) or [ApplicationMaster](application-master.html) to have. You'll still need to configure your heap settings appropriately using task.opts, when using Java (the default is -Xmx160M). See the [Configuration](../jobs/configuration.html) and [Packaging](../jobs/packaging.html) pages for details. - -### CPU - -YARN has the concept of a virtual core. Each NM is assigned a total number of virtual cores (32, by default). When a container request is made, it must specify how many virtual cores it needs. The YARN RM will only assign the container to a NM that has enough virtual cores to satisfy the request. - -#### CGroups - -Unlike memory, which YARN can enforce itself (by looking at the /proc folder), YARN can't enforce CPU isolation, since this must be done at the Linux kernel level. One of YARN's interesting new features is its support for Linux [CGroups](https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt). CGroups are a way to control process utilization at the kernel level in Linux. - -If YARN is setup to use CGroups, then YARN will guarantee that a container will get at least the amount of CPU that it requires. Currently, YARN will give you more CPU, if it's available. For details on enforcing "at most" CPU usage, see [YARN-810](https://issues.apache.org/jira/browse/YARN-810). - -See [this blog post](http://riccomini.name/posts/hadoop/2013-06-14-yarn-with-cgroups/) for details on setting up YARN with CGroups. - -## [Security »](../operations/security.html) http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html b/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html new file mode 100644 index 0000000..93c48c0 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/allclasses-frame.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>All Classes (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar">All Classes</h1> +<div class="indexContainer"> +<ul> +<li><a href="org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job" target="classFrame">ApplicationStatus</a></li> +<li><a href="org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser" target="classFrame">BaseMessageChooser</a></li> +<li><a href="org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util" target="classFrame">BlockingEnvelopeMap</a></li> +<li><a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint" target="classFrame">Checkpoint</a></li> +<li><a href="org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint" target="classFrame"><i>CheckpointManager</i></a></li> +<li><a href="org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint" target="classFrame"><i>CheckpointManagerFactory</i></a></li> +<li><a href="org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util" target="classFrame"><i>Clock</i></a></li> +<li><a href="org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>ClosableTask</i></a></li> +<li><a href="org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job" target="classFrame">CommandBuilder</a></li> +<li><a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config" target="classFrame">Config</a></li> +<li><a href="org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config" target="classFrame">ConfigException</a></li> +<li><a href="org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigFactory</i></a></li> +<li><a href="org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigRewriter</i></a></li> +<li><a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics" target="classFrame">Counter</a></li> +<li><a href="org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Deserializer</i></a></li> +<li><a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics" target="classFrame">Gauge</a></li> +<li><a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">IncomingMessageEnvelope</a></li> +<li><a href="org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>InitableTask</i></a></li> +<li><a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config" target="classFrame">MapConfig</a></li> +<li><a href="org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><i>MessageChooser</i></a></li> +<li><a href="org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><i>MessageChooserFactory</i></a></li> +<li><a href="org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task" target="classFrame"><i>MessageCollector</i></a></li> +<li><a href="org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>Metric</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsRegistry</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporter</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>MetricsReporterFactory</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics" target="classFrame">MetricsVisitor</a></li> +<li><a href="org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util" target="classFrame">NoOpMetricsRegistry</a></li> +<li><a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">OutgoingMessageEnvelope</a></li> +<li><a href="org/apache/samza/Partition.html" title="class in org.apache.samza" target="classFrame">Partition</a></li> +<li><a href="org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>ReadableMetricsRegistry</i></a></li> +<li><a href="org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>ReadableMetricsRegistryListener</i></a></li> +<li><a href="org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics" target="classFrame"><i>Reservoir</i></a></li> +<li><a href="org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container" target="classFrame">SamzaContainerContext</a></li> +<li><a href="org/apache/samza/SamzaException.html" title="class in org.apache.samza" target="classFrame">SamzaException</a></li> +<li><a href="org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Serde</i></a></li> +<li><a href="org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>SerdeFactory</i></a></li> +<li><a href="org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers" target="classFrame"><i>Serializer</i></a></li> +<li><a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util" target="classFrame">SinglePartitionWithoutOffsetsSystemAdmin</a></li> +<li><a href="org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics" target="classFrame">SlidingTimeWindowReservoir</a></li> +<li><a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics" target="classFrame">Snapshot</a></li> +<li><a href="org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngine</i></a></li> +<li><a href="org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage" target="classFrame"><i>StorageEngineFactory</i></a></li> +<li><a href="org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job" target="classFrame"><i>StreamJob</i></a></li> +<li><a href="org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job" target="classFrame"><i>StreamJobFactory</i></a></li> +<li><a href="org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>StreamTask</i></a></li> +<li><a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemAdmin</i></a></li> +<li><a href="org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemConsumer</i></a></li> +<li><a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemFactory</i></a></li> +<li><a href="org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemProducer</i></a></li> +<li><a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system" target="classFrame">SystemStream</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamMetadata</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system" target="classFrame">SystemStreamMetadata.OffsetType</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamMetadata.SystemStreamPartitionMetadata</a></li> +<li><a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamPartition</a></li> +<li><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream" target="classFrame"><i>SystemStreamPartitionGrouper</i></a></li> +<li><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html" title="interface in org.apache.samza.container.grouper.stream" target="classFrame"><i>SystemStreamPartitionGrouperFactory</i></a></li> +<li><a href="org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamPartitionIterator</a></li> +<li><a href="org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskContext</i></a></li> +<li><a href="org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskCoordinator</i></a></li> +<li><a href="org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task" target="classFrame">TaskCoordinator.RequestScope</a></li> +<li><a href="org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskLifecycleListener</i></a></li> +<li><a href="org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task" target="classFrame"><i>TaskLifecycleListenerFactory</i></a></li> +<li><a href="org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container" target="classFrame">TaskName</a></li> +<li><a href="org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics" target="classFrame">Timer</a></li> +<li><a href="org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task" target="classFrame"><i>WindowableTask</i></a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html b/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html new file mode 100644 index 0000000..5cbcef0 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/allclasses-noframe.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>All Classes (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar">All Classes</h1> +<div class="indexContainer"> +<ul> +<li><a href="org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job">ApplicationStatus</a></li> +<li><a href="org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></li> +<li><a href="org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></li> +<li><a href="org/apache/samza/checkpoint/Checkpoint.html" title="class in org.apache.samza.checkpoint">Checkpoint</a></li> +<li><a href="org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><i>CheckpointManager</i></a></li> +<li><a href="org/apache/samza/checkpoint/CheckpointManagerFactory.html" title="interface in org.apache.samza.checkpoint"><i>CheckpointManagerFactory</i></a></li> +<li><a href="org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util"><i>Clock</i></a></li> +<li><a href="org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><i>ClosableTask</i></a></li> +<li><a href="org/apache/samza/job/CommandBuilder.html" title="class in org.apache.samza.job">CommandBuilder</a></li> +<li><a href="org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></li> +<li><a href="org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></li> +<li><a href="org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><i>ConfigFactory</i></a></li> +<li><a href="org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><i>ConfigRewriter</i></a></li> +<li><a href="org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></li> +<li><a href="org/apache/samza/serializers/Deserializer.html" title="interface in org.apache.samza.serializers"><i>Deserializer</i></a></li> +<li><a href="org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></li> +<li><a href="org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></li> +<li><a href="org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><i>InitableTask</i></a></li> +<li><a href="org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></li> +<li><a href="org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><i>MessageChooser</i></a></li> +<li><a href="org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><i>MessageChooserFactory</i></a></li> +<li><a href="org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><i>MessageCollector</i></a></li> +<li><a href="org/apache/samza/metrics/Metric.html" title="interface in org.apache.samza.metrics"><i>Metric</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><i>MetricsRegistry</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsReporter.html" title="interface in org.apache.samza.metrics"><i>MetricsReporter</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsReporterFactory.html" title="interface in org.apache.samza.metrics"><i>MetricsReporterFactory</i></a></li> +<li><a href="org/apache/samza/metrics/MetricsVisitor.html" title="class in org.apache.samza.metrics">MetricsVisitor</a></li> +<li><a href="org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></li> +<li><a href="org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></li> +<li><a href="org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a></li> +<li><a href="org/apache/samza/metrics/ReadableMetricsRegistry.html" title="interface in org.apache.samza.metrics"><i>ReadableMetricsRegistry</i></a></li> +<li><a href="org/apache/samza/metrics/ReadableMetricsRegistryListener.html" title="interface in org.apache.samza.metrics"><i>ReadableMetricsRegistryListener</i></a></li> +<li><a href="org/apache/samza/metrics/Reservoir.html" title="interface in org.apache.samza.metrics"><i>Reservoir</i></a></li> +<li><a href="org/apache/samza/container/SamzaContainerContext.html" title="class in org.apache.samza.container">SamzaContainerContext</a></li> +<li><a href="org/apache/samza/SamzaException.html" title="class in org.apache.samza">SamzaException</a></li> +<li><a href="org/apache/samza/serializers/Serde.html" title="interface in org.apache.samza.serializers"><i>Serde</i></a></li> +<li><a href="org/apache/samza/serializers/SerdeFactory.html" title="interface in org.apache.samza.serializers"><i>SerdeFactory</i></a></li> +<li><a href="org/apache/samza/serializers/Serializer.html" title="interface in org.apache.samza.serializers"><i>Serializer</i></a></li> +<li><a href="org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></li> +<li><a href="org/apache/samza/metrics/SlidingTimeWindowReservoir.html" title="class in org.apache.samza.metrics">SlidingTimeWindowReservoir</a></li> +<li><a href="org/apache/samza/metrics/Snapshot.html" title="class in org.apache.samza.metrics">Snapshot</a></li> +<li><a href="org/apache/samza/storage/StorageEngine.html" title="interface in org.apache.samza.storage"><i>StorageEngine</i></a></li> +<li><a href="org/apache/samza/storage/StorageEngineFactory.html" title="interface in org.apache.samza.storage"><i>StorageEngineFactory</i></a></li> +<li><a href="org/apache/samza/job/StreamJob.html" title="interface in org.apache.samza.job"><i>StreamJob</i></a></li> +<li><a href="org/apache/samza/job/StreamJobFactory.html" title="interface in org.apache.samza.job"><i>StreamJobFactory</i></a></li> +<li><a href="org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><i>StreamTask</i></a></li> +<li><a href="org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><i>SystemAdmin</i></a></li> +<li><a href="org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><i>SystemConsumer</i></a></li> +<li><a href="org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><i>SystemFactory</i></a></li> +<li><a href="org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><i>SystemProducer</i></a></li> +<li><a href="org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></li> +<li><a href="org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></li> +<li><a href="org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></li> +<li><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouper.html" title="interface in org.apache.samza.container.grouper.stream"><i>SystemStreamPartitionGrouper</i></a></li> +<li><a href="org/apache/samza/container/grouper/stream/SystemStreamPartitionGrouperFactory.html" title="interface in org.apache.samza.container.grouper.stream"><i>SystemStreamPartitionGrouperFactory</i></a></li> +<li><a href="org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></li> +<li><a href="org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><i>TaskContext</i></a></li> +<li><a href="org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><i>TaskCoordinator</i></a></li> +<li><a href="org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></li> +<li><a href="org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><i>TaskLifecycleListener</i></a></li> +<li><a href="org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><i>TaskLifecycleListenerFactory</i></a></li> +<li><a href="org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></li> +<li><a href="org/apache/samza/metrics/Timer.html" title="class in org.apache.samza.metrics">Timer</a></li> +<li><a href="org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><i>WindowableTask</i></a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/constant-values.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/constant-values.html b/docs/learn/documentation/versioned/api/javadocs/constant-values.html new file mode 100644 index 0000000..d0c1e22 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/constant-values.html @@ -0,0 +1,142 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>Constant Field Values (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Constant Field Values (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> +<li><a href="constant-values.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Constant Field Values" class="title">Constant Field Values</h1> +<h2 title="Contents">Contents</h2> +<ul> +<li><a href="#org.apache">org.apache.*</a></li> +</ul> +</div> +<div class="constantValuesContainer"><a name="org.apache"> +<!-- --> +</a> +<h2 title="org.apache">org.apache.*</h2> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values"> +<caption><span>org.apache.samza.system.<a href="org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th scope="col">Constant Field</th> +<th class="colLast" scope="col">Value</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a name="org.apache.samza.system.SystemConsumer.BLOCK_ON_OUTSTANDING_MESSAGES"> +<!-- --> +</a><code>public static final int</code></td> +<td><code><a href="org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></code></td> +<td class="colLast"><code>-1</code></td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?constant-values.html" target="_top">Frames</a></li> +<li><a href="constant-values.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html b/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html new file mode 100644 index 0000000..d59904b --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/deprecated-list.html @@ -0,0 +1,113 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>Deprecated List (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Deprecated List (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li class="navBarCell1Rev">Deprecated</li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> +<li><a href="deprecated-list.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Deprecated API" class="title">Deprecated API</h1> +<h2 title="Contents">Contents</h2> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li class="navBarCell1Rev">Deprecated</li> +<li><a href="index-all.html">Index</a></li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li> +<li><a href="deprecated-list.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/help-doc.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/help-doc.html b/docs/learn/documentation/versioned/api/javadocs/help-doc.html new file mode 100644 index 0000000..ec18084 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/help-doc.html @@ -0,0 +1,214 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>API Help (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="API Help (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="navBarCell1Rev">Help</li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> +<li><a href="help-doc.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">How This API Document Is Organized</h1> +<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<h2>Overview</h2> +<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> +</li> +<li class="blockList"> +<h2>Package</h2> +<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> +<ul> +<li>Interfaces (italic)</li> +<li>Classes</li> +<li>Enums</li> +<li>Exceptions</li> +<li>Errors</li> +<li>Annotation Types</li> +</ul> +</li> +<li class="blockList"> +<h2>Class/Interface</h2> +<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p> +<ul> +<li>Class inheritance diagram</li> +<li>Direct Subclasses</li> +<li>All Known Subinterfaces</li> +<li>All Known Implementing Classes</li> +<li>Class/interface declaration</li> +<li>Class/interface description</li> +</ul> +<ul> +<li>Nested Class Summary</li> +<li>Field Summary</li> +<li>Constructor Summary</li> +<li>Method Summary</li> +</ul> +<ul> +<li>Field Detail</li> +<li>Constructor Detail</li> +<li>Method Detail</li> +</ul> +<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> +</li> +<li class="blockList"> +<h2>Annotation Type</h2> +<p>Each annotation type has its own separate page with the following sections:</p> +<ul> +<li>Annotation Type declaration</li> +<li>Annotation Type description</li> +<li>Required Element Summary</li> +<li>Optional Element Summary</li> +<li>Element Detail</li> +</ul> +</li> +<li class="blockList"> +<h2>Enum</h2> +<p>Each enum has its own separate page with the following sections:</p> +<ul> +<li>Enum declaration</li> +<li>Enum description</li> +<li>Enum Constant Summary</li> +<li>Enum Constant Detail</li> +</ul> +</li> +<li class="blockList"> +<h2>Tree (Class Hierarchy)</h2> +<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p> +<ul> +<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> +<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> +</ul> +</li> +<li class="blockList"> +<h2>Deprecated API</h2> +<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> +</li> +<li class="blockList"> +<h2>Index</h2> +<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> +</li> +<li class="blockList"> +<h2>Prev/Next</h2> +<p>These links take you to the next or previous class, interface, package, or related page.</p> +</li> +<li class="blockList"> +<h2>Frames/No Frames</h2> +<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> +</li> +<li class="blockList"> +<h2>All Classes</h2> +<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> +</li> +<li class="blockList"> +<h2>Serialized Form</h2> +<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p> +</li> +<li class="blockList"> +<h2>Constant Field Values</h2> +<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> +</li> +</ul> +<em>This help file applies to API documentation generated using the standard doclet.</em></div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="navBarCell1Rev">Help</li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> +<li><a href="help-doc.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
