com.unboundid.directory.sdk.broker.types

Interface StatusRequest

@NotExtensible
public interface StatusRequest

Represents a status request to be processed by a Server SDK Identity Authenticator.

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.HttpServletRequest	getHttpServletRequest() Retrieve the HTTP servlet request for the request being processed.
ScimResourcePrincipal	getPrincipal() Retrieve the currently authenticated principal or null if not available.
java.lang.String	getStateParameters() Retrieve a JSON object specifying the flow state parameters.

Method Detail

getPrincipal

ScimResourcePrincipal getPrincipal()

Retrieve the currently authenticated principal or null if not available.

Returns:

The currently authenticated principal or null if not available.

getStateParameters

java.lang.String getStateParameters()

Retrieve a JSON object specifying the flow state parameters. Never null. This string can be parsed using any JSON library. For example, Jackson's ObjectMapper.readTree() or the UnboundID LDAP SDK's JSONObject constructor.

Returns:

A JSON object specifying the flow state parameters.

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest()

Retrieve the HTTP servlet request for the request being processed.

Returns:

The HTTP servlet request for the request being processed.