net.krotscheck.kangaroo.authz.common.database.entity.AuthenticatorState Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 Michael Krotscheck
 *
 * 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 net.krotscheck.kangaroo.authz.common.database.entity;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.hibernate.annotations.SortNatural;
import org.hibernate.annotations.Type;

import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.ManyToOne;
import javax.persistence.MapKey;
import javax.persistence.Table;
import javax.persistence.Transient;
import java.net.URI;
import java.util.SortedMap;
import java.util.TreeMap;

/**
 * This entity describes state data stored while an authorization request has
 * been passed to the authentication authenticator. It is retrieved based on
 * the authenticatorState and the authenticatorNonce.
 *
 * @author Michael Krotscheck
 */
@Entity
@Table(name = "authenticator_states")
public final class AuthenticatorState extends AbstractAuthzEntity {

    /**
     * The authenticator for this state.
     */
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "authenticator", nullable = false, updatable = false)
    private Authenticator authenticator;

    /**
     * The client's state.
     */
    @Basic
    @Column(name = "clientState", unique = false)
    private String clientState;

    /**
     * The client's redirect.
     */
    @Basic(optional = false)
    @Column(name = "clientRedirect", unique = false)
    @Type(type = "net.krotscheck.kangaroo.common.hibernate.type.URIType")
    private URI clientRedirect;

    /**
     * List of the requested client scopes.
     */
    @ManyToMany(fetch = FetchType.LAZY)
    @JoinTable(name = "authenticator_state_scopes",
            joinColumns = {
                    @JoinColumn(name = "authenticator_state",
                            nullable = false, updatable = false)},
            inverseJoinColumns = {
                    @JoinColumn(name = "scope",
                            nullable = false, updatable = false)})
    @MapKey(name = "name")
    @SortNatural
    private SortedMap clientScopes = new TreeMap<>();

    /**
     * Get the authenticator for this state.
     *
     * @return This state's authenticator.
     */
    public Authenticator getAuthenticator() {
        return authenticator;
    }

    /**
     * Set a new authenticator.
     *
     * @param authenticator The new authenticator.
     */
    public void setAuthenticator(final Authenticator authenticator) {
        this.authenticator = authenticator;
    }

    /**
     * Get the validated client redirection URI.
     *
     * @return The URI which the client requested a result response to.
     */
    public URI getClientRedirect() {
        return clientRedirect;
    }

    /**
     * Set a new redirection URI.
     *
     * @param clientRedirect The redirection URI.
     */
    public void setClientRedirect(final URI clientRedirect) {
        this.clientRedirect = clientRedirect;
    }

    /**
     * The list of requested application scopes.
     *
     * @return The list of scopes.
     */
    public SortedMap getClientScopes() {
        return clientScopes;
    }

    /**
     * Set the list of client scopes.
     *
     * @param clientScopes A new list of scopes.
     */
    public void setClientScopes(
            final SortedMap clientScopes) {
        this.clientScopes = new TreeMap<>(clientScopes);
    }

    /**
     * Retreive the state received from the client.
     *
     * @return The client's state.
     */
    public String getClientState() {
        return clientState;
    }

    /**
     * The owner of this entity.
     *
     * @return This entity's owner, if it exists.
     */
    @Override
    @Transient
    @JsonIgnore
    public User getOwner() {
        if (authenticator != null) {
            return authenticator.getOwner();
        }
        return null;
    }

    /**
     * Store the state received from the client.
     *
     * @param clientState A new client state.
     */
    public void setClientState(final String clientState) {
        this.clientState = clientState;
    }
}