Class EvidenceDecodePrincipalCallback

java.lang.Object
org.wildfly.security.auth.callback.EvidenceDecodePrincipalCallback
All Implemented Interfaces:
Callback, ExtendedCallback
public class EvidenceDecodePrincipalCallback extends Object implements ExtendedCallback
A server-side Callback to pass the decoded evidence principal from the callback handler to the authentication mechanism.
Since:
1.10.0
Author:
Farah Juma

  • Constructor Summary

    Constructors
    Constructor
    Description
    EvidenceDecodePrincipalCallback(org.wildfly.security.evidence.Evidence evidence)
    Construct a new instance of this Callback.

  • Method Summary

    Modifier and Type
    Method
    Description
    <C extends org.wildfly.security.evidence.Evidence, R>
    R
    applyToEvidence(Class<C> evidenceType, String algorithmName, Function<C,R> function)
    Apply the given function to the acquired evidence, if it is set and of the given type and algorithm.
    <C extends org.wildfly.security.evidence.Evidence, R>
    R
    applyToEvidence(Class<C> evidenceType, Function<C,R> function)
    Apply the given function to the acquired evidence, if it is set and of the given type.
    org.wildfly.security.evidence.Evidence
    getEvidence()
    Get the evidence being decoded.
    <C extends org.wildfly.security.evidence.Evidence>
    C
    getEvidence(Class<C> evidenceType)
    Get the acquired evidence, if it is set and of the given type, and if so, return the evidence cast to the type.
    <C extends org.wildfly.security.evidence.Evidence>
    C
    getEvidence(Class<C> evidenceType, String algorithmName)
    Get the acquired evidence, if it is set and of the given type and algorithm, and if so, return the evidence cast to the type.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface ExtendedCallback

    isOptional, needsInformation

  • Constructor Details

    • EvidenceDecodePrincipalCallback

      public EvidenceDecodePrincipalCallback(org.wildfly.security.evidence.Evidence evidence)
      Construct a new instance of this Callback.
      Parameters:
      evidence - the evidence to be decoded

  • Method Details

    • getEvidence

      public org.wildfly.security.evidence.Evidence getEvidence()
      Get the evidence being decoded.
      Returns:
      the evidence being decoded

    • getEvidence

      public <C extends org.wildfly.security.evidence.Evidence> C getEvidence(Class<C> evidenceType)
      Get the acquired evidence, if it is set and of the given type, and if so, return the evidence cast to the type.
      Type Parameters:
      C - the evidence type
      Parameters:
      evidenceType - the evidence type class (must not be null)
      Returns:
      the evidence, or null if the criteria wasn't met

    • getEvidence

      public <C extends org.wildfly.security.evidence.Evidence> C getEvidence(Class<C> evidenceType, String algorithmName)
      Get the acquired evidence, if it is set and of the given type and algorithm, and if so, return the evidence cast to the type.
      Type Parameters:
      C - the evidence type
      Parameters:
      evidenceType - the evidence type class (must not be null)
      algorithmName - the algorithm name
      Returns:
      the evidence, or null if the criteria are not met

    • applyToEvidence

      public <C extends org.wildfly.security.evidence.Evidence, R> R applyToEvidence(Class<C> evidenceType, Function<C,R> function)
      Apply the given function to the acquired evidence, if it is set and of the given type.
      Type Parameters:
      C - the evidence type
      R - the return type
      Parameters:
      evidenceType - the evidence type class (must not be null)
      function - the function to apply (must not be null)
      Returns:
      the result of the function, or null if the criteria are not met

    • applyToEvidence

      public <C extends org.wildfly.security.evidence.Evidence, R> R applyToEvidence(Class<C> evidenceType, String algorithmName, Function<C,R> function)
      Apply the given function to the acquired evidence, if it is set and of the given type and algorithm.
      Type Parameters:
      C - the evidence type
      R - the return type
      Parameters:
      evidenceType - the evidence type class (must not be null)
      algorithmName - the algorithm name
      function - the function to apply (must not be null)
      Returns:
      the result of the function, or null if the criteria are not met