com.sdl.web.client

Interface DiscoveryClient

All Known Implementing Classes:

DefaultDiscoveryClient

public interface DiscoveryClient

Discovery client will be used to obtain different resources supported by discovery-service.

Method Summary

Modifier and Type	Method and Description
<T extends com.sdl.odata.client.api.model.ODataIdAwareEntity> List<T>	getAwareEntities(Class<T> entityClazz, Optional<String> oAuthToken, String... expandParameters) Request for ODataIdAwareEntityies WITH security attached.
<T extends com.sdl.odata.client.api.model.ODataIdAwareEntity> Optional<T>	getAwareEntity(Class<T> entityClazz, Optional<String> oAuthToken, String... expandParameters) Request for ODataIdAwareEntityies with security attached.
default <T extends Capability> List<T>	getCapabilities(Class<T> capabilityClazz) Request for Capabilityies WITHOUT security attached.
default <T extends Capability> List<T>	getCapabilities(Class<T> capabilityClazz, Optional<String> oAuthToken) Request for Capabilityies WITH security attached.
<T extends Capability> List<T>	getCapabilities(Class<T> capabilityClazz, Optional<String> oAuthToken, String... expandParameters) Request for Capabilityies WITH security attached.
default <T extends Capability> Optional<T>	getCapability(Class<T> capabilityClazz) Request for Capability WITHOUT security attached.
default <T extends Capability> Optional<T>	getCapability(Class<T> capabilityClazz, Optional<String> oAuthToken) Request for Capability WITH security attached.
<T extends Capability> Optional<T>	getCapability(Class<T> capabilityClazz, Optional<String> oAuthToken, String... expandParameters) Request for Capability WITH security attached and expand parameters.
String	getServiceUrl() Return the service url.
Optional<TokenServiceCapability>	getTokenServiceCapability() Request for TokenServiceCapability.

Method Detail

getTokenServiceCapability

Optional<TokenServiceCapability> getTokenServiceCapability()

Request for TokenServiceCapability.

Returns:

Resolved TokenServiceCapability

getCapability

default <T extends Capability> Optional<T> getCapability(Class<T> capabilityClazz)

Request for Capability WITHOUT security attached.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

Returns:

Optional with concrete capability if found or empty otherwise.

getCapability

default <T extends Capability> Optional<T> getCapability(Class<T> capabilityClazz,
                                                         Optional<String> oAuthToken)

Request for Capability WITH security attached.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

oAuthToken - The Optional OAuth token

Returns:

Optional with concrete capability if found or empty otherwise.

getCapability

<T extends Capability> Optional<T> getCapability(Class<T> capabilityClazz,
                                                 Optional<String> oAuthToken,
                                                 String... expandParameters)

Request for Capability WITH security attached and expand parameters.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

oAuthToken - The Optional OAuth token

expandParameters - The expand parameters

Returns:

Optional with concrete capability if found or empty otherwise.

getCapabilities

default <T extends Capability> List<T> getCapabilities(Class<T> capabilityClazz)

Request for Capabilityies WITHOUT security attached.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

Returns:

Optional with list of concrete capabilities if found or empty otherwise.

getCapabilities

default <T extends Capability> List<T> getCapabilities(Class<T> capabilityClazz,
                                                       Optional<String> oAuthToken)

Request for Capabilityies WITH security attached.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

oAuthToken - The Optional OAuth token

Returns:

Optional with list of concrete capability if found or empty otherwise.

getCapabilities

<T extends Capability> List<T> getCapabilities(Class<T> capabilityClazz,
                                               Optional<String> oAuthToken,
                                               String... expandParameters)

Request for Capabilityies WITH security attached.

Type Parameters:

T - Class which extends Capability interface

Parameters:

capabilityClazz - The requested capability class

oAuthToken - The Optional OAuth token

expandParameters - The expand parameters

Returns:

Optional with list of concrete capability if found or empty otherwise.

getAwareEntity

<T extends com.sdl.odata.client.api.model.ODataIdAwareEntity> Optional<T> getAwareEntity(Class<T> entityClazz,
                                                                                         Optional<String> oAuthToken,
                                                                                         String... expandParameters)

Request for ODataIdAwareEntityies with security attached.

Type Parameters:

T - Class which extends ODataIdAwareEntity interface

Parameters:

entityClazz - The requested aware entity class

oAuthToken - The Optional OAuth token

expandParameters - The expand parameters

Returns:

Optional with concrete odataIdAwareEntity if found or empty otherwise.

getAwareEntities

<T extends com.sdl.odata.client.api.model.ODataIdAwareEntity> List<T> getAwareEntities(Class<T> entityClazz,
                                                                                       Optional<String> oAuthToken,
                                                                                       String... expandParameters)

Request for ODataIdAwareEntityies WITH security attached.

Type Parameters:

T - Class which extends ODataIdAwareEntity interface

Parameters:

entityClazz - The requested entity class

oAuthToken - The Optional OAuth token

expandParameters - The expand parameters

Returns:

List of concrete capabilities if found.

getServiceUrl

String getServiceUrl()

Return the service url.

Returns:

The service url