ExtractUserAgentAddress (Shibboleth Identity Provider 4.3.4-SNAPSHOT API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.profile.action.AbstractProfileAction
  - - org.opensaml.profile.action.AbstractConditionalProfileAction
    - - net.shibboleth.idp.profile.AbstractProfileAction
      - net.shibboleth.idp.authn.AbstractAuthenticationAction
        
        net.shibboleth.idp.authn.AbstractExtractionAction
        
        net.shibboleth.idp.authn.impl.ExtractUserAgentAddress

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action
```
public class ExtractUserAgentAddress
extends AbstractExtractionAction
```
An action that extracts the user-agent's IP address from the incoming request, creates a UserAgentContext, and attaches it to the AuthenticationContext.
Event:

EventIds.PROCEED_EVENT_ID, AuthnEventIds.NO_CREDENTIALS

Precondition:
```
ProfileRequestContext.getSubcontext(AuthenticationContext.class, false) != null
```
Postcondition:

If getHttpServletRequest() != null, the content of getRemoteAddr() will be attached via a UserAgentContext, provided it is a valid IP address.

Field Summary

Fields
Modifier and Type Field Description

private org.slf4j.Logger log
Class logger.

Constructor Summary

Constructors
Constructor Description

ExtractUserAgentAddress()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)`	Performs this authentication action.

Methods inherited from class net.shibboleth.idp.authn.AbstractExtractionAction
applyTransforms, setLowercase, setTransforms, setTrim, setUppercase

Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction
doExecute, doPreExecute, doPreExecute, setAuthenticationContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction
doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction
getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized

- Field Detail
  - log
```
@Nonnull
private final org.slf4j.Logger log
```
    Class logger.
- Constructor Detail
  - ExtractUserAgentAddress
```
public ExtractUserAgentAddress()
```
- Method Detail
  - doExecute
```
protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext,
                         @Nonnull
                         AuthenticationContext authenticationContext)
```
    Performs this authentication action. Default implementation throws an exception.
    
    Overrides:
    
    doExecute in class AbstractAuthenticationAction
    
    Parameters:
    
    profileRequestContext - the current IdP profile request context
    
    authenticationContext - the current authentication context