Package com.structurizr.api

Class StructurizrClient

java.lang.Object

com.structurizr.api.AbstractApiClient

com.structurizr.api.WorkspaceApiClient

com.structurizr.api.StructurizrClient

@Deprecated
public class StructurizrClient
extends WorkspaceApiClient

Deprecated.

Use WorkspaceApiClient instead

A client for the Structurizr workspace API that allows you to get and put Structurizr workspaces in a JSON format.

Field Summary

Fields inherited from class com.structurizr.api.AbstractApiClient

agent, STRUCTURIZR_CLOUD_SERVICE_API_URL, STRUCTURIZR_FOR_JAVA_AGENT, url, VERSION, WORKSPACE_PATH

Constructor Summary

Constructors

Constructor	Description
StructurizrClient()	Deprecated. Creates a new Structurizr client based upon configuration in a structurizr.properties file on the classpath with the following name-value pairs: - structurizr.api.url - structurizr.api.key - structurizr.api.secret
StructurizrClient(String apiKey, String apiSecret)	Deprecated.
StructurizrClient(String url, String apiKey, String apiSecret)	Deprecated.

Method Summary

Methods inherited from class com.structurizr.api.WorkspaceApiClient

getWorkspace, getWorkspaceArchiveLocation, lockWorkspace, putWorkspace, setApiKey, setApiSecret, setEncryptionStrategy, setIdGenerator, setMergeFromRemote, setUser, setWorkspaceArchiveLocation, unlockWorkspace

Methods inherited from class com.structurizr.api.AbstractApiClient

getAgent, setAgent, setUrl

Methods inherited from class java.lang.Object

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

Constructor Details

StructurizrClient

public StructurizrClient()
                  throws StructurizrClientException

Deprecated.

Creates a new Structurizr client based upon configuration in a structurizr.properties file on the classpath with the following name-value pairs: - structurizr.api.url - structurizr.api.key - structurizr.api.secret

Throws:

StructurizrClientException - if something goes wrong

StructurizrClient

public StructurizrClient(String apiKey,
 String apiSecret)

Deprecated.

StructurizrClient

public StructurizrClient(String url,
 String apiKey,
 String apiSecret)

Deprecated.