com.openshift.internal.client

Class APIResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.APIResource

All Implemented Interfaces:

IOpenShiftConnection, IOpenShiftResource

public class APIResource
extends AbstractOpenShiftResource
implements IOpenShiftConnection

Author:

Andre Dietisheim, Xavier Coulon, Sean Kavanagh

Nested Class Summary

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

AbstractOpenShiftResource.Parameters, AbstractOpenShiftResource.ServiceRequest

Field Summary

Fields inherited from interface com.openshift.client.IOpenShiftConnection

DEFAULT_CLIENT_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	APIResource(String token, IRestService service, Map<String,Link> links)
protected	APIResource(String login, String password, String token, IRestService service, Map<String,Link> links)

Method Summary

Modifier and Type	Method and Description
IAuthorization	createAuthorization(String note, String scopes)
protected AuthorizationResource	createAuthorization(String note, String scopes, Integer expiresIn)
IDomain	createDomain(String id)
void	disconnect()
protected <C extends ICartridge> List<C>	filterObsolete(boolean includeObsolete, List<C> allCartridges)
IAuthorization	getAuthorization()
IAuthorization	getAuthorization(String id)
List<IAuthorization>	getAuthorizations()
List<ICartridge>	getCartridges() Returns all the available cartridges, embeddable and standalone ones.
List<ICartridge>	getCartridges(boolean includeObsolete) Returns all the available cartridges, embeddable and standalone ones.
IDomain	getDefaultDomain()
IDomain	getDomain(String id)
List<IDomain>	getDomains() Returns the domains associated with the current OpenShift connection.
List<IEmbeddableCartridge>	getEmbeddableCartridges() Returns the available embeddable cartridges associated with the current OpenShift connection.
List<IEmbeddableCartridge>	getEmbeddableCartridges(boolean includeObsolete) Returns the available embeddable cartridges associated with the current OpenShift connection.
ExecutorService	getExecutorService() Returns the executor service instance that's available in this connection.
protected String	getLogin()
protected AuthorizationResource	getOrCreateAuthorization(String token)
protected List<IEmbeddableCartridge>	getOrLoadEmbeddableCartridges()
protected List<IStandaloneCartridge>	getOrLoadStandaloneCartridges()
protected String	getPassword()
List<IQuickstart>	getQuickstarts() Returns the available quickstarts associated with the current OpenShift connection.
String	getServer() Returns the server this connection is bound to.
List<IStandaloneCartridge>	getStandaloneCartridges() Returns the available standalone cartridges associated with the current OpenShift connection.
List<IStandaloneCartridge>	getStandaloneCartridges(boolean includeObsolete) Returns the available standalone cartridges associated with the current OpenShift connection.
IUser	getUser() Returns the user associated with the current OpenShift connection.
protected boolean	hasDomain(String name)
void	refresh() Refresh the resource and its list of children resources that were previously loaded
protected void	removeAuthorization()
protected void	removeDomain(IDomain domain) Called after a domain has been destroyed
IDomain	showDomain(String id)

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, toString, wait, wait, wait

Constructor Detail

APIResource

protected APIResource(String token,
                      IRestService service,
                      Map<String,Link> links)

APIResource

protected APIResource(String login,
                      String password,
                      String token,
                      IRestService service,
                      Map<String,Link> links)

Method Detail

getLogin

protected final String getLogin()

getPassword

protected final String getPassword()

getServer

public String getServer()

Description copied from interface: IOpenShiftConnection

Returns the server this connection is bound to.

Specified by:

getServer in interface IOpenShiftConnection

Returns:

the server

getUser

public IUser getUser()
              throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the user associated with the current OpenShift connection.

Specified by:

getUser in interface IOpenShiftConnection

Returns:

the user

Throws:

OpenShiftException

createAuthorization

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

Throws:

OpenShiftException

createAuthorization

protected AuthorizationResource createAuthorization(String note,
                                                    String scopes,
                                                    Integer expiresIn)
                                             throws OpenShiftException

Throws:

OpenShiftException

removeAuthorization

protected void removeAuthorization()

getOrCreateAuthorization

protected AuthorizationResource getOrCreateAuthorization(String token)

getAuthorization

public IAuthorization getAuthorization()
                                throws OpenShiftException

Throws:

OpenShiftException

getAuthorization

public IAuthorization getAuthorization(String id)
                                throws OpenShiftException

