agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class GeospatialContentServerAuthorizationProvider

java.lang.Object

agi.foundation.infrastructure.GeospatialContentServerAuthorizationProvider

All Implemented Interfaces:

IAuthorizationProvider

public class GeospatialContentServerAuthorizationProvider
extends Object
implements IAuthorizationProvider

An authorization provider which obtains an authorization token for a given Geospatial Content Server (GCS) application token.

Constructor Summary

Constructors

Constructor and Description
GeospatialContentServerAuthorizationProvider(String baseUrl, String applicationToken) Initializes a new instance.
GeospatialContentServerAuthorizationProvider(String baseUrl, String applicationToken, Proxy proxy) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
String	getAuthorizationToken(String url) Gets an authorization token that will be used to request the given URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeospatialContentServerAuthorizationProvider

public GeospatialContentServerAuthorizationProvider(@Nonnull
                                                    String baseUrl,
                                                    @Nonnull
                                                    String applicationToken)

Initializes a new instance.

Parameters:

baseUrl - The base URL of the Geospatial Content Server to connect to.

applicationToken - The application token which will be used to obtain authorization tokens.

Throws:

ArgumentNullException - Thrown when baseUrl or applicationToken is null.

GeospatialContentServerAuthorizationProvider

public GeospatialContentServerAuthorizationProvider(@Nonnull
                                                    String baseUrl,
                                                    @Nonnull
                                                    String applicationToken,
                                                    @Nullable
                                                    Proxy proxy)

Initializes a new instance.

Parameters:

baseUrl - The base URL of the Geospatial Content Server to connect to.

applicationToken - The application token which will be used to obtain authorization tokens.

proxy - The proxy to use when connecting. Optional, default is null.

Throws:

ArgumentNullException - Thrown when baseUrl or applicationToken is null.

Method Detail

getAuthorizationToken

public final String getAuthorizationToken(String url)

Gets an authorization token that will be used to request the given URL.

Specified by:

getAuthorizationToken in interface IAuthorizationProvider

Parameters:

url - The URL of the resource that will be requested.

Returns:

The authorization token.