org.dhatim.dropwizard.jwt.cookie.authentication.JwtCookieAuthConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-jwt-cookie-authentication Show documentation
There is a newer version: 5.1.3
Show newest version
/**
 * Copyright 2020 Dhatim
 * 
 * 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 org.dhatim.dropwizard.jwt.cookie.authentication;

import javax.annotation.Nullable;
import javax.validation.constraints.NotEmpty;

import static org.dhatim.dropwizard.jwt.cookie.authentication.JwtCookieAuthBundle.JWT_COOKIE_DEFAULT_NAME;

/**
 * Bundle configuration class
 */
public class JwtCookieAuthConfiguration {

    private String secretSeed;

    private String cookieName = JWT_COOKIE_DEFAULT_NAME;

    private boolean secure = false;

    private boolean httpOnly = true;

    @Nullable
    private SameSite sameSite = null;

    @Nullable
    private String domain = null;

    @NotEmpty
    private String sessionExpiryVolatile = "PT30m";

    @NotEmpty
    private String sessionExpiryPersistent = "P7d";

    /**
     * The secret seed use to generate the signing key.
     * It can be used to keep the same key value across application reboots.
     *
     * @return the signing key seed
     */
    public String getSecretSeed() {
        return secretSeed;
    }

    /**
     * The name of the cookie holding the JWT. Its default value is "sessionToken".
     *
     * @return the cookie name
     */
    public String getCookieName() {
        return cookieName;
    }

    /**
     * Check if the {@code Secure} cookie attribute is set, as described here.
     *
     * @return {@code true} if the {@code Secure} cookie attribute is set.
     */
    public boolean isSecure() {
        return secure;
    }

    /**
     * Check if the {@code HttpOnly} cookie attribute is set, as described here.
     *
     * @return {@code true} if the {@code HttpOnly} cookie attribute is set.
     */
    public boolean isHttpOnly() {
        return httpOnly;
    }

    /**
     * Duration of cookie, if volatile (in ISO 8601 format).
     *
     * @return the duration of a volatile cookie.
     */
    public String getSessionExpiryVolatile() {
        return sessionExpiryVolatile;
    }

    /**
     * Duration of cookie, if persistent (in ISO 8601 format).
     *
     * @return the duration of a persistent cookie.
     */
    public String getSessionExpiryPersistent() {
        return sessionExpiryPersistent;
    }

    /**
     * {@code SameSite} cookie attribute value, as described here.
     *
     * @return {@code SameSite} cookie attribute value, or {@code null} if not set
     */
    public SameSite getSameSite() {
        return sameSite;
    }

    /**
     * {@code Domain} cookie attribute value, as described here.
     *
     * @return {@code Domain} cookie attribute value, or {@code null} if not set
     */
    public String getDomain() {
        return domain;
    }
}