com.microsoft.alm.oauth2.useragent

Class UserAgentImpl

java.lang.Object

com.microsoft.alm.oauth2.useragent.UserAgentImpl

All Implemented Interfaces:

ProviderScanner, UserAgent

public class UserAgentImpl
extends Object
implements UserAgent, ProviderScanner

Constructor Summary

Constructors

Constructor and Description
UserAgentImpl()

Method Summary

Modifier and Type	Method and Description
static StringBuilder	buildUnsupportedMessage(Map<Provider,List<String>> unmetRequirements)
static void	describeUnmetRequirements(Map<Provider,List<String>> unmetRequirements, StringBuilder destination)
Provider	findCompatibleProvider() Scans the Provider implementations, checks their requirements and tries to find one that will work, preferring the one named by the userAgentProvider property, if it was set.
Provider	findCompatibleProvider(String userAgentProvider) Scans the Provider implementations, checks their requirements and tries to find one that will work, preferring the one whose name was provided.
Map<Provider,List<String>>	getUnmetProviderRequirements() Determines unmet requirements (if any) for each available Provider implementation.
boolean	hasCompatibleProvider() Calls ProviderScanner.findCompatibleProvider() and returns whether a compatible Provider was found.
boolean	hasCompatibleProvider(String userAgentProvider) Calls ProviderScanner.findCompatibleProvider(String) and returns whether a compatible Provider was found.
AuthorizationResponse	requestAuthorizationCode(URI authorizationEndpoint, URI redirectUri)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAgentImpl

public UserAgentImpl()

Method Detail

findCompatibleProvider

public Provider findCompatibleProvider()

Description copied from interface: ProviderScanner

Scans the Provider implementations, checks their requirements and tries to find one that will work, preferring the one named by the userAgentProvider property, if it was set.

Specified by:

findCompatibleProvider in interface ProviderScanner

Returns:

a Provider that was deemed compatible; null if no compatible providers were found.

findCompatibleProvider

public Provider findCompatibleProvider(String userAgentProvider)

Description copied from interface: ProviderScanner

Scans the Provider implementations, checks their requirements and tries to find one that will work, preferring the one whose name was provided.

Specified by:

findCompatibleProvider in interface ProviderScanner

Parameters:

userAgentProvider - the name of the preferred provider or null if there's no preference

Returns:

a Provider that was deemed compatible; null if no compatible providers were found.

getUnmetProviderRequirements

public Map<Provider,List<String>> getUnmetProviderRequirements()

Description copied from interface: ProviderScanner

Determines unmet requirements (if any) for each available Provider implementation.

Specified by:

getUnmetProviderRequirements in interface ProviderScanner

Returns:

a map of Provider instances to their list of unmet requirements. If a Provider had all its requirements met, it will not be part of the map. An empty map means all providers are compatible.

hasCompatibleProvider

public boolean hasCompatibleProvider()

Description copied from interface: ProviderScanner

Calls ProviderScanner.findCompatibleProvider() and returns whether a compatible Provider was found.

Specified by:

hasCompatibleProvider in interface ProviderScanner

Returns:

true if a compatible provider was found; false otherwise.

hasCompatibleProvider

public boolean hasCompatibleProvider(String userAgentProvider)

Description copied from interface: ProviderScanner

Calls ProviderScanner.findCompatibleProvider(String) and returns whether a compatible Provider was found.

Specified by:

hasCompatibleProvider in interface ProviderScanner

Parameters:

userAgentProvider - the name of the preferred provider or null if there's no preference

Returns:

true if a compatible provider was found; false otherwise.

requestAuthorizationCode

public AuthorizationResponse requestAuthorizationCode(URI authorizationEndpoint,
                                                      URI redirectUri)
                                               throws AuthorizationException

Specified by:

requestAuthorizationCode in interface UserAgent

Throws:

AuthorizationException

buildUnsupportedMessage

public static StringBuilder buildUnsupportedMessage(Map<Provider,List<String>> unmetRequirements)

describeUnmetRequirements

public static void describeUnmetRequirements(Map<Provider,List<String>> unmetRequirements,
                                             StringBuilder destination)