com.openshift.internal.client

Class RestService

java.lang.Object

com.openshift.internal.client.RestService

All Implemented Interfaces:

IRestService

public class RestService
extends Object
implements IRestService

Author:

André Dietisheim

Field Summary

Fields inherited from interface com.openshift.internal.client.IRestService

SERVICE_PATH, SERVICE_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	RestService(String server, String clientId, IMediaType defaultRequestMediaType, String acceptedMediaType, IRestResponseFactory factory, IHttpClient client)
protected	RestService(String server, String clientId, IMediaType defaultRequestMediaType, String acceptedMediaType, IRestResponseFactory factory, IHttpClient client, RestServiceProperties properties)
protected	RestService(String server, String clientId, String protocolVersion, IMediaType defaultRequestMediaType, String acceptedMediaType, IRestResponseFactory factory, IHttpClient client, RestServiceProperties properties)

Method Summary

Modifier and Type	Method and Description
String	getPlatformUrl() Returns the OpenShift server.
String	getServiceUrl() Returns the url for the OpenShift service, the endpoint which this rest service class is talking to.
RestResponse	request(Link link, int timeout, IMediaType requestMediaType, IRestResponseFactory responseFactory, List<Parameter> urlPathParameter, List<Parameter> urlParameters, Parameter... parameters) Requests the given link sending the given parameters while encoding the parameters with the given media type and respecting the given timeout.
RestResponse	request(Link link, int timeout, IRestResponseFactory responseFactory, List<Parameter> urlPathParameters, List<Parameter> urlParameters, Parameter... parameters)
RestResponse	request(Link link, int timeout, List<Parameter> urlPathParameters, List<Parameter> urlParameters, Parameter... parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestService

public RestService(String server,
                   String clientId,
                   IMediaType defaultRequestMediaType,
                   String acceptedMediaType,
                   IRestResponseFactory factory,
                   IHttpClient client)

RestService

protected RestService(String server,
                      String clientId,
                      IMediaType defaultRequestMediaType,
                      String acceptedMediaType,
                      IRestResponseFactory factory,
                      IHttpClient client,
                      RestServiceProperties properties)

RestService

protected RestService(String server,
                      String clientId,
                      String protocolVersion,
                      IMediaType defaultRequestMediaType,
                      String acceptedMediaType,
                      IRestResponseFactory factory,
                      IHttpClient client,
                      RestServiceProperties properties)

Method Detail

request

public RestResponse request(Link link,
                            int timeout,
                            List<Parameter> urlPathParameters,
                            List<Parameter> urlParameters,
                            Parameter... parameters)
                     throws OpenShiftException

Specified by:

request in interface IRestService

Throws:

OpenShiftException

request

public RestResponse request(Link link,
                            int timeout,
                            IRestResponseFactory responseFactory,
                            List<Parameter> urlPathParameters,
                            List<Parameter> urlParameters,
                            Parameter... parameters)
                     throws OpenShiftException

Specified by:

request in interface IRestService

Throws:

OpenShiftException

request

public RestResponse request(Link link,
                            int timeout,
                            IMediaType requestMediaType,
                            IRestResponseFactory responseFactory,
                            List<Parameter> urlPathParameter,
                            List<Parameter> urlParameters,
                            Parameter... parameters)
                     throws OpenShiftException

Description copied from interface: IRestService

Requests the given link sending the given parameters while encoding the parameters with the given media type and respecting the given timeout. Parameters are supported in 3 different forms:

• in the request body (ignored for GET requests)
• in the url (url-parameters: ?parameter=value)
• in the url path (url-path-parameters: /applications/:application)

Specified by:

request in interface IRestService

Parameters:

link - the link to use

timeout - the timeout in millis (or IHttpClient.NO_TIMEOUT)

urlPathParameter - the parameters in the url ("/applications/:applicationname")

urlParameters - the url parameters ("?parameter=value")

parameters - the body parameters (ingnored for GET requests)

Returns:

the rest response

Throws:

OpenShiftException

See Also:

Link, Parameter, IMediaType, IHttpClient.NO_TIMEOUT, IHttpClient.SYSPROP_DEFAULT_CONNECT_TIMEOUT, IHttpClient.SYSPROP_DEFAULT_READ_TIMEOUT, IHttpClient.SYSPROP_OPENSHIFT_CONNECT_TIMEOUT, IHttpClient.DEFAULT_READ_TIMEOUT

getServiceUrl

public String getServiceUrl()

Description copied from interface: IRestService

Returns the url for the OpenShift service, the endpoint which this rest service class is talking to.

Specified by:

getServiceUrl in interface IRestService

Returns:

the url of the OpenShift service

getPlatformUrl

public String getPlatformUrl()

Description copied from interface: IRestService

Returns the OpenShift server.

Specified by:

getPlatformUrl in interface IRestService

Returns: