org.pac4j.cas.profile.CasProxyProfile Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pac4j-cas Show documentation

There is a newer version: 6.1.0

package org.pac4j.cas.profile;

import lombok.EqualsAndHashCode;
import lombok.val;
import org.apereo.cas.client.authentication.AttributePrincipal;

import java.io.Serial;

/**
 * This class is the user profile for sites using CAS protocol with proxy capabilities.
 * It is returned by the {@link org.pac4j.cas.client.CasClient} coupled with the {@link org.pac4j.cas.client.CasProxyReceptor}.
 * After the CAS principal has been set through the {@link #setPrincipal(AttributePrincipal)} method, proxy tickets can be retrieved for
 * various CAS services by using the {@link #getProxyTicketFor(String)} method.
 *
 * @see org.pac4j.cas.client.CasClient
 * @see org.pac4j.cas.client.CasProxyReceptor
 * @author Jerome Leleu
 * @since 1.4.0
 */
@EqualsAndHashCode(callSuper = true)
public class CasProxyProfile extends CasProfile {

    @Serial
    private static final long serialVersionUID = 4956675835922254493L;

    protected AttributePrincipal attributePrincipal = null;

    /**
     * Store the CAS principal.
     *
     * @param attributePrincipal the principal with attributes
     */
    public void setPrincipal(final AttributePrincipal attributePrincipal) {
        this.attributePrincipal = attributePrincipal;
    }

    /**
     * Get a proxy ticket for a given service.
     *
     * @param service the CAS service
     * @return the proxy ticket for the given service
     */
    public String getProxyTicketFor(final String service) {
        if (this.attributePrincipal != null) {
            logger.debug("Requesting PT from principal: {} and for service: {}", attributePrincipal, service);
            val pt = this.attributePrincipal.getProxyTicketFor(service);
            logger.debug("Get PT: {}", pt);
            return pt;
        }
        return null;
    }
}