SAMLMessageContextAuthenticationFunction (OpenSAML :: SAML Provider API 4.0.0 API)

java.lang.Object
- org.opensaml.saml.common.messaging.context.navigate.SAMLMessageContextAuthenticationFunction

All Implemented Interfaces:

Function<org.opensaml.messaging.context.MessageContext,Boolean>
```
public class SAMLMessageContextAuthenticationFunction
extends Object
implements Function<org.opensaml.messaging.context.MessageContext,Boolean>
```
Function that returns the authenticated state of a configured AbstractAuthenticatableSAMLEntityContext, defaulting to SAMLPeerEntityContext.

Field Summary

Fields
Modifier and Type	Field	Description
`private Class<? extends AbstractAuthenticatableSAMLEntityContext>`	`entityContextClass`	The context class representing the authenticatable SAML entity.

Constructor Summary

Constructors
Constructor Description

SAMLMessageContextAuthenticationFunction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`apply(org.opensaml.messaging.context.MessageContext input)`
`void`	`setEntityContextClass(Class<? extends AbstractAuthenticatableSAMLEntityContext> clazz)`	Set the class type holding the authenticatable SAML entity data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, compose

- Field Detail
  - entityContextClass
```
@Nonnull
private Class<? extends AbstractAuthenticatableSAMLEntityContext> entityContextClass
```
    The context class representing the authenticatable SAML entity. Defaults to: SAMLPeerEntityContext.
- Constructor Detail
  - SAMLMessageContextAuthenticationFunction
```
public SAMLMessageContextAuthenticationFunction()
```
- Method Detail
  - setEntityContextClass
```
public void setEntityContextClass(@Nonnull
                                  Class<? extends AbstractAuthenticatableSAMLEntityContext> clazz)
```
    Set the class type holding the authenticatable SAML entity data.
    Defaults to: SAMLPeerEntityContext.
    
    Parameters:
    
    clazz - the entity context class type
  - apply
```
@Nullable
public Boolean apply(@Nullable
                     org.opensaml.messaging.context.MessageContext input)
```
    Specified by:
    
    apply in interface Function<org.opensaml.messaging.context.MessageContext,Boolean>