io.jooby.pac4j.Pac4jOptions Maven / Gradle / Ivy
/*
* Jooby https://jooby.io
* Apache License Version 2.0 https://jooby.io/LICENSE.txt
* Copyright 2014 Edgar Espina
*/
package io.jooby.pac4j;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import io.jooby.SameSite;
/**
* Options to configure pac4j security, callback and logout actions.
*
* If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
* please consider to set {@link io.jooby.Router#setTrustProxy(boolean)} option.
*
* @author edgar
* @since 2.4.0
*/
public class Pac4jOptions {
private String defaultUrl;
private Boolean saveInSession;
private Boolean multiProfile;
private Boolean renewSession;
private String defaultClient;
private String callbackPath = "/callback";
private String logoutPath = "/logout";
private boolean localLogout = true;
private boolean destroySession = true;
private boolean centralLogout;
private SameSite cookieSameSite;
private boolean forceCallbackRoutes = false;
private boolean forceLogoutRoutes = false;
/**
* Default url to redirect to after successful login. Used by {@link
* org.pac4j.core.engine.CallbackLogic}.
*
* @return Default url.
*/
public @Nullable String getDefaultUrl() {
return defaultUrl;
}
/**
* Set default url to redirect to after successful login.
*
* @param defaultUrl Default url to redirect to after successful login.
* @return This options.
*/
public @NonNull Pac4jOptions setDefaultUrl(@Nullable String defaultUrl) {
this.defaultUrl = defaultUrl;
return this;
}
/**
* True to save profile/user data into session. Default is true for indirect clients. Used by
* {@link org.pac4j.core.engine.CallbackLogic}.
*
* @return True to save profile/user data into session. Default is true for indirect clients.
*/
public @Nullable Boolean getSaveInSession() {
return saveInSession;
}
/**
* Set whenever profile/data must be save in HTTP session.
*
* @param saveInSession True to save profile in HTTP session.
* @return This session.
*/
public @NonNull Pac4jOptions setSaveInSession(@Nullable Boolean saveInSession) {
this.saveInSession = saveInSession;
return this;
}
/**
* Whether multi profiles are supported. Used by {@link org.pac4j.core.engine.CallbackLogic}.
*
* @return Whether multi profiles are supported.
*/
public @Nullable Boolean getMultiProfile() {
return multiProfile;
}
/**
* Set Whether multi profiles are supported.
*
* @param multiProfile Whether multi profiles are supported.
* @return This options.
*/
public @NonNull Pac4jOptions setMultiProfile(@Nullable Boolean multiProfile) {
this.multiProfile = multiProfile;
return this;
}
/**
* Whether the session must be renewed. Used by {@link org.pac4j.core.engine.CallbackLogic}.
*
* @return Whether the session must be renewed.
*/
public @Nullable Boolean getRenewSession() {
return renewSession;
}
/**
* Set whether the session must be renewed.
*
* @param renewSession whether the session must be renewed.
* @return This options.
*/
public @NonNull Pac4jOptions setRenewSession(@Nullable Boolean renewSession) {
this.renewSession = renewSession;
return this;
}
/**
* Default client to use. Used by {@link org.pac4j.core.engine.CallbackLogic}.
*
* @return Default client to use.
*/
public @Nullable String getDefaultClient() {
return defaultClient;
}
/**
* Set default client to use.
*
* @param defaultClient Default client to use.
* @return This options.
*/
public @NonNull Pac4jOptions setDefaultClient(@Nullable String defaultClient) {
this.defaultClient = defaultClient;
return this;
}
/**
* Callback path, defaults to /callback. Used by {@link
* org.pac4j.core.engine.CallbackLogic}.
*
* @return Callback path, defaults to /callback.
*/
public @NonNull String getCallbackPath() {
return callbackPath;
}
/**
* Set callback path.
*
* @param callbackPath Callback path.
* @return This options.
*/
public @NonNull Pac4jOptions setCallbackPath(@NonNull String callbackPath) {
this.callbackPath = callbackPath;
return this;
}
/**
* Callback path, defaults to /logout. Used by {@link
* org.pac4j.core.engine.LogoutLogic}.
*
* @return Logout path, defaults to /logout.
*/
public @NonNull String getLogoutPath() {
return logoutPath;
}
/**
* Set logout path.
*
* @param logoutPath Logout path.
* @return This options.
*/
public @NonNull Pac4jOptions setLogoutPath(@NonNull String logoutPath) {
this.logoutPath = logoutPath;
return this;
}
/**
* Local logout option. Defaults: true. Used by {@link org.pac4j.core.engine.LogoutLogic}.
*
* @return Local logout option.
*/
public boolean isLocalLogout() {
return localLogout;
}
/**
* Set logout option.
*
* @param localLogout Logout option.
* @return This options.
*/
public @NonNull Pac4jOptions setLocalLogout(boolean localLogout) {
this.localLogout = localLogout;
return this;
}
/**
* Central logout option. Defaults: false. Used by {@link org.pac4j.core.engine.LogoutLogic}.
*
* @return Central logout option.
*/
public boolean isCentralLogout() {
return centralLogout;
}
/**
* Set central logout option.
*
* @param centralLogout Central logout option.
* @return This options.
*/
public @NonNull Pac4jOptions setCentralLogout(boolean centralLogout) {
this.centralLogout = centralLogout;
return this;
}
/**
* Whether to destroy session after logout. Defaults: true. Used by {@link
* org.pac4j.core.engine.LogoutLogic}.
*
* @return Whether to destroy session after logout.
*/
public boolean isDestroySession() {
return destroySession;
}
/**
* Set destroy session logout option.
*
* @param destroySession Destroy session option.
* @return This options.
*/
public @NonNull Pac4jOptions setDestroySession(boolean destroySession) {
this.destroySession = destroySession;
return this;
}
/**
* Returns the 'SameSite' parameter value used for cookies generated by the pac4j security engine.
*
* @return An instance of {@link SameSite} or {@code null} if the 'SameSite' parameter should be
* omitted.
*/
@Nullable public SameSite getCookieSameSite() {
return cookieSameSite;
}
/**
* Sets the 'SameSite' parameter value used for cookies generated by the pac4j security engine,
* pass {@code null} to omit the parameter.
*
* @param sameSite Value for the 'SameSite' parameter or {@code null} to omit it.
* @return This options.
*/
public @NonNull Pac4jOptions setCookieSameSite(@Nullable SameSite sameSite) {
cookieSameSite = sameSite;
return this;
}
/**
* The /callback routes are off when pac4j is configured with {@link
* org.pac4j.core.client.DirectClient} clients only. These routes are not required for direct
* clients. Setting this to true will still add the /callback routes.
*
* @return When the callback route is available.
*/
public boolean isForceCallbackRoutes() {
return forceCallbackRoutes;
}
/**
* The /logout routes are off when pac4j is configured with {@link
* org.pac4j.core.client.DirectClient} clients only. These routes are not required for direct
* clients. Setting this to true will still add the /logout routes.
*
* @return When the logout route is available.
*/
public boolean isForceLogoutRoutes() {
return forceLogoutRoutes;
}
public @NonNull Pac4jOptions setForceCallbackRoutes(boolean forceCallbackRoutes) {
this.forceCallbackRoutes = forceCallbackRoutes;
return this;
}
public @NonNull Pac4jOptions setForceLogoutRoutes(boolean forceLogoutRoutes) {
this.forceLogoutRoutes = forceLogoutRoutes;
return this;
}
}