de.otto:oauth-token-filter

A OAuth Token Filter for JAX-RS clients

License	Apache License, Version 2.0
GroupId	de.otto
ArtifactId	oauth-token-filter
Last Version	1.0.3
Release Date	Jun 6, 2019
Type	jar
Description	de.otto:oauth-token-filter A OAuth Token Filter for JAX-RS clients
Project URL	https://github.com/otto-de/oauth-token-filter
Source Code Management	https://github.com/otto-de/oauth-token-filter/tree/master/

Download oauth-token-filter

Filename	Size
oauth-token-filter-1.0.3.pom
oauth-token-filter-1.0.3.jar	6 KB
oauth-token-filter-1.0.3-sources.jar	2 KB
oauth-token-filter-1.0.3-javadoc.jar	35 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/de.otto/oauth-token-filter/ -->
<dependency>
    <groupId>de.otto</groupId>
    <artifactId>oauth-token-filter</artifactId>
    <version>1.0.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/de.otto/oauth-token-filter/
implementation 'de.otto:oauth-token-filter:1.0.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/de.otto/oauth-token-filter/
implementation ("de.otto:oauth-token-filter:1.0.3")

Apache Buildr

'de.otto:oauth-token-filter:jar:1.0.3'

Apache Ivy

<dependency org="de.otto" name="oauth-token-filter" rev="1.0.3">
  <artifact name="oauth-token-filter" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='de.otto', module='oauth-token-filter', version='1.0.3')
)

Scala SBT

libraryDependencies += "de.otto" % "oauth-token-filter" % "1.0.3"

Leiningen

[de.otto/oauth-token-filter "1.0.3"]

Dependencies

compile (2)

Group / Artifact	Type	Version
javax.ws.rs : javax.ws.rs-api	jar	2.1.1
org.glassfish : javax.json Optional	jar	1.0.4

test (3)

Group / Artifact	Type	Version
junit : junit	jar	4.12
org.assertj : assertj-core	jar	3.8.0
org.mockito : mockito-core	jar	2.23.4

Project Modules

There are no modules declared in this project.

OAuthTokenFilter

The OAuthTokenFilter is a JAX-RS client filter that handles OAuth2 authorization. It

• filters your requests to a service,
• adds a OAuth2-Token to your requests,
• stores the token,
• checks the token for validity
• and refreshes the token when necessary.

Installing / Getting started

To include the OAuthTokenFilter in your project, simply add it as a Maven Dependency.

<dependency>
  <groupId>de.otto.oauthtokenfilter</groupId>
  <artifactId>oauth-token-filter</artifactId>
  <version>2.0.1</version>
</dependency>

Initial Configuration

Upon using your ClientBuilder, call

import de.otto.oauthtokenfilter.OAuthTokenFilter;
import jakarta.ws.rs.client.ClientBuilder;
...

ClientBuilder.newBuilder()
 .register(OAuthTokenFilter.builder()
   .username("<yourUsername>")
    .password("<yourPassword>")
    .loginurl("<yourLoginURL>")
    .clientId("<yourClientId>")
    .clientSecret("<yourClientSecret>")
    .tokenLifetimeInSeconds("<yourTokenLifetimeInSeconds>")
    .grant_type("<api_grant_type>")    
    .client(ClientBuilder.newClient());    
    .build())
  .build();

After that, all requests generated by that client will have the proper Authorization Header generated. If the OAuth-server you're working with doesn't need certain values, you can simply leave them out. If you do not specify "grant_type", it will default to "password".

Developing

If you'd like to work on the project, you can do so by running:

git clone https://github.com/otto-de/oauth-token-filter.git

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

Please follow Google Style formatting.

License

The code in this project is licensed under Apache 2.0 license.

OTTO (GmbH & Co. KG)

Versions

Version
1.0.3 Jun 6, 2019
1.0.2 May 29, 2019
1.0.1 May 28, 2019