io.redlink.sdk.impl

Class DefaultCredentials

java.lang.Object

io.redlink.sdk.impl.DefaultCredentials

All Implemented Interfaces:

Credentials, Serializable

public final class DefaultCredentials
extends Object

Public API Credentials implementation. This implementation should be used as the most simple way to access to the RedLink public platform An user valid API key is necessary for building the credential object.

Author:

sergio.fernandez@redlink.co, jakob.frank@redlink.co

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATAHUB
static String	ENDPOINT
static String	KEY_PARAM

Constructor Summary

Constructors

Constructor and Description
DefaultCredentials(String apiKey)
DefaultCredentials(String apiKey, String version)

Method Summary

Modifier and Type	Method and Description
URI	buildUrl(UriBuilder builder) URI Builder for RedLink.
String	getApiKey() Get the API Key
String	getDataHub() Get the base URI of the data hub
String	getEndpoint() Get the API endpoint
Status	getStatus() Forces the update of the cached status
String	getVersion() Get the API version
boolean	verify() Verify the current (cached) credentials are valid

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

KEY_PARAM

public static final String KEY_PARAM

See Also:

Constant Field Values

DATAHUB

public static final String DATAHUB

See Also:

Constant Field Values

Constructor Detail

DefaultCredentials

public DefaultCredentials(String apiKey)

DefaultCredentials

public DefaultCredentials(String apiKey,
                          String version)

Method Detail

buildUrl

public URI buildUrl(UriBuilder builder)
             throws MalformedURLException,
                    IllegalArgumentException,
                    URISyntaxException

Description copied from interface: Credentials

URI Builder for RedLink. This method uses the credential information to build an endpoint client ready for performing requests bound to the user RedLink application services

Parameters:

builder - base uri builder

Returns:

URI

Throws:

MalformedURLException

IllegalArgumentException

URISyntaxException

getEndpoint

public String getEndpoint()

Description copied from interface: Credentials

Get the API endpoint

Specified by:

getEndpoint in interface Credentials

Returns:

api endpoint

getVersion

public String getVersion()

Description copied from interface: Credentials

Get the API version

Specified by:

getVersion in interface Credentials

Returns:

api verison

getApiKey

public String getApiKey()

Description copied from interface: Credentials

Get the API Key

Specified by:

getApiKey in interface Credentials

Returns:

api key

getDataHub

public String getDataHub()

Description copied from interface: Credentials

Get the base URI of the data hub

Specified by:

getDataHub in interface Credentials

Returns:

datahub uri

verify

public boolean verify()
               throws MalformedURLException

Description copied from interface: Credentials

Verify the current (cached) credentials are valid

Specified by:

verify in interface Credentials

Returns:

valid/invalid credentials

Throws:

MalformedURLException

getStatus

public Status getStatus()

Description copied from interface: Credentials

Forces the update of the cached status

Specified by:

getStatus in interface Credentials

Returns:

fresh status