Package com.onshape.api.desktop

Class OnshapeDesktop

java.lang.Object

com.onshape.api.desktop.OnshapeDesktop

public class OnshapeDesktop
extends Object

Utility class for desktop based applications to launch Onshape client.

Author:

Peter Harman peter.harman@cae.tech

Constructor Summary

Constructors

Constructor	Description
OnshapeDesktop(String clientId, String clientSecret)	Creates a new instance with given application id.
OnshapeDesktop(String clientId, String clientSecret, int port)	Creates a new instance with given application id and port.

Method Summary

Modifier and Type	Method	Description
void	setupClient(BaseClient client)	Launches browser-based login and sets credentials on the given Onshape client instance.
void	setupClient(BaseClient client, OAuthTokenResponse token, Date tokenReceived)	Applies previously obtained OAuth token to the given Onshape client instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnshapeDesktop

public OnshapeDesktop(String clientId,
                      String clientSecret)

Creates a new instance with given application id.

Parameters:

clientId - Client ID of application.

clientSecret - Client secret of application.

OnshapeDesktop

public OnshapeDesktop(String clientId,
                      String clientSecret,
                      int port)

Creates a new instance with given application id and port.

Parameters:

clientId - Client ID of application.

clientSecret - Client secret of application.

port - Network port to use for HTTP server.

Method Detail

setupClient

public void setupClient(BaseClient client)
                 throws OnshapeException

Launches browser-based login and sets credentials on the given Onshape client instance.

Parameters:

client - An Onshape API client instance.

Throws:

OnshapeException - On HTTP, authentication, or serialization, error.

setupClient

public void setupClient(BaseClient client,
                        OAuthTokenResponse token,
                        Date tokenReceived)

Applies previously obtained OAuth token to the given Onshape client instance.

Parameters:

client - An Onshape API client instance.

token - An OAuth token previously obtained.

tokenReceived - The time at which the token was obtained.