HttpForward (MockServer 5.8.1 API)

java.lang.Object
- org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString
- - org.mockserver.model.ObjectWithJsonToString
  - - org.mockserver.model.Action<HttpForward>
    - - org.mockserver.model.HttpForward

public class HttpForward
extends Action<HttpForward>

Author:: jamesdbloom

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HttpForward.Scheme
- Nested classes/interfaces inherited from class org.mockserver.model.Action
  Action.Direction, Action.Type

Constructor Summary

Constructors
Constructor Description

HttpForward()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HttpForward`	`forward()`	Static builder to create a forward.
`String`	`getHost()`
`Integer`	`getPort()`
`HttpForward.Scheme`	`getScheme()`
`Action.Type`	`getType()`
`HttpForward`	`withHost(String host)`	The host or ip address to forward the request to i.e.
`HttpForward`	`withPort(Integer port)`	The port to forward the request to i.e.
`HttpForward`	`withScheme(HttpForward.Scheme scheme)`	The scheme to use when forwarded the request, either HTTP or HTTPS.

Methods inherited from class org.mockserver.model.Action
getDelay, withDelay, withDelay

Methods inherited from class org.mockserver.model.ObjectWithJsonToString
toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString
equals, fieldsExcludedFromEqualsAndHashCode, hashCode, key

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

- Constructor Detail
  - HttpForward
```
public HttpForward()
```
- Method Detail
  - forward
```
public static HttpForward forward()
```
    Static builder to create a forward.
  - getType
```
public Action.Type getType()
```
    Specified by:
    
    getType in class Action<HttpForward>
  - getHost
```
public String getHost()
```
  - withHost
```
public HttpForward withHost(String host)
```
    The host or ip address to forward the request to i.e. "www.mock-server.com"
    
    Parameters:
    
    host - a hostname or ip address as a string
  - getPort
```
public Integer getPort()
```
  - withPort
```
public HttpForward withPort(Integer port)
```
    The port to forward the request to i.e. 80. If not specified the port defaults to 80.
    
    Parameters:
    
    port - a port as an integer
  - getScheme
```
public HttpForward.Scheme getScheme()
```
  - withScheme
```
public HttpForward withScheme(HttpForward.Scheme scheme)
```
    The scheme to use when forwarded the request, either HTTP or HTTPS. If not specified the scheme defaults to HTTP.
    
    Parameters:
    
    scheme - the scheme as a HttpForward.Scheme value