com.openshift.internal.client

Class UserResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.UserResource

All Implemented Interfaces:

IOpenShiftResource, IUser

public class UserResource
extends AbstractOpenShiftResource
implements IUser

Author:

André Dietisheim, Sean Kavanagh

Nested Class Summary

Nested classes/interfaces inherited from class com.openshift.internal.client.AbstractOpenShiftResource

AbstractOpenShiftResource.Parameters, AbstractOpenShiftResource.ServiceRequest

Constructor Summary

Constructors

Constructor and Description
UserResource(APIResource api, UserResourceDTO dto, String password)

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, use IUser.addSSHKey(String, ISSHPublicKey)
void	refresh() Refresh the resource and its list of children resources that were previously loaded
boolean	removeAuthorization(String id) Removes authorization using a token or id
protected void	removeSSHKey(SSHKeyResource key)
boolean	removeSSHKey(String name)
String	toString()

Methods inherited from class com.openshift.internal.client.AbstractOpenShiftResource

getCreationLog, getLink, getMessages, hasCreationLog, setLinks

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, getMessages, hasCreationLog

Constructor Detail

UserResource

public UserResource(APIResource api,
                    UserResourceDTO dto,
                    String password)

Method Detail

getConnection

public IOpenShiftConnection getConnection()

Specified by:

getConnection in interface IUser

getId

public String getId()

Specified by:

getId in interface IUser

getRhlogin

public String getRhlogin()

Specified by:

getRhlogin in interface IUser

getPassword

public String getPassword()

Specified by:

getPassword in interface IUser

getServer

public String getServer()

Specified by:

getServer in interface IUser

getMaxGears

public int getMaxGears()

Specified by:

getMaxGears in interface IUser

getConsumedGears

public int getConsumedGears()

Specified by:

getConsumedGears in interface IUser

createDomain

public IDomain createDomain(String id)
                     throws OpenShiftException

Specified by:

createDomain in interface IUser

Throws:

OpenShiftException

getDomains

public List<IDomain> getDomains()
                         throws OpenShiftException

Specified by:

getDomains in interface IUser

Throws:

OpenShiftException

getDefaultDomain

public IDomain getDefaultDomain()
                         throws OpenShiftException

Specified by:

getDefaultDomain in interface IUser

Throws:

OpenShiftException

getDomain

public IDomain getDomain(String id)
                  throws OpenShiftException

Specified by:

getDomain in interface IUser

Throws:

OpenShiftException

hasDomain

public boolean hasDomain()
                  throws OpenShiftException

Specified by:

hasDomain in interface IUser

Throws:

OpenShiftException

hasDomain

public boolean hasDomain(String id)
                  throws OpenShiftException

Specified by:

hasDomain in interface IUser

Throws:

OpenShiftException

createAuthorization

public IAuthorization createAuthorization(String note,
                                          String scopes)
                                   throws OpenShiftException

Description copied from interface: IUser

Creates and returns new authorization set for user

Specified by:

createAuthorization in interface IUser

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

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

Description copied from interface: IUser

Creates and returns new authorization set for user

Specified by:

createAuthorization in interface IUser

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

getAuthorization

public IAuthorization getAuthorization()
                                throws OpenShiftException

Description copied from interface: IUser

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

Specified by:

getAuthorization in interface IUser

Returns:

authorization

Throws:

OpenShiftException

getAuthorization

public IAuthorization getAuthorization(String id)
                                throws OpenShiftException

Description copied from interface: IUser

Returns authorization using a token or id

Specified by:

getAuthorization in interface IUser

Parameters:

id - authorization token or id

Returns:

authorization

Throws:

OpenShiftException

getAuthorizations

public Collection<IAuthorization> getAuthorizations()
                                             throws OpenShiftException

Description copied from interface: IUser

Returns all current authorizations for a user

Specified by:

getAuthorizations in interface IUser

Returns:

all authorizations

Throws:

OpenShiftException

removeAuthorization

public boolean removeAuthorization(String id)

Description copied from interface: IUser

Removes authorization using a token or id

Specified by:

removeAuthorization in interface IUser

Parameters:

id - authorization token or id

Returns:

success or fail

refresh

public void refresh()
             throws OpenShiftException

Description copied from interface: IOpenShiftResource

Refresh the resource and its list of children resources that were previously loaded

Specified by:

refresh in interface IOpenShiftResource

Throws:

OpenShiftException

getSSHKeys

public List<IOpenShiftSSHKey> getSSHKeys()
                                  throws OpenShiftUnknonwSSHKeyTypeException,
                                         OpenShiftException

Specified by:

getSSHKeys in interface IUser

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

removeSSHKey

public boolean removeSSHKey(String name)

Specified by:

removeSSHKey in interface IUser

deleteKey

@Deprecated
public void deleteKey(String name)

Deprecated.

Specified by:

deleteKey in interface IUser

getSSHKeyByName

public IOpenShiftSSHKey getSSHKeyByName(String name)
                                 throws OpenShiftUnknonwSSHKeyTypeException,
                                        OpenShiftException

Specified by:

getSSHKeyByName in interface IUser

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

getSSHKeyByPublicKey

public IOpenShiftSSHKey getSSHKeyByPublicKey(String publicKey)
                                      throws OpenShiftUnknonwSSHKeyTypeException,
                                             OpenShiftException

Specified by:

getSSHKeyByPublicKey in interface IUser

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

hasSSHKeyName

public boolean hasSSHKeyName(String name)
                      throws OpenShiftUnknonwSSHKeyTypeException,
                             OpenShiftException

Specified by:

hasSSHKeyName in interface IUser

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

hasSSHPublicKey

public boolean hasSSHPublicKey(String publicKey)
                        throws OpenShiftUnknonwSSHKeyTypeException,
                               OpenShiftException

Specified by:

hasSSHPublicKey in interface IUser

Throws:

OpenShiftUnknonwSSHKeyTypeException

OpenShiftException

putSSHKey

public IOpenShiftSSHKey putSSHKey(String name,
                                  ISSHPublicKey key)
                           throws OpenShiftException

Description copied from interface: IUser

Deprecated, use IUser.addSSHKey(String, ISSHPublicKey)

Specified by:

putSSHKey in interface IUser

Parameters:

name - key name to use

key - the key to put/add

Returns:

Throws:

OpenShiftException

addSSHKey

public IOpenShiftSSHKey addSSHKey(String name,
                                  ISSHPublicKey key)
                           throws OpenShiftException

Description copied from interface: IUser

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.

Specified by:

addSSHKey in interface IUser

Parameters:

name - the name to identify the key

key - the key to add

Returns:

Throws:

OpenShiftException

removeSSHKey

protected void removeSSHKey(SSHKeyResource key)

toString

public String toString()

Overrides:

toString in class Object