Throws:

OpenShiftException

getAuthorizations

public List<IAuthorization> getAuthorizations()
                                       throws OpenShiftException

Throws:

OpenShiftException

getDomains

public List<IDomain> getDomains()
                         throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the domains associated with the current OpenShift connection.

Specified by:

getDomains in interface IOpenShiftConnection

Returns:

the domains

Throws:

OpenShiftException

getDomain

public IDomain getDomain(String id)
                  throws OpenShiftException

Throws:

OpenShiftException

getDefaultDomain

public IDomain getDefaultDomain()

createDomain

public IDomain createDomain(String id)
                     throws OpenShiftException

Throws:

OpenShiftException

showDomain

public IDomain showDomain(String id)
                   throws OpenShiftException

Throws:

OpenShiftException

getStandaloneCartridges

public List<IStandaloneCartridge> getStandaloneCartridges()
                                                   throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the available standalone cartridges associated with the current OpenShift connection. Obsolete cartridges are not reported.

Specified by:

getStandaloneCartridges in interface IOpenShiftConnection

Returns:

the available standalone cartridges

Throws:

OpenShiftException

getStandaloneCartridges

public List<IStandaloneCartridge> getStandaloneCartridges(boolean includeObsolete)
                                                   throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the available standalone cartridges associated with the current OpenShift connection.

Specified by:

getStandaloneCartridges in interface IOpenShiftConnection

Parameters:

includeObsolete - include obsolete cartridges

Returns:

the available standalone cartridges

Throws:

OpenShiftException

getOrLoadStandaloneCartridges

protected List<IStandaloneCartridge> getOrLoadStandaloneCartridges()
                                                            throws OpenShiftException

Throws:

OpenShiftException

getEmbeddableCartridges

public List<IEmbeddableCartridge> getEmbeddableCartridges()
                                                   throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the available embeddable cartridges associated with the current OpenShift connection. Obsolete cartridges are not reported.

Specified by:

getEmbeddableCartridges in interface IOpenShiftConnection

Returns:

the available embeddable cartridges

Throws:

OpenShiftException

getEmbeddableCartridges

public List<IEmbeddableCartridge> getEmbeddableCartridges(boolean includeObsolete)
                                                   throws OpenShiftException

Description copied from interface: IOpenShiftConnection

Returns the available embeddable cartridges associated with the current OpenShift connection.

Specified by:

getEmbeddableCartridges in interface IOpenShiftConnection

Parameters:

includeObsolete - include obsolete cartridges

Returns:

the available embeddable cartridges

Throws:

OpenShiftException

getOrLoadEmbeddableCartridges

protected List<IEmbeddableCartridge> getOrLoadEmbeddableCartridges()
                                                            throws OpenShiftException

Throws:

OpenShiftException

filterObsolete

protected <C extends ICartridge> List<C> filterObsolete(boolean includeObsolete,
                                                        List<C> allCartridges)

getCartridges

public List<ICartridge> getCartridges()

Description copied from interface: IOpenShiftConnection

Returns all the available cartridges, embeddable and standalone ones. Obsolete cartridges are not reported.

Specified by:

getCartridges in interface IOpenShiftConnection

Returns:

the all the available cartridges

getCartridges

public List<ICartridge> getCartridges(boolean includeObsolete)

Description copied from interface: IOpenShiftConnection

Returns all the available cartridges, embeddable and standalone ones.

Specified by:

getCartridges in interface IOpenShiftConnection

Parameters:

includeObsolete - whether to include obsolete cartridges or not.

Returns:

the all the available cartridges

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

removeDomain

protected void removeDomain(IDomain domain)

Called after a domain has been destroyed

Parameters:

domain - the domain to remove from the API's domains list.

hasDomain

protected boolean hasDomain(String name)
                     throws OpenShiftException

Throws:

OpenShiftException

getQuickstarts

public List<IQuickstart> getQuickstarts()

Description copied from interface: IOpenShiftConnection

Returns the available quickstarts associated with the current OpenShift connection.

Specified by:

getQuickstarts in interface IOpenShiftConnection

Returns:

the available quickstarts

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: IOpenShiftConnection

Returns the executor service instance that's available in this connection.

Specified by:

getExecutorService in interface IOpenShiftConnection

Returns:

the executor service instance for this connection

See Also:

ExecutorService, Executors

disconnect

public void disconnect()