105 lines
3.5 KiB
Java
Executable file
105 lines
3.5 KiB
Java
Executable file
package org.keycloak.authentication;
|
|
|
|
import org.keycloak.login.LoginFormsProvider;
|
|
import org.keycloak.models.ClientSessionModel;
|
|
import org.keycloak.models.UserModel;
|
|
import org.keycloak.models.UserSessionModel;
|
|
import org.keycloak.models.utils.FormMessage;
|
|
|
|
import java.net.URI;
|
|
|
|
/**
|
|
* This interface encapsulates information about an execution in an AuthenticationFlow. It is also used to set
|
|
* the status of the execution being performed.
|
|
*
|
|
*
|
|
* @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
|
|
* @version $Revision: 1 $
|
|
*/
|
|
public interface AuthenticationFlowContext extends AbstractAuthenticationFlowContext {
|
|
|
|
/**
|
|
* Current user attached to this flow. It can return null if no user has been identified yet
|
|
*
|
|
* @return
|
|
*/
|
|
UserModel getUser();
|
|
|
|
/**
|
|
* Attach a specific user to this flow.
|
|
*
|
|
* @param user
|
|
*/
|
|
void setUser(UserModel user);
|
|
|
|
void attachUserSession(UserSessionModel userSession);
|
|
|
|
|
|
/**
|
|
* ClientSessionModel attached to this flow
|
|
*
|
|
* @return
|
|
*/
|
|
ClientSessionModel getClientSession();
|
|
|
|
/**
|
|
* Create a Freemarker form builder that presets the user, action URI, and a generated access code
|
|
*
|
|
* @return
|
|
*/
|
|
LoginFormsProvider form();
|
|
|
|
/**
|
|
* Get the action URL for the required action.
|
|
*
|
|
* @param code client session access code
|
|
* @return
|
|
*/
|
|
URI getActionUrl(String code);
|
|
|
|
/**
|
|
* Get the action URL for the required action. This auto-generates the access code.
|
|
*
|
|
* @return
|
|
*/
|
|
URI getActionUrl();
|
|
|
|
/**
|
|
* End the flow and redirect browser based on protocol specific respones. This should only be executed
|
|
* in browser-based flows.
|
|
*
|
|
*/
|
|
void cancelLogin();
|
|
|
|
/**
|
|
* Fork the current flow. The client session will be cloned and set to point at the realm's browser login flow. The Response will be the result
|
|
* of this fork. The previous flow will still be set at the current execution. This is used by reset password when it sends an email.
|
|
* It sends an email linking to the current flow and redirects the browser to a new browser login flow.
|
|
*
|
|
*
|
|
*
|
|
* @return
|
|
*/
|
|
void fork();
|
|
|
|
/**
|
|
* Fork the current flow. The client session will be cloned and set to point at the realm's browser login flow. The Response will be the result
|
|
* of this fork. The previous flow will still be set at the current execution. This is used by reset password when it sends an email.
|
|
* It sends an email linking to the current flow and redirects the browser to a new browser login flow.
|
|
*
|
|
* This method will set up a success message that will be displayed in the first page of the new flow
|
|
*
|
|
* @param message Corresponds to raw text or a message property defined in a message bundle
|
|
*/
|
|
void forkWithSuccessMessage(FormMessage message);
|
|
/**
|
|
* Fork the current flow. The client session will be cloned and set to point at the realm's browser login flow. The Response will be the result
|
|
* of this fork. The previous flow will still be set at the current execution. This is used by reset password when it sends an email.
|
|
* It sends an email linking to the current flow and redirects the browser to a new browser login flow.
|
|
*
|
|
* This method will set up an error message that will be displayed in the first page of the new flow
|
|
*
|
|
* @param message Corresponds to raw text or a message property defined in a message bundle
|
|
*/
|
|
void forkWithErrorMessage(FormMessage message);
|
|
}
|