net.shibboleth.idp.admin

Interface AdministrativeFlowDescriptor

All Superinterfaces:

AuthenticationProfileConfiguration, Component, IdentifiedComponent, ProfileConfiguration

All Known Implementing Classes:

BasicAdministrativeFlowDescriptor, OneTimeAdministrativeFlowDescriptor

public interface AdministrativeFlowDescriptor
extends AuthenticationProfileConfiguration

A descriptor for an administrative flow.

Administrative flows are essentially any feature intrinsic to the IdP itself and generally not exposed to external systems using security mechanisms that would involve the more traditional "relying party" machinery and security models. Examples include status reporting and service management features, or user self-service features.

Since:

3.3.0

Method Summary

Methods

Modifier and Type	Method and Description
String	getLoggingId() Get a logging ID to use when auditing this profile.
String	getPolicyName() Get the access control policy for this flow.
UIInfo	getUIInfo() Get the user interface details for this profile.
boolean	isAuthenticated() Get whether user authentication is required (default is false).
boolean	isNonBrowserSupported() Get whether this flow supports non-browser clients (default is true).
boolean	resolveAttributes() Get whether to resolve attributes during the profile (default is false).

Methods inherited from interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

getAuthenticationFlows, getDefaultAuthenticationMethods, getNameIDFormatPrecedence, getPostAuthenticationFlows

Methods inherited from interface net.shibboleth.idp.profile.config.ProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Method Detail

getLoggingId

@Nullable
String getLoggingId()

Get a logging ID to use when auditing this profile.

Returns:

logging ID

isNonBrowserSupported

boolean isNonBrowserSupported()

Get whether this flow supports non-browser clients (default is true).

Returns:

whether this flow supports non-browser clients

isAuthenticated

boolean isAuthenticated()

Get whether user authentication is required (default is false).

Returns:

whether user authentication is required

getUIInfo

@Nullable
UIInfo getUIInfo()

Get the user interface details for this profile.

Returns:

user interface details

getPolicyName

@Nullable
String getPolicyName()

Get the access control policy for this flow.

Returns:

name of access control policy

resolveAttributes

boolean resolveAttributes()

Get whether to resolve attributes during the profile (default is false).

Returns:

whether to resolve attributes during the profile