ForwardedHeader.Hop (IG Aggregated Javadoc 2023.11.1 Documentation)

java.lang.Object
- org.forgerock.http.header.ForwardedHeader.Hop

Enclosing class:

ForwardedHeader
```
public static class ForwardedHeader.Hop
extends Object
```
This class represents a request's hop detail.

Constructor Summary

Constructors
Constructor	Description
`Hop(String hopDetails)`	Construct a `ForwardedHeader.Hop`.
`Hop(String forDirective, String byDirective, String hostDirective, String protoDirective)`	Construct a `ForwardedHeader.Hop`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getByAsIp()`	Get the proxy node IP if set as an IPv4/v6 address.
`String`	`getForAsIp()`	Get the client node IP if set as an IPv4/v6 address.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - Hop
```
public Hop(String forDirective,
           String byDirective,
           String hostDirective,
           String protoDirective)
```
    Construct a ForwardedHeader.Hop. Each field may contain double quotes.
    
    Parameters:
    
    forDirective - the client's address
    
    byDirective - the proxy's address
    
    hostDirective - the host requested at this time
    
    protoDirective - the protocol used between the client and the proxy
  - Hop
```
public Hop(String hopDetails)
```
    Construct a ForwardedHeader.Hop.
    
    Parameters:
    
    hopDetails - the hop details as one long http key value list. eg : "key=value;key2="value nb 2";key3=314"
- Method Detail
  - getForAsIp
```
public String getForAsIp()
```
    Get the client node IP if set as an IPv4/v6 address.
    
    Returns:
    
    the client IP address or null if not set.
  - getByAsIp
```
public String getByAsIp()
```
    Get the proxy node IP if set as an IPv4/v6 address.
    
    Returns:
    
    the proxy IP address or null if not set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object