org.opencode4workspace

Interface IWWClient

All Known Implementing Classes:

WWClient

public interface IWWClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IWWClient.ClientType

Method Summary

Modifier and Type	Method and Description
void	authenticate() Attempt authentication of the WWClient
String	getAppCredentials() Converts appId and appSecret into required content for Authorization header
IWWClient.ClientType	getClientType() Getter for ClientType, dependent upon the initialiser user
Date	getExpireDate() Gets the time the token expires from the AuthenticationResult
Object	getExpiresIn() Gets the length of time until the token expires from the AuthenticationResult
String	getJWTToken() Gets JWT token for the user / application from the AuthenticationResult.
String	getResultContent() Getter for resultContent from relevant endpoint
String	getUserRefreshToken() Gets the refreshtoken for a user authentication from the AuthenticationResult
boolean	isAuthenticated() Whether or not authentication has successfully occurred.
boolean	isValid() Tests whether the AuthenticationResult is valid
void	setResultContent(String resultContent) Setter for resultContent from relevant endpoint

Method Detail

getClientType

IWWClient.ClientType getClientType()

Getter for ClientType, dependent upon the initialiser user

Returns:

IWWClient.ClientType.USER or IWWClient.ClientType.APPLICATON

Since:

0.5.0

getAppCredentials

String getAppCredentials()
                  throws UnsupportedEncodingException

Converts appId and appSecret into required content for Authorization header

Returns:

String, content for Authorization header

Throws:

UnsupportedEncodingException - if the encoding option is not supported

Since:

0.5.0

isAuthenticated

boolean isAuthenticated()

Whether or not authentication has successfully occurred. Call authenticate() first

Returns:

boolean, whether or not already authenticated

Since:

0.5.0

authenticate

void authenticate()
           throws UnsupportedEncodingException,
                  WWException

Attempt authentication of the WWClient

Throws:

UnsupportedEncodingException - Authorization header could not be constructed

WWException - Some other error occurred during authentication

Since:

0.5.0

getJWTToken

String getJWTToken()

Gets JWT token for the user / application from the AuthenticationResult. The JWT token is an expiring token associated with the appId and appSecret. From the documentation: "This JWT token is what you have to use in your App to pass to Watson Work Services on API calls so that you can use its services securely"

Returns:

String, JWT token

Since:

0.5.0

getUserRefreshToken

String getUserRefreshToken()

Gets the refreshtoken for a user authentication from the AuthenticationResult

Returns:

String, refresh token. A blank string for an application authentication

Since:

0.8.0

getExpiresIn

Object getExpiresIn()

Gets the length of time until the token expires from the AuthenticationResult

Returns:

Object, a long that determines the time until expiry

Since:

0.5.0

getExpireDate

Date getExpireDate()

Gets the time the token expires from the AuthenticationResult

Returns:

Date, the time the token expires

Since:

0.8.0

isValid

boolean isValid()

Tests whether the AuthenticationResult is valid

Returns:

boolean, whether or not valid

Since:

0.5.0

getResultContent

String getResultContent()

Getter for resultContent from relevant endpoint

Returns:

result content (data / errors) as JSON String

setResultContent

void setResultContent(String resultContent)

Setter for resultContent from relevant endpoint

Parameters:

resultContent - result content (data / errors) as JSON String