com.openshift.internal.client

Interface IRestService

All Known Implementing Classes:

RestService

public interface IRestService

A rest service that executes request against the OpenShift server

Author:

Andre Dietisheim

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH
static String	SERVICE_VERSION

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 mediaType, IRestResponseFactory responseFactory, List<Parameter> urlPathParameters, 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)

Field Detail

SERVICE_VERSION

static final String SERVICE_VERSION

See Also:

Constant Field Values

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

request

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

Throws:

OpenShiftException

request

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

Throws:

OpenShiftException

request

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

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)

Parameters:

link - the link to use

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

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

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

parameters - the body parameters (ingnored for GET requests)

parameters - the parameters to send

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

String getServiceUrl()

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

Returns:

the url of the OpenShift service

getPlatformUrl

String getPlatformUrl()

Returns the OpenShift server.

Returns: