org.opencode4workspace.authentication

Interface AuthenticationEndpoint

All Known Implementing Classes:

WWAuthenticationEndpoint

public interface AuthenticationEndpoint

Since:

0.5.0 Interface for handlign authentications

Author:

Christian Guedemann

Method Summary

Modifier and Type	Method and Description
AuthenticationResult	authenticateApplication(String basicAuthApp) Creates POST request for authentication and returns result, if successful, or generates error, if not
AuthenticationResult	authorizeUser(String basicAuthApp, String userToken, String redirectTo) Creates POST request for authorizing user and returns result, if successful, or generates error, if not
PeopleToken	authorizeUserGetToken(String basicAuthApp, String userToken, String redirectTo) Creates POST request for authorizing user and returns result, if successful, or generates error, if not
AuthenticationResult	authorizeUserRefreshToken(String basicAuthApp, String refreshToken, String scope)
PeopleToken	authorizeUserRefreshTokenGetToken(String basicAuthApp, String refreshToken, String scope)

Method Detail

authenticateApplication

AuthenticationResult authenticateApplication(String basicAuthApp)
                                      throws WWException

Creates POST request for authentication and returns result, if successful, or generates error, if not

Parameters:

basicAuthApp - String, content for Authorization header constructed from WWClient.getAppCredentials()

Returns:

AuthenticationResult containing response details

Throws:

WWException - error details

Since:

0.0.5

authorizeUser

AuthenticationResult authorizeUser(String basicAuthApp,
                                   String userToken,
                                   String redirectTo)
                            throws WWException

Creates POST request for authorizing user and returns result, if successful, or generates error, if not

Parameters:

basicAuthApp - String, content for Authorization header constructed from WWClient.getAppCredentials()

userToken - String, user token to pass

redirectTo - String, URL to redirect to if successful

Returns:

AuthenticationResult containing response details

Throws:

WWException - error details

Since:

0.5.0

authorizeUserGetToken

PeopleToken authorizeUserGetToken(String basicAuthApp,
                                  String userToken,
                                  String redirectTo)
                           throws WWException

Creates POST request for authorizing user and returns result, if successful, or generates error, if not

Parameters:

basicAuthApp - String, content for Authorization header constructed from WWClient.getAppCredentials()

userToken - String, user token to pass

redirectTo - String, URL to redirect to if successful

Returns:

PeopleToken response

Throws:

WWException - error details

Since:

0.5.0

authorizeUserRefreshToken

AuthenticationResult authorizeUserRefreshToken(String basicAuthApp,
                                               String refreshToken,
                                               String scope)
                                        throws WWException

Parameters:

basicAuthApp - String, content for Authorization header constructed from WWClient.getAppCredentials()

refreshToken - String, refresh token to pass

scope - String, scope for the token

Returns:

AuthenticationResult containing response details

Throws:

WWException - error details

Since:

0.8.0

authorizeUserRefreshTokenGetToken

PeopleToken authorizeUserRefreshTokenGetToken(String basicAuthApp,
                                              String refreshToken,
                                              String scope)
                                       throws WWException

Parameters:

basicAuthApp - String, content for Authorization header constructed from WWClient.getAppCredentials()

refreshToken - String, refresh token to pass

scope - String, scope for the token

Returns:

PeopleToken containing response details

Throws:

WWException - error details

Since:

0.8.0