Package org.restlet.ext.oauth

Deprecated.

Will be removed in next minor release.

Support for OAuth 2.0 HTTP authentication.

See: Description

Interface Summary

Interface	Description
OAuthResourceDefs	Deprecated Will be removed in next minor release.

Class Summary

Class	Description
AccessTokenClientResource	Deprecated Will be removed in next minor release.
AccessTokenServerResource	Deprecated Will be removed in next minor release.
AuthorizationBaseServerResource	Deprecated Will be removed in next minor release.
AuthorizationServerResource	Deprecated Will be removed in next minor release.
AuthPageServerResource	Deprecated Will be removed in next minor release.
ClientVerifier	Deprecated Will be removed in next minor release.
FacebookAccessTokenClientResource	Deprecated Will be removed in next minor release.
HttpOAuthHelper	Deprecated Will be removed in next minor release.
HttpOAuthMacHelper	Deprecated Will be removed in next minor release.
OAuthParameters	Deprecated Will be removed in next minor release.
OAuthProxy	Deprecated Will be removed in next minor release.
OAuthServerResource	Deprecated Will be removed in next minor release.
ProtectedClientResource	Deprecated Will be removed in next minor release.
TokenAuthServerResource	Deprecated Will be removed in next minor release.
TokenVerifier	Deprecated Will be removed in next minor release.

Enum Summary

Enum	Description
GrantType	Deprecated Will be removed in next minor release.
OAuthError	Deprecated Will be removed in next minor release.
ResponseType	Deprecated Will be removed in next minor release.

Exception Summary

Exception	Description
OAuthException	Deprecated Will be removed in next minor release.

Package org.restlet.ext.oauth Description

Support for OAuth 2.0 HTTP authentication. This is intended to be used with primarily following use-cases in mind:

• Create a protected resource
• Create a authenticating server
• Create a web client accessing protected resources

It is very simple to create an OAuth server with just a few lines of code. It is also possible to implement a custom back end for data storage and retrieval. The default implementation stores only to memory, so a JVM restart flushes all data.

{
  @code
  public Restlet createInboundRoot(){
    ...
    OAuthAuthorizer auth = new OAuthAuthorizer(
      "http://localhost:8080/OAuth2Provider/validate");
    auth.setNext(ProtectedResource.class);
    router.attach("/me", auth);
    ...
  }
}

Example 1. Creating a Protected Resource

{
  @code
  OAuthParameter params = new OAuthParameters("clientId", "clientSecret",
    oauthURL, "scope1 scope2");
    OAuthProxy proxy = new OauthProxy(params, getContext(), true);
    proxy.setNext(DummyResource.class);
    router.attach("/write", write);
     
    //A Slightly more advanced example that also sets some SSL client parameters
    Client client = new Client(Protocol.HTTPS);
    Context c = new Context();
    client.setContext(c);
    c.getParameters().add("truststorePath", "pathToKeyStoreFile");
    c.getParameters(0.add("truststorePassword", "password");
    OAuthParameter params = new OAuthParameters("clientId", "clientSecret",
    oauthURL, "scope1 scope2");
    OAuthProxy proxy = new OauthProxy(params, getContext(), true, client);
    proxy.setNext(DummyResource.class);
    router.attach("/write", write);   
}

Example 2. Creating a Proxies to access protected resources

Since:

Restlet 2.1

Author:

Kristoffer Gronowski, Martin Svensson

See Also:

OAuth, OAuth 2 draft 10, User Guide - OAuth extension