com.openshift.restclient.authorization

Interface IAuthorizationContext

All Known Implementing Classes:

AuthorizationContext

public interface IAuthorizationContext

Author:

Jeff Cantrill

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHSCHEME_BASIC
static String	AUTHSCHEME_OAUTH

Method Summary

Modifier and Type	Method and Description
IAuthorizationDetails	getAuthorizationDetails() Retrieve the authorization details for a server
String	getAuthScheme() The authorization scope if it can be determined.
String	getExpiresIn() Time in ??
String	getPassword() Password to use to authenticate to retrieve a token
String	getToken() Token to use for authentication.
IUser	getUser() The authorized user if it can be found for this token
String	getUserName() A username to use for authenticating
boolean	isAuthorized() This can trigger a remote call if a user has not attempted to authorize previously
void	setPassword(String password) Password to use to authenticate to retrieve a token
void	setToken(String token) The token to try and use for communication to the apiserver
void	setUserName(String userName) A username to use for authenticating

Field Detail

AUTHSCHEME_BASIC

static final String AUTHSCHEME_BASIC

See Also:

Constant Field Values

AUTHSCHEME_OAUTH

static final String AUTHSCHEME_OAUTH

See Also:

Constant Field Values

Method Detail

getUser

IUser getUser()

The authorized user if it can be found for this token

Returns:

return the user for the token or null if not authorized

isAuthorized

boolean isAuthorized()

This can trigger a remote call if a user has not attempted to authorize previously

Returns:

true if authorized; false otherwise

getAuthScheme

String getAuthScheme()

The authorization scope if it can be determined.

Returns:

the scope or null if unknown

getToken

String getToken()

Token to use for authentication. Will return non-null value if authorized

Returns:

setToken

void setToken(String token)

The token to try and use for communication to the apiserver

Parameters:

token -

setUserName

void setUserName(String userName)

A username to use for authenticating

Parameters:

userName -

getUserName

String getUserName()

A username to use for authenticating

Returns:

userName

setPassword

void setPassword(String password)

Password to use to authenticate to retrieve a token

Parameters:

password -

getPassword

String getPassword()

Password to use to authenticate to retrieve a token

Returns:

password

getExpiresIn

String getExpiresIn()

Time in ?? when the token expires. Will return non-null value if authorized

Returns:

getAuthorizationDetails

IAuthorizationDetails getAuthorizationDetails()

Retrieve the authorization details for a server

Parameters:

baseURL -

Returns: