Skip to content

Commit ee7e98b

Browse files
chingor13chingor13
authored
docs: move wiki to docs area (#386)
1 parent 41bab65 commit ee7e98b

File tree

8 files changed

+733
-0
lines changed

8 files changed

+733
-0
lines changed

‎docs/_config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
theme: jekyll-theme-dinky
2+
title: Google OAuth Client for Java

‎docs/_data/navigation.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
toc:
2+
- page: Overview
3+
url: index.html
4+
- page: Setup Instructions
5+
url: setup.html
6+
- page: Component Modules
7+
url: component-modules.html
8+
- page: OAuth 1.0
9+
url: oauth-1.0.html
10+
- page: OAuth 2.0
11+
url: oauth-2.0-html

‎docs/_layouts/default.html

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<!doctype html>
2+
<html lang="{{ site.lang | default: "en-US" }}">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
7+
{% seo %}
8+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
9+
<script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
10+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<![endif]-->
14+
</head>
15+
<body>
16+
<div class="wrapper">
17+
<header>
18+
<h1 class="header">{{ site.title | default: site.github.repository_name }}</h1>
19+
20+
{% for entry in site.data.navigation.toc %}
21+
<a href="{{ entry.url }}">{{ entry.page }}</a><br/>
22+
{% endfor %}
23+
<br/>
24+
25+
<ul>
26+
{% if site.show_downloads %}
27+
<li class="download"><a class="buttons" href="{{ site.github.zip_url }}">Download ZIP</a></li>
28+
<li class="download"><a class="buttons" href="{{ site.github.tar_url }}">Download TAR</a></li>
29+
{% endif %}
30+
<li><a class="buttons github" href="{{ site.github.repository_url }}">View On GitHub</a></li>
31+
</ul>
32+
</header>
33+
34+
<section>
35+
{{ content }}
36+
</section>
37+
38+
<footer>
39+
<p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
40+
</footer>
41+
</div>
42+
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
43+
{% if site.google_analytics %}
44+
<script>
45+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
46+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
47+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
48+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
49+
ga('create', '{{ site.google_analytics }}', 'auto');
50+
ga('send', 'pageview');
51+
</script>
52+
{% endif %}
53+
</body>
54+
</html>

‎docs/component-modules.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Component Modules
3+
---
4+
5+
# Component Modules
6+
7+
This libraries is composed of several modules:
8+
9+
## google-oauth-client
10+
11+
Google OAuth Client Library for Java (`google-oauth-client`) is designed to be
12+
compatible with all supported Java platforms, including Android.
13+
14+
## google-oauth-client-appengine
15+
16+
Google App Engine extensions to the Google OAuth Client Library for Java
17+
(`google-oauth-client-appengine`) support Java Google App Engine applications.
18+
This module depends on `google-oauth-client` and `google-oauth-client-servlet`.
19+
20+
## google-oauth-client-java6
21+
22+
Java 6 (and higher) extensions to the Google OAuth Client Library for Java
23+
(`google-oauth-client-java6`) support Java6+ applications. This module depends
24+
on `google-oauth-client`.
25+
26+
## google-oauth-client-jetty
27+
28+
Jetty extensions to the Google OAuth Client Library for Java
29+
(`google-oauth-client-jetty`) support authorization code flow for installed
30+
applications. This module depends on `google-oauth-client-java6`.
31+
32+
## google-oauth-client-servlet
33+
34+
Servlet and JDO extensions to the Google OAuth Client Library for Java
35+
(`google-oauth-client-servlet`) support Java servlet web applications. This
36+
module depends on `google-oauth-client`.

‎docs/index.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Overview
3+
---
4+
5+
# Overview
6+
7+
## Description
8+
9+
Written by Google, the Google OAuth Client Library for Java is a
10+
powerful and easy-to-use Java library for the OAuth 1.0a and OAuth 2.0
11+
authorization standards.
12+
13+
The Google OAuth Client Library for Java is designed to work with any
14+
OAuth service on the web, not just with Google APIs. The library is
15+
built on the [Google HTTP Client Library for Java][google-http-client],
16+
and it supports Java 7 (or higher) standard (SE) and enterprise (EE),
17+
Android 4.0 (or higher), and Google App Engine.
18+
19+
For access to Google APIs, see the
20+
[Google API Client Library for Java][google-api-client].
21+
22+
This is an open-source library, and you can access the
23+
[source on GitHub][google-oauth-client]. [Contributions][contributions] are
24+
welcome.
25+
26+
## Beta Features
27+
28+
Features marked with the `@Beta` annotation at the class or method level
29+
are subject to change. They might be modified in any way, or even removed,
30+
in any major release. You should not use beta features if your code is a
31+
library itself (that is, if your code is used on the `CLASSPATH` of users
32+
outside your own control).
33+
34+
## Deprecated Features
35+
36+
Deprecated non-beta features will be removed eighteen months after the
37+
release in which they are first deprecated. You must fix your usages before
38+
this time. If you don't, any type of breakage might result, and you are not
39+
guaranteed a compilation error.
40+
41+
[google-http-client]: https://github.com/googleapis/google-http-java-client
42+
[google-api-client]: https://github.com/googleapis/google-api-java-client
43+
[google-oauth-client]: https://github.com/googleapis/google-oauth-java-client
44+
[contributions]: https://github.com/googleapis/google-oauth-java-client/blob/master/CONTRIBUTING.md

‎docs/oauth-1.0.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: OAuth 1.0
3+
---
4+
5+
# OAuth 1.0a and the Google OAuth Client Library for Java
6+
7+
[OAuth 1.0][oauth1] is a standard specification for allowing end users to
8+
securely authorize a client application to access protected server-side
9+
resources.
10+
11+
## Important notices
12+
13+
The OAuth 1.0a support provided by the Google OAuth Client Library for Java is
14+
`@Beta`.
15+
16+
Do not use OAuth 1.0 to access Google APIs, because Google has deprecated its
17+
support for OAuth 1.0 in favor of OAuth 2.0. If you currently have an app that
18+
accesses Google APIs using OAuth 1.0, see
19+
[Migrating from OAuth 1.0 to OAuth 2.0][migrating].
20+
21+
## Using OAuth 1.0
22+
23+
The Google OAuth Client Library for Java supports two types of signature methods
24+
for OAuth 1.0a (`@Beta`), which we provide foruse with non-Google services:
25+
26+
* HMAC-SHA1 ([`OAuthHmacSigner`][oauth-hmac-signer])
27+
* RSA-SHA1 ([`OAuthRsaSigner`][oauth-rsa-signer]
28+
29+
For details, see the
30+
[Javadoc for the OAuth 1.0 package][oauth-javadoc].
31+
32+
[oauth1]: http://tools.ietf.org/html/rfc5849
33+
[migrating]: https://developers.google.com/accounts/docs/OAuth_ref#migration
34+
[oauth-hmac-signer]: https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/OAuthHmacSigner.html
35+
[oauth-rsa-signer]: https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/OAuthRsaSigner.html
36+
[oauth-javadoc]: (https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/package-summary.html)

0 commit comments

Comments
 (0)