Package org.opensaml.profile.logic

Class IPRangePredicate

java.lang.Object

org.opensaml.profile.logic.IPRangePredicate

All Implemented Interfaces:

Predicate<BaseContext>, Predicate<BaseContext>

public class IPRangePredicate
extends Object
implements Predicate<BaseContext>

A Predicate that checks if a request is from a set of one or more IPRanges.

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<IPRange>	addressRanges	IP ranges to match against.
private Supplier<javax.servlet.http.HttpServletRequest>	httpRequestSupplier	Servlet request to evaluate.

Constructor Summary

Constructors

Constructor	Description
IPRangePredicate()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest request)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setHttpServletRequestSupplier(Supplier<javax.servlet.http.HttpServletRequest> supplier)	Set the Supplier for the servlet request to evaluate.
void	setRanges(Collection<IPRange> ranges)	Set the address ranges to check against.
boolean	test(BaseContext input)

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.Predicate

and, negate, or

Methods inherited from interface net.shibboleth.utilities.java.support.logic.Predicate

apply

Field Detail

httpRequestSupplier

@Nullable
private Supplier<javax.servlet.http.HttpServletRequest> httpRequestSupplier

Servlet request to evaluate.

addressRanges

@Nonnull
@NonnullElements
private Collection<IPRange> addressRanges

IP ranges to match against.

Constructor Detail

IPRangePredicate

IPRangePredicate()

Constructor.

Method Detail

setRanges

public void setRanges(@Nonnull @NonnullElements
                      Collection<IPRange> ranges)

Set the address ranges to check against.

Parameters:

ranges - address ranges to check against

Since:

3.3.0

setHttpServletRequestSupplier

public void setHttpServletRequestSupplier(@Nonnull
                                          Supplier<javax.servlet.http.HttpServletRequest> supplier)

Set the Supplier for the servlet request to evaluate.

Parameters:

supplier - servlet request supplier to use

setHttpServletRequest

@Deprecated(since="4.3",
            forRemoval=true)
public void setHttpServletRequest(@Nonnull
                                  javax.servlet.http.HttpServletRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the servlet request to evaluate.

Parameters:

request - servlet request to evaluate

test

public boolean test(@Nullable
                    BaseContext input)

Specified by:

test in interface Predicate<BaseContext>