com.openshift.client

Interface IUser

All Superinterfaces:

IOpenShiftResource

All Known Implementing Classes:

UserResource

public interface IUser
extends IOpenShiftResource

Author:

André Dietisheim, Sean Kavanagh

Method Summary

Modifier and Type	Method and Description
IOpenShiftSSHKey	addSSHKey(String name, ISSHPublicKey key) Adds the given ssh key with the given name.
IAuthorization	createAuthorization(String note, String scopes) Creates and returns new authorization set for user
IAuthorization	createAuthorization(String note, String scopes, int expiresIn) Creates and returns new authorization set for user
IDomain	createDomain(String id)
void	deleteKey(String name) Deprecated.
IAuthorization	getAuthorization() Returns current authorization.
IAuthorization	getAuthorization(String id) Returns authorization using a token or id
Collection<IAuthorization>	getAuthorizations() Returns all current authorizations for a user
IOpenShiftConnection	getConnection()
int	getConsumedGears()
IDomain	getDefaultDomain()
IDomain	getDomain(String id)
List<IDomain>	getDomains()
String	getId()
int	getMaxGears()
String	getPassword()
String	getRhlogin()
String	getServer()
IOpenShiftSSHKey	getSSHKeyByName(String name)
IOpenShiftSSHKey	getSSHKeyByPublicKey(String publicKey)
List<IOpenShiftSSHKey>	getSSHKeys()
boolean	hasDomain()
boolean	hasDomain(String id)
boolean	hasSSHKeyName(String name)
boolean	hasSSHPublicKey(String publicKey)
IOpenShiftSSHKey	putSSHKey(String name, ISSHPublicKey key) Deprecated.
boolean	removeAuthorization(String id) Removes authorization using a token or id
boolean	removeSSHKey(String name)

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, getMessages, hasCreationLog, refresh

Method Detail

getId

String getId()

getRhlogin

String getRhlogin()

getPassword

String getPassword()

getServer

String getServer()

getConnection

IOpenShiftConnection getConnection()

createDomain

IDomain createDomain(String id)
              throws OpenShiftException

Throws:

OpenShiftException

getDomains

List<IDomain> getDomains()
                  throws OpenShiftException

Throws:

OpenShiftException

getDefaultDomain

IDomain getDefaultDomain()
                  throws OpenShiftException

Throws:

OpenShiftException

getDomain

IDomain getDomain(String id)
           throws OpenShiftException

Throws:

OpenShiftException

hasDomain

boolean hasDomain()
           throws OpenShiftException

Throws:

OpenShiftException

hasDomain

boolean hasDomain(String id)
           throws OpenShiftException

Throws:

OpenShiftException

getSSHKeys

List<IOpenShiftSSHKey> getSSHKeys()
                           throws OpenShiftException

Throws:

OpenShiftException

getAuthorization

IAuthorization getAuthorization()
                         throws OpenShiftException

Returns current authorization. Creates new authorization for user if none exists. Authorization is set by default when token is used to create API connection.

Returns:

authorization

Throws:

OpenShiftException

getAuthorization

IAuthorization getAuthorization(String id)
                         throws OpenShiftException

Returns authorization using a token or id

Parameters:

id - authorization token or id

Returns:

authorization

Throws:

OpenShiftException

getAuthorizations

Collection<IAuthorization> getAuthorizations()
                                      throws OpenShiftException

Returns all current authorizations for a user

Returns:

all authorizations

Throws:

OpenShiftException

createAuthorization

IAuthorization createAuthorization(String note,
                                   String scopes)
                            throws OpenShiftException

Creates and returns new authorization set for user

Parameters:

note - A reminder description of what the authorization is for.

scopes - Scope of the authorization token to determine type of access.

Returns:

authorization

Throws:

OpenShiftException

createAuthorization

IAuthorization createAuthorization(String note,
                                   String scopes,
                                   int expiresIn)
                            throws OpenShiftException

Creates and returns new authorization set for user

Parameters:

note - A reminder description of what the authorization is for.

scopes - Scope of the authorization token to determine type of access.

expiresIn - The number of seconds before this authorization expires.

Returns:

authorization

Throws:

OpenShiftException

removeAuthorization

boolean removeAuthorization(String id)
                     throws OpenShiftException

Removes authorization using a token or id

Parameters:

id - authorization token or id

Returns:

success or fail

Throws:

OpenShiftException

putSSHKey

@Deprecated
IOpenShiftSSHKey putSSHKey(String name,
                                       ISSHPublicKey key)
                                throws OpenShiftException

Deprecated.

Deprecated, use addSSHKey(String, ISSHPublicKey)

Parameters:

name - key name to use

key - the key to put/add

Returns:

Throws:

OpenShiftException

addSSHKey

IOpenShiftSSHKey addSSHKey(String name,
                           ISSHPublicKey key)
                    throws OpenShiftException

Adds the given ssh key with the given name. Key names and public keys have to be unique. Throws OpenShiftSSHKeyException if either the key name or the public key are already used.

Parameters:

name - the name to identify the key

key - the key to add

Returns:

Throws:

OpenShiftException

getSSHKeyByName

IOpenShiftSSHKey getSSHKeyByName(String name)
                          throws OpenShiftUnknonwSSHKeyTypeException,
                                 OpenShiftException

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

getSSHKeyByPublicKey

IOpenShiftSSHKey getSSHKeyByPublicKey(String publicKey)
                               throws OpenShiftUnknonwSSHKeyTypeException,
                                      OpenShiftException

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

hasSSHKeyName

boolean hasSSHKeyName(String name)
               throws OpenShiftUnknonwSSHKeyTypeException,
                      OpenShiftException

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

hasSSHPublicKey

boolean hasSSHPublicKey(String publicKey)
                 throws OpenShiftUnknonwSSHKeyTypeException,
                        OpenShiftException

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

removeSSHKey

boolean removeSSHKey(String name)

deleteKey

@Deprecated
void deleteKey(String name)

Deprecated.

getMaxGears

int getMaxGears()

getConsumedGears

int getConsumedGears()