com.mesosphere.velocity.marathon.auth

Class TokenAuthProvider

java.lang.Object

com.mesosphere.velocity.marathon.auth.TokenAuthProvider

Direct Known Subclasses:

DcosAuthImpl

public abstract class TokenAuthProvider
extends Object

Provides an abstraction for authentication providers that return a token that can be used when authenticating against the target Marathon instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenAuthProvider.Providers

Constructor Summary

Constructors

Constructor and Description
TokenAuthProvider()

Method Summary

Modifier and Type	Method and Description
abstract String	getToken() Get a new authentication token that will be used to deploy or update a Marathon application.
static TokenAuthProvider	getTokenAuthProvider(TokenAuthProvider.Providers provider, com.cloudbees.plugins.credentials.Credentials credentials)
abstract boolean	updateTokenCredentials(com.cloudbees.plugins.credentials.Credentials tokenCredentials)

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenAuthProvider

public TokenAuthProvider()

Method Detail

getTokenAuthProvider

public static TokenAuthProvider getTokenAuthProvider(TokenAuthProvider.Providers provider,
                                                     com.cloudbees.plugins.credentials.Credentials credentials)

getToken

public abstract String getToken()
                         throws AuthenticationException

Get a new authentication token that will be used to deploy or update a Marathon application.

Returns:

token to be used in the Authorization HTTP header

Throws:

AuthenticationException - If the token retrieval process encounters an error.

updateTokenCredentials

public abstract boolean updateTokenCredentials(com.cloudbees.plugins.credentials.Credentials tokenCredentials)
                                        throws AuthenticationException

Throws:

AuthenticationException