Package com.structurizr.api

Class AbstractApiClient

java.lang.Object

com.structurizr.api.AbstractApiClient

Direct Known Subclasses:

AdminApiClient, WorkspaceApiClient

public abstract class AbstractApiClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	agent
protected static final String	STRUCTURIZR_CLOUD_SERVICE_API_URL
protected static final String	STRUCTURIZR_FOR_JAVA_AGENT
protected String	url
protected static final String	VERSION
protected static final String	WORKSPACE_PATH

Constructor Summary

Constructors

Constructor	Description
AbstractApiClient()

Method Summary

Modifier and Type	Method	Description
String	getAgent()	Gets the agent string used to identify this client instance.
void	setAgent(String agent)	Sets the agent string used to identify this client instance.
protected void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Field Details

VERSION

protected static final String VERSION

STRUCTURIZR_FOR_JAVA_AGENT

protected static final String STRUCTURIZR_FOR_JAVA_AGENT

STRUCTURIZR_CLOUD_SERVICE_API_URL

protected static final String STRUCTURIZR_CLOUD_SERVICE_API_URL

See Also:

• Constant Field Values

WORKSPACE_PATH

protected static final String WORKSPACE_PATH

See Also:

• Constant Field Values

url

protected String url

agent

protected String agent

Constructor Details

AbstractApiClient

public AbstractApiClient()

Method Details

setUrl

protected void setUrl(String url)

getAgent

public String getAgent()

Gets the agent string used to identify this client instance.

Returns:

"structurizr-java/{version}", unless overridden

setAgent

public void setAgent(String agent)

Sets the agent string used to identify this client instance.

Parameters:

agent - the agent string