Package com.developer.nefarious.zjoule.plugin.auth

Class AuthClient

java.lang.Object

com.developer.nefarious.zjoule.plugin.auth.AuthClient

All Implemented Interfaces:

IAuthClient

public class AuthClient
extends Object
implements IAuthClient

The AuthClient class provides functionality to authenticate with a service and retrieve access tokens. It interacts with memory storage for access tokens and service keys and uses an HTTP client to make requests to the authentication server.

Constructor Summary

Constructors

Constructor	Description
AuthClient(IMemoryObject<AccessToken> memoryAccessToken, IMemoryObject<ServiceKey> memoryServiceKey, IAuthClientHelper authClientHelper)	Constructs an AuthClient instance with the given dependencies.

Method Summary

Modifier and Type	Method	Description
String	getAccessToken()	Retrieves the current access token.
String	getNewAccessToken()	Retrieves a new access token using the stored service key.
String	getNewAccessToken(ServiceKey serviceKey)	Retrieves a new access token using the provided service key.
String	getServiceUrl()	Retrieves the service URL from the stored service key.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthClient

public AuthClient(IMemoryObject<AccessToken> memoryAccessToken,
 IMemoryObject<ServiceKey> memoryServiceKey,
 IAuthClientHelper authClientHelper)

Constructs an AuthClient instance with the given dependencies.

Parameters:

memoryAccessToken - the memory storage for access tokens

memoryServiceKey - the memory storage for service keys

authClientHelper - the helper for constructing and handling authentication requests

Method Details

getAccessToken

public String getAccessToken()
                      throws IOException,
InterruptedException

Retrieves the current access token. If the token is valid, it returns the cached token; otherwise, it fetches a new token.

Specified by:

getAccessToken in interface IAuthClient

Returns:

the access token as a String

Throws:

IOException - if an I/O error occurs

InterruptedException - if the operation is interrupted

getNewAccessToken

public String getNewAccessToken()
                         throws IOException,
InterruptedException

Retrieves a new access token using the stored service key.

Specified by:

getNewAccessToken in interface IAuthClient

Returns:

the new access token as a String

Throws:

IOException - if an I/O error occurs

InterruptedException - if the operation is interrupted

getNewAccessToken

public String getNewAccessToken(ServiceKey serviceKey)
                         throws IOException,
InterruptedException

Retrieves a new access token using the provided service key.

Specified by:

getNewAccessToken in interface IAuthClient

Parameters:

serviceKey - the ServiceKey used for authentication

Returns:

the new access token as a String

Throws:

IOException - if an I/O error occurs

InterruptedException - if the operation is interrupted

getServiceUrl

public String getServiceUrl()

Retrieves the service URL from the stored service key.

Specified by:

getServiceUrl in interface IAuthClient

Returns:

the service URL as a String