com.openshift.internal.restclient.authorization

Class AuthorizationContext

java.lang.Object

com.openshift.internal.restclient.authorization.AuthorizationContext

All Implemented Interfaces:

IAuthorizationContext

public class AuthorizationContext
extends Object
implements IAuthorizationContext

Field Summary

Fields inherited from interface com.openshift.restclient.authorization.IAuthorizationContext

AUTHSCHEME_BASIC, AUTHSCHEME_OAUTH

Constructor Summary

Constructors

Constructor and Description
AuthorizationContext(String scope)
AuthorizationContext(String token, String expires, IUser user, String scheme)
AuthorizationContext(String token, String userName, String password)

Method Summary

Modifier and Type	Method and Description
AuthorizationContext	clone()
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	setClient(IClient client)
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	setUser(IUser user)
void	setUserName(String userName) A username to use for authenticating

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationContext

public AuthorizationContext(String scope)

AuthorizationContext

public AuthorizationContext(String token,
                            String userName,
                            String password)

AuthorizationContext

public AuthorizationContext(String token,
                            String expires,
                            IUser user,
                            String scheme)

Method Detail

clone

public AuthorizationContext clone()

Overrides:

clone in class Object

setClient

public void setClient(IClient client)

isAuthorized

public boolean isAuthorized()

Description copied from interface: IAuthorizationContext

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

Specified by:

isAuthorized in interface IAuthorizationContext

Returns:

true if authorized; false otherwise

getAuthorizationDetails

public IAuthorizationDetails getAuthorizationDetails()

Description copied from interface: IAuthorizationContext

Retrieve the authorization details for a server

Specified by:

getAuthorizationDetails in interface IAuthorizationContext

getToken

public String getToken()

Description copied from interface: IAuthorizationContext

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

Specified by:

getToken in interface IAuthorizationContext

getExpiresIn

public String getExpiresIn()

Description copied from interface: IAuthorizationContext

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

Specified by:

getExpiresIn in interface IAuthorizationContext

getAuthScheme

public String getAuthScheme()

Description copied from interface: IAuthorizationContext

The authorization scope if it can be determined.

Specified by:

getAuthScheme in interface IAuthorizationContext

Returns:

the scope or null if unknown

getUser

public IUser getUser()

Description copied from interface: IAuthorizationContext

The authorized user if it can be found for this token

Specified by:

getUser in interface IAuthorizationContext

Returns:

return the user for the token or null if not authorized

setUser

public void setUser(IUser user)

setToken

public void setToken(String token)

Description copied from interface: IAuthorizationContext

The token to try and use for communication to the apiserver

Specified by:

setToken in interface IAuthorizationContext

setUserName

public void setUserName(String userName)

Description copied from interface: IAuthorizationContext

A username to use for authenticating

Specified by:

setUserName in interface IAuthorizationContext

getUserName

public String getUserName()

Description copied from interface: IAuthorizationContext

A username to use for authenticating

Specified by:

getUserName in interface IAuthorizationContext

Returns:

userName

setPassword

public void setPassword(String password)

Description copied from interface: IAuthorizationContext

Password to use to authenticate to retrieve a token

Specified by:

setPassword in interface IAuthorizationContext

getPassword

public String getPassword()

Description copied from interface: IAuthorizationContext

Password to use to authenticate to retrieve a token

Specified by:

getPassword in interface IAuthorizationContext

Returns:

password