source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/fs/s3/package-summary.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 11.8 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:59 UTC 2009 -->
6<TITLE>
7org.apache.hadoop.fs.s3 (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="org.apache.hadoop.fs.s3 (Hadoop 0.20.1 API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/hadoop/fs/permission/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/fs/s3native/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/fs/s3/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77</TABLE>
78<A NAME="skip-navbar_top"></A>
79<!-- ========= END OF TOP NAVBAR ========= -->
80
81<HR>
82<H2>
83Package org.apache.hadoop.fs.s3
84</H2>
85A distributed, block-based implementation of <A HREF="../../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs"><CODE>FileSystem</CODE></A> that uses <a href="http://aws.amazon.com/s3">Amazon S3</a>
86as a backing store.
87<P>
88<B>See:</B>
89<BR>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
91<P>
92
93<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
94<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
95<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
96<B>Interface Summary</B></FONT></TH>
97</TR>
98<TR BGCOLOR="white" CLASS="TableRowColor">
99<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/FileSystemStore.html" title="interface in org.apache.hadoop.fs.s3">FileSystemStore</A></B></TD>
100<TD>A facility for storing and retrieving <A HREF="../../../../../org/apache/hadoop/fs/s3/INode.html" title="class in org.apache.hadoop.fs.s3"><CODE>INode</CODE></A>s and <A HREF="../../../../../org/apache/hadoop/fs/s3/Block.html" title="class in org.apache.hadoop.fs.s3"><CODE>Block</CODE></A>s.</TD>
101</TR>
102</TABLE>
103&nbsp;
104
105<P>
106
107<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
108<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
109<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
110<B>Class Summary</B></FONT></TH>
111</TR>
112<TR BGCOLOR="white" CLASS="TableRowColor">
113<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/Block.html" title="class in org.apache.hadoop.fs.s3">Block</A></B></TD>
114<TD>Holds metadata about a block of data being stored in a <A HREF="../../../../../org/apache/hadoop/fs/s3/FileSystemStore.html" title="interface in org.apache.hadoop.fs.s3"><CODE>FileSystemStore</CODE></A>.</TD>
115</TR>
116<TR BGCOLOR="white" CLASS="TableRowColor">
117<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/INode.html" title="class in org.apache.hadoop.fs.s3">INode</A></B></TD>
118<TD>Holds file metadata including type (regular file, or directory),
119 and the list of blocks that are pointers to the data.</TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/MigrationTool.html" title="class in org.apache.hadoop.fs.s3">MigrationTool</A></B></TD>
123<TD>
124 This class is a tool for migrating data from an older to a newer version
125 of an S3 filesystem.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/S3Credentials.html" title="class in org.apache.hadoop.fs.s3">S3Credentials</A></B></TD>
129<TD>
130 Extracts AWS credentials from the filesystem URI or configuration.</TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/S3FileSystem.html" title="class in org.apache.hadoop.fs.s3">S3FileSystem</A></B></TD>
134<TD>
135 A block-based <A HREF="../../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs"><CODE>FileSystem</CODE></A> backed by
136 <a href="http://aws.amazon.com/s3">Amazon S3</a>.</TD>
137</TR>
138</TABLE>
139&nbsp;
140
141<P>
142
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146<B>Exception Summary</B></FONT></TH>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/S3Exception.html" title="class in org.apache.hadoop.fs.s3">S3Exception</A></B></TD>
150<TD>Thrown if there is a problem communicating with Amazon S3.</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/S3FileSystemException.html" title="class in org.apache.hadoop.fs.s3">S3FileSystemException</A></B></TD>
154<TD>Thrown when there is a fatal exception while using <A HREF="../../../../../org/apache/hadoop/fs/s3/S3FileSystem.html" title="class in org.apache.hadoop.fs.s3"><CODE>S3FileSystem</CODE></A>.</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/hadoop/fs/s3/VersionMismatchException.html" title="class in org.apache.hadoop.fs.s3">VersionMismatchException</A></B></TD>
158<TD>Thrown when Hadoop cannot read the version of the data stored
159 in <A HREF="../../../../../org/apache/hadoop/fs/s3/S3FileSystem.html" title="class in org.apache.hadoop.fs.s3"><CODE>S3FileSystem</CODE></A>.</TD>
160</TR>
161</TABLE>
162&nbsp;
163
164<P>
165<A NAME="package_description"><!-- --></A><H2>
166Package org.apache.hadoop.fs.s3 Description
167</H2>
168
169<P>
170<p>A distributed, block-based implementation of <A HREF="../../../../../org/apache/hadoop/fs/FileSystem.html" title="class in org.apache.hadoop.fs"><CODE>FileSystem</CODE></A> that uses <a href="http://aws.amazon.com/s3">Amazon S3</a>
171as a backing store.</p>
172
173<p>
174Files are stored in S3 as blocks (represented by
175<A HREF="../../../../../org/apache/hadoop/fs/s3/Block.html" title="class in org.apache.hadoop.fs.s3"><CODE>Block</CODE></A>), which have an ID and a length.
176Block metadata is stored in S3 as a small record (represented by
177<A HREF="../../../../../org/apache/hadoop/fs/s3/INode.html" title="class in org.apache.hadoop.fs.s3"><CODE>INode</CODE></A>) using the URL-encoded
178path string as a key. Inodes record the file type (regular file or directory) and the list of blocks.
179This design makes it easy to seek to any given position in a file by reading the inode data to compute
180which block to access, then using S3's support for
181<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.2">HTTP Range</a> headers
182to start streaming from the correct position.
183Renames are also efficient since only the inode is moved (by a DELETE followed by a PUT since
184S3 does not support renames).
185</p>
186<p>
187For a single file <i>/dir1/file1</i> which takes two blocks of storage, the file structure in S3
188would be something like this:
189</p>
190<pre>
191/
192/dir1
193/dir1/file1
194block-6415776850131549260
195block-3026438247347758425
196</pre>
197<p>
198Inodes start with a leading <code>/</code>, while blocks are prefixed with <code>block-</code>.
199</p>
200<P>
201
202<P>
203<DL>
204</DL>
205<HR>
206
207
208<!-- ======= START OF BOTTOM NAVBAR ====== -->
209<A NAME="navbar_bottom"><!-- --></A>
210<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
211<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
212<TR>
213<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
214<A NAME="navbar_bottom_firstrow"><!-- --></A>
215<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
216  <TR ALIGN="center" VALIGN="top">
217  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
218  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
219  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
220  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
221  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
222  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
223  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
224  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
225  </TR>
226</TABLE>
227</TD>
228<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
229</EM>
230</TD>
231</TR>
232
233<TR>
234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
235&nbsp;<A HREF="../../../../../org/apache/hadoop/fs/permission/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
236&nbsp;<A HREF="../../../../../org/apache/hadoop/fs/s3native/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
237<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
238  <A HREF="../../../../../index.html?org/apache/hadoop/fs/s3/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
239&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
240&nbsp;<SCRIPT type="text/javascript">
241  <!--
242  if(window==top) {
243    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
244  }
245  //-->
246</SCRIPT>
247<NOSCRIPT>
248  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
249</NOSCRIPT>
250
251
252</FONT></TD>
253</TR>
254</TABLE>
255<A NAME="skip-navbar_bottom"></A>
256<!-- ======== END OF BOTTOM NAVBAR ======= -->
257
258<HR>
259Copyright &copy; 2009 The Apache Software Foundation
260</BODY>
261</HTML>
Note: See TracBrowser for help on using the repository browser.