io.redlink.sdk

Interface Credentials

All Superinterfaces:

Serializable

All Known Implementing Classes:

CustomCredentials, DefaultCredentials, StagingCredentials

public interface Credentials
extends Serializable

RedLink SDK Credentials. A Credential object must be used in any request to the RedLink services

Author:

sergio.fernandez@redlink.co, rharo@zaizi.com

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

Method Detail

getEndpoint

String getEndpoint()

Get the API endpoint

Returns:

api endpoint

getVersion

String getVersion()

Get the API version

Returns:

api verison

getApiKey

String getApiKey()

Get the API Key

Returns:

api key

getDataHub

String getDataHub()

Get the base URI of the data hub

Returns:

datahub uri

verify

boolean verify()
        throws MalformedURLException

Verify the current (cached) credentials are valid

Returns:

valid/invalid credentials

Throws:

MalformedURLException

getStatus

Status getStatus()
          throws IOException,
                 URISyntaxException

Forces the update of the cached status

Returns:

fresh status

Throws:

MalformedURLException

IOException

URISyntaxException

buildUrl

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

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