Package com.onshape.api.base

Class BaseClient

java.lang.Object

com.onshape.api.base.BaseClient

Direct Known Subclasses:

Onshape

public class BaseClient
extends Object

Author:

Peter Harman peter.harman@cae.tech

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseClient.RequestListener	Listener interface for HTTP requests and their responses.
static interface	BaseClient.ResponseListener	Listener for response objects, returned from a RequestListener

Field Summary

Fields

Modifier and Type	Field	Description
static String	ONSHAPE_JSON_V1
static String	ONSHAPE_OCTET_STREAM_V1
static String	ONSHAPE_OCTET_STREAM_V2

Constructor Summary

Constructors

Constructor	Description
BaseClient()

Method Summary

Modifier and Type	Method	Description
void	addRequestListener(BaseClient.RequestListener listener)	Add a listener to capture request and response for each HTTP call
Map<String,Object>	buildMap(Object... objs)	Utility method to construct a Map from a varargs array of Objects.
<T> T	call(String method, String url, Object payload, Map<String,Object> urlParameters, Map<String,Object> queryParameters, Class<T> type)	Performs the HTTP call and transforms the result to the required class.
<T> T	get(String url, Class<T> type)	Shortcut for GET of specific URL
String	getBaseURL()	Get the base URL this client is currently pointed at
String	getOauthURL()
PollingHandler	getPollingHandler()	Fetches utility object for polling GET requests via this client.
OAuthTokenResponse	getToken()	Get the active OAuth token
Date	getTokenReceived()	Get the time at which the OAuth token was received.
File	getWorkingDir()	Gets the directory that saved files will be stored in
boolean	isUsingValidation()	Check whether the client is using validation of required fields before HTTP methods are called
void	refreshOAuthToken()	Refresh the OAuth token previously fetched
void	removeRequestListener(BaseClient.RequestListener listener)	Remove a listener
void	setAPICredentials(String accessKey, String secretKey)	Set credentials for using API keys
void	setBaseURL(String baseURL)	Set the base URL this client should point at
void	setOAuthAccessCode(String code, String clientId, String clientSecret, String redirectURI)	Set an access code received from an OAuth request.
void	setOAuthTokenResponse(OAuthTokenResponse token, Date tokenReceived, String clientId, String clientSecret)	Set a previously requested OAuth token
void	setOAuthTokenResponse(OAuthTokenResponse token, Date tokenReceived, String clientId, String clientSecret, String redirectURI)	Set a previously requested OAuth token
void	setOauthURL(String oauthURL)
void	setUsingValidation(boolean usingValidation)	Set whether the client is using validation of required fields before HTTP methods are called
void	setWorkingDir(File workingDir)	Sets the directory that saved files will be stored in
static String	toString(Object obj)	Serializes objects to pretty-printed JSON.
<T> void	validate(T obj)	Use javax.validation framework to validate request object before sending to server.
OnshapeVersion	version()	Get the current Onshape version

Methods inherited from class java.lang.Object

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

Field Detail

ONSHAPE_JSON_V1

public static final String ONSHAPE_JSON_V1

See Also:

Constant Field Values

ONSHAPE_OCTET_STREAM_V1

public static final String ONSHAPE_OCTET_STREAM_V1

See Also:

Constant Field Values

ONSHAPE_OCTET_STREAM_V2

public static final String ONSHAPE_OCTET_STREAM_V2

See Also:

Constant Field Values

Constructor Detail

BaseClient

public BaseClient()

Method Detail

getBaseURL

public String getBaseURL()

Get the base URL this client is currently pointed at

Returns:

base URL

setBaseURL

public void setBaseURL(String baseURL)

Set the base URL this client should point at

Parameters:

baseURL - base URL

getOauthURL

public String getOauthURL()

setOauthURL

public void setOauthURL(String oauthURL)

isUsingValidation

public boolean isUsingValidation()

Check whether the client is using validation of required fields before HTTP methods are called

Returns:

true if validation is enabled

setUsingValidation

public void setUsingValidation(boolean usingValidation)

Set whether the client is using validation of required fields before HTTP methods are called

Parameters:

