Skip to content
Permalink
Browse files

docs: move wiki to docs area (#386)

  • Loading branch information
chingor13 committed Oct 22, 2019
1 parent 41bab65 commit ee7e98b187251f1031863ad02790bf37a65b5691
Showing with 733 additions and 0 deletions.
  1. +2 −0 docs/_config.yml
  2. +11 −0 docs/_data/navigation.yml
  3. +54 −0 docs/_layouts/default.html
  4. +36 −0 docs/component-modules.md
  5. +44 −0 docs/index.md
  6. +36 −0 docs/oauth-1.0.md
  7. +471 −0 docs/oauth-2.0.md
  8. +79 −0 docs/setup.md
@@ -0,0 +1,2 @@
theme: jekyll-theme-dinky
title: Google OAuth Client for Java
@@ -0,0 +1,11 @@
toc:
- page: Overview
url: index.html
- page: Setup Instructions
url: setup.html
- page: Component Modules
url: component-modules.html
- page: OAuth 1.0
url: oauth-1.0.html
- page: OAuth 2.0
url: oauth-2.0-html
@@ -0,0 +1,54 @@
<!doctype html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">

{% seo %}
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
<script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1 class="header">{{ site.title | default: site.github.repository_name }}</h1>

{% for entry in site.data.navigation.toc %}
<a href="{{ entry.url }}">{{ entry.page }}</a><br/>
{% endfor %}
<br/>

<ul>
{% if site.show_downloads %}
<li class="download"><a class="buttons" href="{{ site.github.zip_url }}">Download ZIP</a></li>
<li class="download"><a class="buttons" href="{{ site.github.tar_url }}">Download TAR</a></li>
{% endif %}
<li><a class="buttons github" href="{{ site.github.repository_url }}">View On GitHub</a></li>
</ul>
</header>

<section>
{{ content }}
</section>

<footer>
<p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
</footer>
</div>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
{% if site.google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google_analytics }}', 'auto');
ga('send', 'pageview');
</script>
{% endif %}
</body>
</html>
@@ -0,0 +1,36 @@
---
title: Component Modules
---

# Component Modules

This libraries is composed of several modules:

## google-oauth-client

Google OAuth Client Library for Java (`google-oauth-client`) is designed to be
compatible with all supported Java platforms, including Android.

## google-oauth-client-appengine

Google App Engine extensions to the Google OAuth Client Library for Java
(`google-oauth-client-appengine`) support Java Google App Engine applications.
This module depends on `google-oauth-client` and `google-oauth-client-servlet`.

## google-oauth-client-java6

Java 6 (and higher) extensions to the Google OAuth Client Library for Java
(`google-oauth-client-java6`) support Java6+ applications. This module depends
on `google-oauth-client`.

## google-oauth-client-jetty

Jetty extensions to the Google OAuth Client Library for Java
(`google-oauth-client-jetty`) support authorization code flow for installed
applications. This module depends on `google-oauth-client-java6`.

## google-oauth-client-servlet

Servlet and JDO extensions to the Google OAuth Client Library for Java
(`google-oauth-client-servlet`) support Java servlet web applications. This
module depends on `google-oauth-client`.
@@ -0,0 +1,44 @@
---
title: Overview
---

# Overview

## Description

Written by Google, the Google OAuth Client Library for Java is a
powerful and easy-to-use Java library for the OAuth 1.0a and OAuth 2.0
authorization standards.

The Google OAuth Client Library for Java is designed to work with any
OAuth service on the web, not just with Google APIs. The library is
built on the [Google HTTP Client Library for Java][google-http-client],
and it supports Java 7 (or higher) standard (SE) and enterprise (EE),
Android 4.0 (or higher), and Google App Engine.

For access to Google APIs, see the
[Google API Client Library for Java][google-api-client].

This is an open-source library, and you can access the
[source on GitHub][google-oauth-client]. [Contributions][contributions] are
welcome.

## Beta Features

Features marked with the `@Beta` annotation at the class or method level
are subject to change. They might be modified in any way, or even removed,
in any major release. You should not use beta features if your code is a
library itself (that is, if your code is used on the `CLASSPATH` of users
outside your own control).

## Deprecated Features

Deprecated non-beta features will be removed eighteen months after the
release in which they are first deprecated. You must fix your usages before
this time. If you don't, any type of breakage might result, and you are not
guaranteed a compilation error.

[google-http-client]: https://github.com/googleapis/google-http-java-client
[google-api-client]: https://github.com/googleapis/google-api-java-client
[google-oauth-client]: https://github.com/googleapis/google-oauth-java-client
[contributions]: https://github.com/googleapis/google-oauth-java-client/blob/master/CONTRIBUTING.md
@@ -0,0 +1,36 @@
---
title: OAuth 1.0
---

# OAuth 1.0a and the Google OAuth Client Library for Java

[OAuth 1.0][oauth1] is a standard specification for allowing end users to
securely authorize a client application to access protected server-side
resources.

## Important notices

The OAuth 1.0a support provided by the Google OAuth Client Library for Java is
`@Beta`.

Do not use OAuth 1.0 to access Google APIs, because Google has deprecated its
support for OAuth 1.0 in favor of OAuth 2.0. If you currently have an app that
accesses Google APIs using OAuth 1.0, see
[Migrating from OAuth 1.0 to OAuth 2.0][migrating].

## Using OAuth 1.0

The Google OAuth Client Library for Java supports two types of signature methods
for OAuth 1.0a (`@Beta`), which we provide foruse with non-Google services:

* HMAC-SHA1 ([`OAuthHmacSigner`][oauth-hmac-signer])
* RSA-SHA1 ([`OAuthRsaSigner`][oauth-rsa-signer]

For details, see the
[Javadoc for the OAuth 1.0 package][oauth-javadoc].

[oauth1]: http://tools.ietf.org/html/rfc5849
[migrating]: https://developers.google.com/accounts/docs/OAuth_ref#migration
[oauth-hmac-signer]: https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/OAuthHmacSigner.html
[oauth-rsa-signer]: https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/OAuthRsaSigner.html
[oauth-javadoc]: (https://googleapis.dev/java/google-oauth-client/latest/com/google/api/client/auth/oauth/package-summary.html)

0 comments on commit ee7e98b

Please sign in to comment.
You can’t perform that action at this time.