Index (structurizr-client 1.14.0 API)

A C D E F G J L P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AesEncryptionStrategy - Class in com.structurizr.encryption: This is implementation of an AES encryption strategy, allowing you to specify the key size, iteration count and passphrase.
AesEncryptionStrategy(int, int, String) - Constructor for class com.structurizr.encryption.AesEncryptionStrategy
AesEncryptionStrategy(int, int, String, String, String) - Constructor for class com.structurizr.encryption.AesEncryptionStrategy
AesEncryptionStrategy(String) - Constructor for class com.structurizr.encryption.AesEncryptionStrategy

C

Client - Enum constant in enum class com.structurizr.encryption.EncryptionLocation
com.structurizr.api - package com.structurizr.api
com.structurizr.encryption - package com.structurizr.encryption
com.structurizr.io - package com.structurizr.io
com.structurizr.io.json - package com.structurizr.io.json
com.structurizr.util - package com.structurizr.util
com.structurizr.view - package com.structurizr.view

D

decrypt(String) - Method in class com.structurizr.encryption.AesEncryptionStrategy
decrypt(String) - Method in class com.structurizr.encryption.EncryptionStrategy

E

encrypt(String) - Method in class com.structurizr.encryption.AesEncryptionStrategy
encrypt(String) - Method in class com.structurizr.encryption.EncryptionStrategy
EncryptedJsonReader - Class in com.structurizr.io.json
EncryptedJsonReader() - Constructor for class com.structurizr.io.json.EncryptedJsonReader
EncryptedJsonWriter - Class in com.structurizr.io.json
EncryptedJsonWriter(boolean) - Constructor for class com.structurizr.io.json.EncryptedJsonWriter
EncryptedWorkspace - Class in com.structurizr.encryption: This is a wrapper around an existing workspace that has been encrypted.
EncryptedWorkspace(Workspace, EncryptionStrategy) - Constructor for class com.structurizr.encryption.EncryptedWorkspace: Creates an encrypted version of the specified workspace.
EncryptedWorkspace(Workspace, String, EncryptionStrategy) - Constructor for class com.structurizr.encryption.EncryptedWorkspace
EncryptionLocation - Enum Class in com.structurizr.encryption
EncryptionStrategy - Class in com.structurizr.encryption: Superclass for all encryption strategies.
EncryptionStrategy() - Constructor for class com.structurizr.encryption.EncryptionStrategy
EncryptionStrategy(String) - Constructor for class com.structurizr.encryption.EncryptionStrategy

F

fromJson(String) - Static method in class com.structurizr.util.WorkspaceUtils: Converts the specified JSON string to a Workspace instance.

G

getAgent() - Method in class com.structurizr.api.StructurizrClient: Gets the agent string used to identify this client instance.
getCiphertext() - Method in class com.structurizr.encryption.EncryptedWorkspace
getEncryptionStrategy() - Method in class com.structurizr.encryption.EncryptedWorkspace
getIterationCount() - Method in class com.structurizr.encryption.AesEncryptionStrategy
getIv() - Method in class com.structurizr.encryption.AesEncryptionStrategy
getKeySize() - Method in class com.structurizr.encryption.AesEncryptionStrategy
getLocation() - Method in class com.structurizr.encryption.EncryptionStrategy
getPassphrase() - Method in class com.structurizr.encryption.EncryptionStrategy
getPlaintext() - Method in class com.structurizr.encryption.EncryptedWorkspace
getSalt() - Method in class com.structurizr.encryption.AesEncryptionStrategy
getUrl() - Method in class com.structurizr.api.StructurizrClient: Gets the API URL that this client is for.
getWorkspace() - Method in class com.structurizr.encryption.EncryptedWorkspace
getWorkspace(long) - Method in class com.structurizr.api.StructurizrClient: Gets the workspace with the given ID.
getWorkspaceArchiveLocation() - Method in class com.structurizr.api.StructurizrClient: Gets the location where a copy of the workspace is archived when it is retrieved from the server.

J

JsonReader - Class in com.structurizr.io.json: Reads a workspace definition as JSON.
JsonReader() - Constructor for class com.structurizr.io.json.JsonReader
JsonWriter - Class in com.structurizr.io.json: Writes a workspace definition as a JSON string.
JsonWriter(boolean) - Constructor for class com.structurizr.io.json.JsonWriter

L

loadThemes(Workspace) - Static method in class com.structurizr.view.ThemeUtils: Loads (and inlines) the element and relationship styles from the themes defined in the workspace, into the workspace itself.
loadWorkspaceFromJson(File) - Static method in class com.structurizr.util.WorkspaceUtils: Loads a workspace from a JSON definition saved as a file.
lockWorkspace(long) - Method in class com.structurizr.api.StructurizrClient: Locks the workspace with the given ID.

P

printWorkspaceAsJson(Workspace) - Static method in class com.structurizr.util.WorkspaceUtils: Prints a workspace as JSON to stdout - useful for debugging purposes.
putWorkspace(long, Workspace) - Method in class com.structurizr.api.StructurizrClient: Updates the given workspace.