usingValidation - true if validation is desired

version

public OnshapeVersion version()
                       throws OnshapeException

Get the current Onshape version

Returns:

OnshapeVersion object

Throws:

OnshapeException - On HTTP error

setAPICredentials

public void setAPICredentials(String accessKey,
                              String secretKey)

Set credentials for using API keys

Parameters:

accessKey - API access key

secretKey - API secret key

setOAuthTokenResponse

public void setOAuthTokenResponse(OAuthTokenResponse token,
                                  Date tokenReceived,
                                  String clientId,
                                  String clientSecret)

Set a previously requested OAuth token

Parameters:

token - Token object from server

tokenReceived - Date that token was received

clientId - Client id of application

clientSecret - Client secret of application

setOAuthTokenResponse

public void setOAuthTokenResponse(OAuthTokenResponse token,
                                  Date tokenReceived,
                                  String clientId,
                                  String clientSecret,
                                  String redirectURI)

Set a previously requested OAuth token

Parameters:

token - Token object from server

tokenReceived - Date that token was received

clientId - Client id of application

clientSecret - Client secret of application

redirectURI - Redirect URI used for OAuth

getToken

public OAuthTokenResponse getToken()

Get the active OAuth token

Returns:

Token object stored in client

getTokenReceived

public Date getTokenReceived()

Get the time at which the OAuth token was received.

Returns:

Date token received

setOAuthAccessCode

public void setOAuthAccessCode(String code,
                               String clientId,
                               String clientSecret,
                               String redirectURI)
                        throws OnshapeException

Set an access code received from an OAuth request.

Parameters:

code - Code returned from server

clientId - Client id of application

clientSecret - Client secret of application

redirectURI - URI to redirect to after authentication

Throws:

OnshapeException - On HTTP or serialization error.

refreshOAuthToken

public void refreshOAuthToken()
                       throws OnshapeException

Refresh the OAuth token previously fetched

Throws:

OnshapeException - if no token previously set or if refresh call fails

getWorkingDir

public File getWorkingDir()

Gets the directory that saved files will be stored in

Returns:

Working directory

setWorkingDir

public void setWorkingDir(File workingDir)

Sets the directory that saved files will be stored in

Parameters:

workingDir - Working directory

call

public final <T> T call(String method,
                        String url,
                        Object payload,
                        Map<String,Object> urlParameters,
                        Map<String,Object> queryParameters,
                        Class<T> type)
                 throws OnshapeException

Performs the HTTP call and transforms the result to the required class.

Type Parameters:

T - Return type

Parameters:

method - HTTP method

url - URL

payload - Payload object for POST/PUT calls

urlParameters - Map of path parameters

queryParameters - Map of query parameters

type - Return type

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error.

get

public final <T> T get(String url,
                       Class<T> type)
                throws OnshapeException

Shortcut for GET of specific URL

Type Parameters:

T - Return type

Parameters:

url - URL

type - Return type

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

buildMap

public final Map<String,Object> buildMap(Object... objs)

Utility method to construct a Map from a varargs array of Objects.

Parameters:

objs - Array of name-value pairs.

Returns:

Map A map containing the names and values as keys and values.

toString

public static String toString(Object obj)

Serializes objects to pretty-printed JSON. Only to be used from generated classes.

Parameters:

obj - The Request or Response object

Returns:

String of pretty-printed JSON

Throws:

RuntimeException - On serialization error

validate

public <T> void validate(T obj)
                  throws OnshapeException

Use javax.validation framework to validate request object before sending to server.

Type Parameters:

T - Request object type

Parameters:

obj - Request object

Throws:

OnshapeException - If required fields are missing

getPollingHandler

public PollingHandler getPollingHandler()

Fetches utility object for polling GET requests via this client.

Returns:

PollingHandler instance

addRequestListener

public void addRequestListener(BaseClient.RequestListener listener)

Add a listener to capture request and response for each HTTP call

Parameters:

listener - The RequestListener implementation

removeRequestListener

public void removeRequestListener(BaseClient.RequestListener listener)

Remove a listener

Parameters:

listener - The RequestListener implementation