com.inrupt.client.spring.SessionUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inrupt-client-spring Show documentation
Integration utilities for Spring support.
The newest version!
/*
 * Copyright Inrupt Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
 * Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package com.inrupt.client.spring;

import com.inrupt.client.auth.Session;
import com.inrupt.client.openid.OpenIdSession;

import java.time.Instant;
import java.util.Optional;
import java.util.function.Function;

import org.springframework.security.oauth2.core.oidc.user.OidcUser;
import org.springframework.security.oauth2.core.user.OAuth2User;

/**
 * A utility class for converting Spring constructs into session objects for use with the Java Client libraries.
 */
public final class SessionUtils {

    /**
     * Convert a Spring {@link OAuth2User} to a {@link Session} object.
     *
     * This method uses the {@link OpenIdSession} library to create a Session
     *
     * @param user the Spring user object
     * @return the session, if present and unexpired
     */
    public static Optional asSession(final OAuth2User user) {
        return asSession(user, OpenIdSession::ofIdToken);
    }

    /**
     * Convert a Spring {@link OAuth2User} to a {@link Session} object.
     *
     * @param user the Spring user object
     * @param mapping a mapping function for creating a Session from an ID token
     * @return the session, if present and unexpired
     */
    public static Optional asSession(final OAuth2User user, final Function mapping) {
        if (user instanceof OidcUser) {
            final var oidc = (OidcUser) user;
            final var token = oidc.getIdToken();
            if (Instant.now().isBefore(token.getExpiresAt())) {
                return Optional.ofNullable(mapping.apply(token.getTokenValue()));
            }
        }
        return Optional.empty();
    }

    private SessionUtils() {
        // Prevent instantiation
    }
}