Package net.officefloor.web.spi.security

Interface HttpSecurityFlowMetaData<F extends Enum<F>>

All Known Implementing Classes:
HttpSecurityFlowMetaDataImpl
public interface HttpSecurityFlowMetaData<F extends Enum<F>>
Describes a Flow required by the HttpSecuritySource.
Author:
Daniel Sagenschneider

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<?>
    getArgumentType()
    Obtains the Class of the argument that is passed to the Flow.
    F
    getKey()
    Obtains the Enum key identifying the application Flow to instigate.
    String
    getLabel()
    Provides a descriptive name for this Flow.

  • Method Details

    • getKey

      F getKey()
      Obtains the Enum key identifying the application Flow to instigate.
      Returns:
      Enum key identifying the application Flow to instigate.

    • getArgumentType

      Class<?> getArgumentType()

      Obtains the Class of the argument that is passed to the Flow.

      This may be null to indicate no argument is passed.

      Returns:
      Type of the argument that is passed to the Flow.

    • getLabel

      String getLabel()
      Provides a descriptive name for this Flow. This is useful to better describe the Flow.
      Returns:
      Descriptive name for this Flow.