Package se.curity.identityserver.sdk.haapi.polling

Interface PendingActions

All Known Subinterfaces:

PendingPollingConfigurator

public interface PendingActions

Builder interface to add content to a pending polling step.

Since:

5.4.0

Method Summary

Modifier and Type	Method	Description
void	addClientOperationAction(ActionKind kind, OperationName name, @Nullable Message title, Consumer<? super ClientOperationActionConfigurator> builder)	Adds a client operation action, which instructs the client to perform the operation identified by name.
void	setCancelFormAction(URI href, HttpMethod method, @Nullable MediaType type, @Nullable Message title, @Nullable Message actionTitle, Consumer<? super FormActionFields> builder)	Adds a cancel action, which is the representation of the HTTP request to cancel the polling operation.
default void	setPollFormAction(URI href)	Adds a poll action, which is the representation of the HTTP request to check the polling status.
void	setPollFormAction(URI href, HttpMethod method, @Nullable MediaType type, @Nullable Message title, Consumer<? super FormActionHiddenFields> builder)	Adds a poll action, which is the representation of the HTTP request to check the polling status.

Method Details

setPollFormAction

default void setPollFormAction(URI href)

Adds a poll action, which is the representation of the HTTP request to check the polling status.

The poll action will use the GET HTTP method for polling. If that's not desired use setPollFormAction(URI, HttpMethod, MediaType, Message, Consumer) instead.

Parameters:

href - The HTTP request target URI.

setPollFormAction

void setPollFormAction(URI href,
 HttpMethod method,
 @Nullable MediaType type,
 @Nullable Message title,
 Consumer<? super FormActionHiddenFields> builder)

Adds a poll action, which is the representation of the HTTP request to check the polling status.

Parameters:

href - The HTTP request target URI.

method - The HTTP request method.

type - The media type to use in the request payload.

title - The action title.

builder - Builder to add hidden fields to the polling action.

setCancelFormAction

void setCancelFormAction(URI href,
 HttpMethod method,
 @Nullable MediaType type,
 @Nullable Message title,
 @Nullable Message actionTitle,
 Consumer<? super FormActionFields> builder)

Adds a cancel action, which is the representation of the HTTP request to cancel the polling operation.

Parameters:

href - The HTTP request target URI.

method - The HTTP request method.

type - The media type to use in the request payload.

title - The action title.

actionTitle - The action submit title.

builder - Builder to add fields to the form.

addClientOperationAction

void addClientOperationAction(ActionKind kind,
 OperationName name,
 @Nullable Message title,
 Consumer<? super ClientOperationActionConfigurator> builder)

Adds a client operation action, which instructs the client to perform the operation identified by name.

Clients must know which steps are needed to perform specific operations, which may include launching an external application, opening a browser window or interacting with platform-specific APIs. Operations may require parameters, which can be added to the action representation.

A client operation action should include continuation actions, allowing the client to continue the authentication process after the operation is completed.

Parameters:

kind - the action kind.

name - the operation name.

title - the action title.

builder - a builder allowing the addition of the action content, namely the operation parameters.

Since:

7.0.0