com.openshift.client

Interface IAuthorization

All Superinterfaces:

IOpenShiftResource

All Known Implementing Classes:

AuthorizationResource

public interface IAuthorization
extends IOpenShiftResource

Operations to manage and view authorization resources

Author:

Sean Kavanagh

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_EXPIRES_IN
static String	SCOPE_READ
static String	SCOPE_SESSION
static String	SCOPE_USERINFO

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this authorization
int	getExpiresIn() Returns the total time in seconds before this authorization expires.
String	getId() Returns the unique id for this authorization.
String	getNote() authorization note
String	getScopes() returns the scope of the authorization token to determine type of access.
String	getToken() Returns authorization string that contains user credentials.
void	refresh() Refreshes the authorization by reloading its content from OpenShift.

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, getMessages, hasCreationLog

Field Detail

SCOPE_SESSION

static final String SCOPE_SESSION

See Also:

Constant Field Values

SCOPE_READ

static final String SCOPE_READ

See Also:

Constant Field Values

SCOPE_USERINFO

static final String SCOPE_USERINFO

See Also:

Constant Field Values

NO_EXPIRES_IN

static final int NO_EXPIRES_IN

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the unique id for this authorization.

Returns:

getNote

String getNote()

authorization note

Returns:

getScopes

String getScopes()

returns the scope of the authorization token to determine type of access.

Returns:

getToken

String getToken()

Returns authorization string that contains user credentials.

Returns:

getExpiresIn

int getExpiresIn()

Returns the total time in seconds before this authorization expires.

Returns:

destroy

void destroy()
      throws OpenShiftException

Destroys this authorization

Throws:

OpenShiftException

refresh

void refresh()
      throws OpenShiftException

Refreshes the authorization by reloading its content from OpenShift.

Specified by:

refresh in interface IOpenShiftResource

Throws:

OpenShiftException