com.dev9.sauce

Class SauceRESTRequestBuilder

java.lang.Object

com.dev9.sauce.SauceRESTRequestBuilder

public class SauceRESTRequestBuilder
extends Object

Builder for SauceRESTRequest. Can be used to construct the URL incrementally. Provides default values and serialization of maps to JSON strings. User: yurodivuie Date: 2/29/12 Time: 11:06 AM

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION
static String	REST_URL

Constructor Summary

Constructors

Constructor and Description
SauceRESTRequestBuilder()

Method Summary

Modifier and Type	Method and Description
SauceRESTRequestBuilder	addGenericSuffix(String suffix) Adds a string to the path.
SauceRESTRequestBuilder	addJobIdToPath(String jobId) Adds a job id to the path.
SauceRESTRequestBuilder	addJobsToPath() Adds standard "/jobs" section to constructed url.
SauceRESTRequestBuilder	addJSON(String key, Object value) Adds an entry to the object map that will be serialized into JSON string in the request.
SauceRESTRequestBuilder	addUserIdToPath(String user) Adds a user name to the path.
SauceRESTRequestBuilder	addUsersToPath() Adds standard "/users" section to constructed url.
SauceRESTRequest	build() Constructs the SauceRESTRequest object from combination of defaults and overrides.
SauceRESTRequestBuilder	setHTTPMethod(String method)
SauceRESTRequestBuilder	setVersion(String version) Sets the version ("v1" is the default).

Methods inherited from class java.lang.Object

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

Field Detail

REST_URL

public static final String REST_URL

See Also:

Constant Field Values

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

Constant Field Values

Constructor Detail

SauceRESTRequestBuilder

public SauceRESTRequestBuilder()

Method Detail

addJSON

public SauceRESTRequestBuilder addJSON(String key,
                                       Object value)

Adds an entry to the object map that will be serialized into JSON string in the request.

Parameters:

key - String key for the json object.

value - Value can be discrete or a list, map.

Returns:

this object

setHTTPMethod

public SauceRESTRequestBuilder setHTTPMethod(String method)

addUsersToPath

public SauceRESTRequestBuilder addUsersToPath()

Adds standard "/users" section to constructed url. Does not check location in path.

Returns:

this object

addUserIdToPath

public SauceRESTRequestBuilder addUserIdToPath(String user)

Adds a user name to the path. Does not check location in path.

Parameters:

user - A Sauce Labs user name.

Returns:

this object

addJobsToPath

public SauceRESTRequestBuilder addJobsToPath()

Adds standard "/jobs" section to constructed url. Does not check location in path.

Returns:

this object

addJobIdToPath

public SauceRESTRequestBuilder addJobIdToPath(String jobId)

Adds a job id to the path. Does not check location in path.

Returns:

this object

addGenericSuffix

public SauceRESTRequestBuilder addGenericSuffix(String suffix)

Adds a string to the path. Does not check location. May require a leading slash.

Parameters:

suffix - Any string to add to the constructed path.

Returns:

this object

setVersion

public SauceRESTRequestBuilder setVersion(String version)

Sets the version ("v1" is the default).

Parameters:

version - The version of the REST api in the path.

Returns:

this object

build

public SauceRESTRequest build()

Constructs the SauceRESTRequest object from combination of defaults and overrides.

Returns:

the sauce request