R

read(Reader) - Method in class com.structurizr.io.json.EncryptedJsonReader: Reads and parses a workspace definition from a JSON document.
read(Reader) - Method in class com.structurizr.io.json.JsonReader: Reads and parses a workspace definition from a JSON document.
read(Reader) - Method in interface com.structurizr.io.WorkspaceReader: Reads and parses a workspace definition.

S

saveWorkspaceToJson(Workspace, File) - Static method in class com.structurizr.util.WorkspaceUtils: Saves a workspace to a JSON definition as a file.
Server - Enum constant in enum class com.structurizr.encryption.EncryptionLocation
setAgent(String) - Method in class com.structurizr.api.StructurizrClient: Sets the agent string used to identify this client instance.
setCiphertext(String) - Method in class com.structurizr.encryption.EncryptedWorkspace
setEncryptionStrategy(EncryptionStrategy) - Method in class com.structurizr.api.StructurizrClient: Sets the encryption strategy for use when getting or putting workspaces.
setEncryptionStrategy(EncryptionStrategy) - Method in class com.structurizr.encryption.EncryptedWorkspace
setIdGenerator(IdGenerator) - Method in class com.structurizr.api.StructurizrClient: Sets the ID generator to use when parsing a JSON workspace definition.
setIdGenerator(IdGenerator) - Method in class com.structurizr.io.json.JsonReader: Sets the ID generator to use when parsing a JSON workspace definition.
setLocation(EncryptionLocation) - Method in class com.structurizr.encryption.EncryptionStrategy
setMergeFromRemote(boolean) - Method in class com.structurizr.api.StructurizrClient: Specifies whether the layout of diagrams from a remote workspace should be retained when putting a new version of the workspace.
setPassphrase(String) - Method in class com.structurizr.encryption.EncryptionStrategy
setUser(String) - Method in class com.structurizr.api.StructurizrClient
setWorkspaceArchiveLocation(File) - Method in class com.structurizr.api.StructurizrClient: Sets the location where a copy of the workspace will be archived whenever it is retrieved from the server.
StructurizrClient - Class in com.structurizr.api: A client for the Structurizr API (https://api.structurizr.com) that allows you to get and put Structurizr workspaces in a JSON format.
StructurizrClient() - Constructor for class com.structurizr.api.StructurizrClient: 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, String) - Constructor for class com.structurizr.api.StructurizrClient: Creates a new Structurizr API client with the specified API key and secret, for the default API URL (https://api.structurizr.com).
StructurizrClient(String, String, String) - Constructor for class com.structurizr.api.StructurizrClient: Creates a new Structurizr client with the specified API URL, key and secret.
StructurizrClientException - Exception in com.structurizr.api: Thrown by the StructurizrClient when something goes wrong.

T

ThemeUtils - Class in com.structurizr.view: Some utility methods for exporting themes to JSON.
ThemeUtils() - Constructor for class com.structurizr.view.ThemeUtils
toJson(Workspace) - Static method in class com.structurizr.view.ThemeUtils: Serializes the theme (element and relationship styles) in the specified workspace to a JSON string.
toJson(Workspace, boolean) - Static method in class com.structurizr.util.WorkspaceUtils: Serializes the specified workspace to a JSON string.
toJson(Workspace, File) - Static method in class com.structurizr.view.ThemeUtils: Serializes the theme (element and relationship styles) in the specified workspace to a file, as a JSON string.

U

unlockWorkspace(long) - Method in class com.structurizr.api.StructurizrClient: Unlocks the workspace with the given ID.

V

valueOf(String) - Static method in enum class com.structurizr.encryption.EncryptionLocation: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.structurizr.encryption.EncryptionLocation: Returns an array containing the constants of this enum class, in the order they are declared.

W

WorkspaceReader - Interface in com.structurizr.io
WorkspaceReaderException - Exception in com.structurizr.io
WorkspaceReaderException(String, Throwable) - Constructor for exception com.structurizr.io.WorkspaceReaderException
WorkspaceUtils - Class in com.structurizr.util: Some utility methods related to workspaces.
WorkspaceUtils() - Constructor for class com.structurizr.util.WorkspaceUtils
WorkspaceWriter - Interface in com.structurizr.io
WorkspaceWriterException - Exception in com.structurizr.io
WorkspaceWriterException(String, Throwable) - Constructor for exception com.structurizr.io.WorkspaceWriterException
write(EncryptedWorkspace, Writer) - Method in class com.structurizr.io.json.EncryptedJsonWriter: Writes an encrypted workspace definition as a JSON string to the specified Writer object.
write(Workspace, Writer) - Method in class com.structurizr.io.json.JsonWriter: Writes a workspace definition as a JSON string to the specified Writer object.
write(Workspace, Writer) - Method in interface com.structurizr.io.WorkspaceWriter: Writes a workspace definition to the specified Writer object.

A C D E F G J L P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form