org.pac4j.http.credentials.extractor

Class IpExtractor

java.lang.Object

org.pac4j.http.credentials.extractor.IpExtractor

All Implemented Interfaces:

CredentialsExtractor<TokenCredentials>

public class IpExtractor
extends Object
implements CredentialsExtractor<TokenCredentials>

To extract a remote IP address.

Since:

1.8.0

Author:

Jerome Leleu

Constructor Summary

Constructors

Constructor and Description
IpExtractor(String clientName)

Method Summary

Modifier and Type	Method and Description
TokenCredentials	extract(WebContext context)
String	getAlternateIpHeader()
void	setAlternateIpHeader(String alternateIpHeader)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpExtractor

public IpExtractor(String clientName)

Method Detail

extract

public TokenCredentials extract(WebContext context)
                         throws HttpAction

Specified by:

extract in interface CredentialsExtractor<TokenCredentials>

Throws:

HttpAction

getAlternateIpHeader

public String getAlternateIpHeader()

setAlternateIpHeader

public void setAlternateIpHeader(String alternateIpHeader)

toString

public String toString()

Overrides:

toString in class Object