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

Interface IAuthClient

All Known Implementing Classes:

AuthClient

public interface IAuthClient

Interface defining the contract for an authentication client. An implementation of this interface provides methods to retrieve access tokens and service URLs by interacting with a service's authentication mechanism.

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.

Method Details

getAccessToken

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.

Returns:

the access token as a String

Throws:

IOException - if an I/O error occurs

InterruptedException - if the operation is interrupted

getNewAccessToken

String getNewAccessToken()
                  throws IOException,
InterruptedException

Retrieves a new access token using the stored service key.

Returns:

the new access token as a String

Throws:

IOException - if an I/O error occurs

InterruptedException - if the operation is interrupted

getNewAccessToken

String getNewAccessToken(ServiceKey serviceKey)
                  throws IOException,
InterruptedException

Retrieves a new access token using the provided service key.

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

String getServiceUrl()

Retrieves the service URL from the stored service key.

Returns:

the service URL as a String