com.nimbusds.oauth2.sdk.RefreshTokenGrant Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* oauth2-oidc-sdk
*
* Copyright 2012-2016, Connect2id Ltd and contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package com.nimbusds.oauth2.sdk;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import com.nimbusds.oauth2.sdk.util.MultivaluedMapUtils;
import net.jcip.annotations.Immutable;
import com.nimbusds.oauth2.sdk.token.RefreshToken;
/**
* Refresh token grant. Used in refresh token requests.
*
* Note that the optional scope parameter is not supported.
*
*
Related specifications:
*
*
* - OAuth 2.0 (RFC 6749), section 6.
*
*/
@Immutable
public class RefreshTokenGrant extends AuthorizationGrant {
/**
* The grant type.
*/
public static final GrantType GRANT_TYPE = GrantType.REFRESH_TOKEN;
/**
* The refresh token.
*/
private final RefreshToken refreshToken;
/**
* Creates a new refresh token grant.
*
* @param refreshToken The refresh token. Must not be {@code null}.
*/
public RefreshTokenGrant(final RefreshToken refreshToken) {
super(GRANT_TYPE);
if (refreshToken == null)
throw new IllegalArgumentException("The refresh token must not be null");
this.refreshToken = refreshToken;
}
/**
* Gets the refresh token.
*
* @return The refresh token.
*/
public RefreshToken getRefreshToken() {
return refreshToken;
}
@Override
public Map> toParameters() {
Map> params = new LinkedHashMap<>();
params.put("grant_type", Collections.singletonList(GRANT_TYPE.getValue()));
params.put("refresh_token", Collections.singletonList(refreshToken.getValue()));
return params;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RefreshTokenGrant grant = (RefreshTokenGrant) o;
return refreshToken.equals(grant.refreshToken);
}
@Override
public int hashCode() {
return refreshToken.hashCode();
}
/**
* Parses a refresh token grant from the specified request body
* parameters.
*
* Example:
*
*
* grant_type=refresh_token
* refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
*
*
* @param params The parameters.
*
* @return The refresh token grant.
*
* @throws ParseException If parsing failed.
*/
public static RefreshTokenGrant parse(final Map> params)
throws ParseException {
// Parse grant type
String grantTypeString = MultivaluedMapUtils.getFirstValue(params, "grant_type");
if (grantTypeString == null) {
String msg = "Missing \"grant_type\" parameter";
throw new ParseException(msg, OAuth2Error.INVALID_REQUEST.appendDescription(": " + msg));
}
if (! GrantType.parse(grantTypeString).equals(GRANT_TYPE)) {
String msg = "The \"grant_type\" must be \"" + GRANT_TYPE + "\"";
throw new ParseException(msg, OAuth2Error.UNSUPPORTED_GRANT_TYPE.appendDescription(": " + msg));
}
// Parse refresh token
String refreshTokenString = MultivaluedMapUtils.getFirstValue(params, "refresh_token");
if (refreshTokenString == null || refreshTokenString.trim().isEmpty()) {
String msg = "Missing or empty \"refresh_token\" parameter";
throw new ParseException(msg, OAuth2Error.INVALID_REQUEST.appendDescription(": " + msg));
}
RefreshToken refreshToken = new RefreshToken(refreshTokenString);
return new RefreshTokenGrant(refreshToken);
}
}