org.cloudfoundry.reactor

Class InfoPayloadRootProvider

java.lang.Object

org.cloudfoundry.reactor.InfoPayloadRootProvider

All Implemented Interfaces:

RootProvider

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class InfoPayloadRootProvider
extends Object

A RootProvider that returns endpoints extracted from the `/v2/info` API for the configured endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfoPayloadRootProvider.Builder Builds instances of type InfoPayloadRootProvider.

Method Summary

Modifier and Type	Method and Description
static InfoPayloadRootProvider.Builder	builder() Creates a builder for InfoPayloadRootProvider.
void	checkForValidApiHost()
reactor.core.publisher.Mono<org.cloudfoundry.reactor.util.Operator>	createOperator(ConnectionContext connectionContext)
protected reactor.core.publisher.Mono<org.springframework.web.util.UriComponents>	doGetRoot(ConnectionContext connectionContext)
protected reactor.core.publisher.Mono<org.springframework.web.util.UriComponents>	doGetRoot(String key, ConnectionContext connectionContext)
boolean	equals(Object another) This instance is equal to all instances of InfoPayloadRootProvider that have equal attribute values.
String	getApiHost() The hostname of the API root.
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Optional<Integer>	getPort() The port for the Cloud Foundry instance.
protected org.springframework.web.util.UriComponents	getRoot()
reactor.core.publisher.Mono<String>	getRoot(ConnectionContext connectionContext) The normalized API root
reactor.core.publisher.Mono<String>	getRoot(String key, ConnectionContext connectionContext) The normalized root for a given key
Optional<Boolean>	getSecure() Whether the connection to the root API should be secure (i.e.
int	hashCode() Computes a hash code from attributes: objectMapper, apiHost, port, secure.
protected org.springframework.web.util.UriComponents	normalize(org.springframework.web.util.UriComponentsBuilder builder)
String	toString() Prints the immutable value InfoPayloadRootProvider with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Returns:

The value of the objectMapper attribute

getApiHost

public String getApiHost()

The hostname of the API root. Typically something like api.run.pivotal.io.

getPort

public Optional<Integer> getPort()

The port for the Cloud Foundry instance. Defaults to 443.

getSecure

public Optional<Boolean> getSecure()

Whether the connection to the root API should be secure (i.e. using HTTPS). Defaults to true.

equals

public boolean equals(Object another)

This instance is equal to all instances of InfoPayloadRootProvider that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: objectMapper, apiHost, port, secure.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value InfoPayloadRootProvider with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static InfoPayloadRootProvider.Builder builder()

Creates a builder for InfoPayloadRootProvider.

 InfoPayloadRootProvider.builder()
    .objectMapper(com.fasterxml.jackson.databind.ObjectMapper) // required objectMapper
    .apiHost(String) // required apiHost
    .port(Integer) // optional port
    .secure(Boolean) // optional secure
    .build();
 

Returns:

A new InfoPayloadRootProvider builder

doGetRoot

protected reactor.core.publisher.Mono<org.springframework.web.util.UriComponents> doGetRoot(ConnectionContext connectionContext)

doGetRoot

protected reactor.core.publisher.Mono<org.springframework.web.util.UriComponents> doGetRoot(String key,
                                                                                            ConnectionContext connectionContext)

checkForValidApiHost

@Value.Check
public final void checkForValidApiHost()

createOperator

public reactor.core.publisher.Mono<org.cloudfoundry.reactor.util.Operator> createOperator(ConnectionContext connectionContext)

getRoot

public final reactor.core.publisher.Mono<String> getRoot(String key,
                                                         ConnectionContext connectionContext)

Description copied from interface: RootProvider

The normalized root for a given key

Specified by:

getRoot in interface RootProvider

Parameters:

key - the key to look up root from

connectionContext - a ConnectionContext to be used if the roo needs to be retrieved via a network request

Returns:

the normalized API root

getRoot

public final reactor.core.publisher.Mono<String> getRoot(ConnectionContext connectionContext)

Description copied from interface: RootProvider

The normalized API root

Specified by:

getRoot in interface RootProvider

Parameters:

connectionContext - a ConnectionContext to be used if the root needs to be retrieved via a network request

Returns:

the normalized API root

getRoot

protected final org.springframework.web.util.UriComponents getRoot()

normalize

protected final org.springframework.web.util.UriComponents normalize(org.springframework.web.util.UriComponentsBuilder builder)