public class KwateeAPI extends Object
Modifier and Type | Method and Description |
---|---|
void |
close()
Clean logout from the session
|
void |
createArtifact(String artifactName,
String artifactProperties)
Creates a new artifact and optionally set additional properties
|
void |
createEnvironment(String environmentName,
String environmentProperties)
Creates a new environment and optionally sets additional properties.
|
static KwateeAPI |
createInstance(String serviceUrl)
Creates a new api connection instance
|
static KwateeAPI |
createInstance(String serviceUrl,
String authToken) |
static KwateeAPI |
createInstance(String serviceUrl,
String login,
String password) |
void |
createServer(String serverName,
String serverProperties)
Creates a new server and optionally sets additional properties
|
void |
createVersion(String artifactName,
String versionName,
String versionProperties)
Creates a version in an artifact and optionally set additional properties
|
void |
deleteArtifact(String artifactName)
Deletes an artifact
|
void |
deleteArtifactPackageOverlay(String artifactName,
String versionName,
String path)
Deletes an existing version overlay
|
void |
deleteEnvironment(String environmentName)
Deletes an environment
|
void |
deleteRelease(String environmentName,
String releaseName)
Deletes a release
|
void |
deleteReleasePackageOverlay(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path)
Deletes an existing release artifact overlay
|
void |
deleteServer(String serverName)
Deletes a server
|
void |
deleteVersion(String artifactName,
String versionName)
Deletes an artifact's version
|
void |
downloadArtifactPackageFile(String artifactName,
String versionName,
String path,
File downloadFile)
Downloads a file within the package in the specified location
|
void |
downloadInstaller(String environmentName,
String releaseName,
File downloadFile)
Downloads an installer in the specified location
|
void |
downloadLightweightInstaller(String environmentName,
String releaseName,
File downloadFile)
Downloads a self-contained command-line installer (to install one server at a time) in the specified location
|
void |
downloadReleasePackageFile(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path,
File downloadFile)
Downloads a file within the release artifact package in the specified location
|
void |
duplicateEnvironment(String environmentName,
String duplicateFrom,
String environmentProperties)
Duplicates an existing environment and optionally set additional properties.
|
void |
duplicateServer(String serverName,
String duplicateFrom,
String serverProperties)
Duplicates an existing server and optionally set additional properties
|
void |
duplicateVersion(String artifactName,
String versionName,
String duplicateFrom,
String versionProperties)
Duplicates an existing version and optionally set additional properties
|
String |
getArtifact(String artifactName)
Retrieves an artifact's properties
|
String |
getArtifactPackageFiles(String artifactName,
String versionName,
String path)
Retrieves the files present in a version's package at a given relative path
|
String |
getArtifacts()
Retrieves the list of artifacts in the repository
|
String |
getArtifactSpecialFiles(String artifactName,
String versionName)
Retrieves all the special files (overlays, with variables, with custom flags) within the package
|
String |
getArtifactVariables(String artifactName,
String versionName)
Retrieves the list of version variables
|
String |
getAuthToken() |
String |
getDeployment(String environmentName,
String releaseName)
Retrieves the deployment properties
|
String |
getDeployments()
Retrieves the list of deployments
|
String |
getEffectiveReleaseArtifacts(String environmentName,
String releaseName)
Retrieves the effective release artifacts (resolves defaultVersions/serverVersions)
|
String |
getEnvironment(String environmentName)
Retrieves an environment's properties
|
String |
getEnvironments()
Retrieves the list of environments in the repository
|
String |
getInfoConduitTypes()
Retrieves the available conduit types (ssh, ftp, ...)
|
String |
getInfoContext()
Retrieves kwatee information (version, ...)
|
String |
getInfoPlatforms()
Retrieves the available platforms (operating systems)
|
String |
getInfoServerPoolTypes()
Retrieves the available server pool types (ec2, ...)
|
String |
getOngoingOperation()
Retrieves an ongoing deployment operation
|
String |
getOperationProgress(String ref)
Retrieves the progress of a deployment operation
|
int |
getOperationStatus(String ref) |
String |
getProgressMessages(String ref,
String serverName,
String artifactName)
Retrieves the details of a deployment operation for a given server and or artifact
|
String |
getRelease(String environmentName,
String releaseName)
Retrieve an environment's release properties
|
String |
getReleasePackageFiles(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path)
Retrieves the files present in an release artifact package at a given relative path with the package
|
String |
getReleaseSpecialFiles(String environmentName,
String releaseName,
String artifactName,
String serverName)
Retrieves all the special files (overlays, with variables, with custom flags) within the release artifact
package
|
String |
getReleaseVariables(String environmentName,
String releaseName)
Retrieves the list of release variables
|
String |
getServer(String serverName)
Retrieves the properties of a server
|
String |
getServers()
Retrieves the list of servers in the repository
|
String |
getVersion(String artifactName,
String versionName)
Retrieves the properties of an artifact's version
|
void |
importActifactsBundle(File bundleFile)
Uploads (Http Post) an artifacts bundle into the repository
|
void |
importActifactsBundle(String bundleUrl)
Uploads (from URL) an artifacts bundle into the repository
|
void |
manageCancel(String ref,
boolean dontClear)
Cancels an ongoing operation
|
String |
manageCheckIntegrity(String environmentName,
String releaseName,
String serverName,
String artifactName)
Initiates a check integrity operation
|
String |
manageDeploy(String environmentName,
String releaseName,
String serverName,
String artifactName)
Initiates a deploy operation
|
String |
manageStart(String environmentName,
String releaseName,
String serverName,
String artifactName)
Initiates a start executables operation
|
String |
manageStatus(String environmentName,
String releaseName,
String serverName,
String artifactName)
Initiates an executables status operation
|
String |
manageStop(String environmentName,
String releaseName,
String serverName,
String artifactName)
Initiates a stop executables operation
|
String |
manageUndeploy(String environmentName,
String releaseName,
String serverName,
String artifactName,
boolean forceUndeploy)
Initiates a undeploy operation
|
void |
reeditRelease(String environmentName,
String releaseName)
Reedits a previously tagged release
|
void |
sendCredentials(String environmentName,
String serverName,
boolean sameForAllServers,
String credentials)
Supply server credentials without storing them in kwatee
|
String |
serverDiagnostics(String serverName,
String properties)
Tests a connection to the server and returns server capabilities
|
void |
setReleaseArtifactActiveVersion(String environmentName,
String releaseName,
String artifactName,
String versionName,
String serverName)
Sets the active version (default of server-specific) of a release artifact
|
void |
setReleaseVariables(String environmentName,
String releaseName,
String variables)
Sets the release variables
|
void |
tagRelease(String environmentName,
String releaseName,
String releaseProperties)
Tags a release and optionally sets additional properties (e.g.
|
void |
updateArtifact(String artifactName,
String artifactProperties)
Updates an artifact's properties
|
void |
updateArtifactPackageFileProperties(String artifactName,
String versionName,
String path,
String fileProperties)
Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a package
|
void |
updateArtifactVariables(String artifactName,
String versionName,
String variables)
Updates version variables
|
void |
updateEnvironment(String environmentName,
String environmentProperties)
Updates the environment with new properties
|
void |
updateRelease(String environmentName,
String releaseName,
String releaseProperties)
Updates a release with new properties
|
void |
updateReleasePackageFileProperties(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path,
String fileProperties)
Update custom flags (ignoreIdenty, dontDelete, ...) of a file within a release artifact package
|
void |
updateServer(String serverName,
String serverProperties)
Updates the properties of a server
|
void |
updateVersion(String artifactName,
String versionName,
String versionProperties)
Updates an artifact's version properties
|
void |
uploadArtifactPackage(String artifactName,
String versionName,
File uploadFile,
boolean deleteOverlays)
Uploads (Http POST) a package to an artifact's version.
|
void |
uploadArtifactPackage(String artifactName,
String versionName,
String uploadUrl,
boolean deleteOverlays)
Uploads (from URL) a package to an artifact's version.
|
void |
uploadArtifactPackageOverlay(String artifactName,
String versionName,
String path,
File uploadFile)
Uploads (Http POST) an overlay at a relative path within the package
|
void |
uploadArtifactPackageOverlay(String artifactName,
String versionName,
String path,
String uploadUrl)
Uploads (from URL) an overlay at a relative path within the package
|
void |
uploadReleasePackageOverlay(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path,
File uploadFile)
Uploads (Http Post) an overlay at a relative path within the release artifact package
|
void |
uploadReleasePackageOverlay(String environmentName,
String releaseName,
String artifactName,
String serverName,
String path,
String uploadUrl)
Uploads (from URL) an overlay at a relative path within the release artifact package
|
public static KwateeAPI createInstance(String serviceUrl, String login, String password) throws IOException
IOException
public static KwateeAPI createInstance(String serviceUrl, String authToken) throws IOException
IOException
public static KwateeAPI createInstance(String serviceUrl) throws IOException
serviceUrl
- url of the form http://user:password@host:port/kwatee
IOException
public void close()
public String getAuthToken()
public String getArtifacts() throws IOException
IOException
public String getArtifact(String artifactName) throws IOException
artifactName
- the name of an artifactIOException
public void updateArtifact(String artifactName, String artifactProperties) throws IOException
artifactName
- the name of an artifactartifactProperties
- the artifact's properties to update (plain string JSON)IOException
public void createArtifact(String artifactName, String artifactProperties) throws IOException
artifactName
- the name of the artifact to createartifactProperties
- the artifact's properties to set (plain string JSON) or null
IOException
public void deleteArtifact(String artifactName) throws IOException
artifactName
- the name of an artifactIOException
public String getVersion(String artifactName, String versionName) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionIOException
public void updateVersion(String artifactName, String versionName, String versionProperties) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionversionProperties
- the version properties to update (plain string JSON)IOException
public void createVersion(String artifactName, String versionName, String versionProperties) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of the version to createversionProperties
- the version properties to set (plain string JSON) or null
IOException
public void duplicateVersion(String artifactName, String versionName, String duplicateFrom, String versionProperties) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of the version to createduplicateFrom
- name of the version (within same artifact) to duplicateversionProperties
- the version properties to set (plain string JSON) or null
IOException
public void deleteVersion(String artifactName, String versionName) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionIOException
public void uploadArtifactPackage(String artifactName, String versionName, File uploadFile, boolean deleteOverlays) throws IOException
deleteOverlays=true
artifactName
- the name of the version's artifactversionName
- the name of a versionuploadFile
- the package file to uploaddeleteOverlays
- if false
, preserves existing overlaysIOException
public void uploadArtifactPackage(String artifactName, String versionName, String uploadUrl, boolean deleteOverlays) throws IOException
deleteOverlays=true
artifactName
- the name of the version's artifactversionName
- the name of a versionuploadUrl
- the package url (can be file:///) to uploaddeleteOverlays
- if false
, preserves existing overlaysIOException
public String getArtifactPackageFiles(String artifactName, String versionName, String path) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the directory to list within package (null
for root of package
listing)IOException
public String getArtifactSpecialFiles(String artifactName, String versionName) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionIOException
public void updateArtifactPackageFileProperties(String artifactName, String versionName, String path, String fileProperties) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the file within the packagefileProperties
- the file's properties to update (plain string JSON)IOException
public void downloadArtifactPackageFile(String artifactName, String versionName, String path, File downloadFile) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the file within the packagedownloadFile
- the location to store the result intoIOException
public void uploadArtifactPackageOverlay(String artifactName, String versionName, String path, File uploadFile) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the overlay directory within the packageuploadFile
- a file to uploadIOException
public void uploadArtifactPackageOverlay(String artifactName, String versionName, String path, String uploadUrl) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the overlay directory within the packageuploadUrl
- the url to a file (can be file:///) to uploadIOException
public void deleteArtifactPackageOverlay(String artifactName, String versionName, String path) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionpath
- the relative path of the file within the packageIOException
public String getArtifactVariables(String artifactName, String versionName) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionIOException
public void updateArtifactVariables(String artifactName, String versionName, String variables) throws IOException
artifactName
- the name of the version's artifactversionName
- the name of a versionvariables
- array of variables (plain string JSON)IOException
public void importActifactsBundle(File bundleFile) throws IOException
bundleFile
- the artifacts bundle to importIOException
public void importActifactsBundle(String bundleUrl) throws IOException
bundleUrl
- the url to an artifacts bundle (can be file:///) to importIOException
public String getServers() throws IOException
IOException
public String getServer(String serverName) throws IOException
serverName
- the name of the serverIOException
public void updateServer(String serverName, String serverProperties) throws IOException
serverName
- the name of the serverserverProperties
- the server properties to update (plain string JSON)IOException
public void createServer(String serverName, String serverProperties) throws IOException
serverName
- the name of the serverserverProperties
- the server properties to set (plain string JSON) or null
IOException
public void duplicateServer(String serverName, String duplicateFrom, String serverProperties) throws IOException
serverName
- the name of the server to createduplicateFrom
- the name of the server to duplicateserverProperties
- the properties to set (plain string JSON) or null
IOException
public void deleteServer(String serverName) throws IOException
serverName
- the name of the serverIOException
public String serverDiagnostics(String serverName, String properties) throws IOException
serverName
- the name of the serverproperties
- JSON server properties (typically for credentials)IOException
public String getEnvironments() throws IOException
IOException
public String getEnvironment(String environmentName) throws IOException
environmentName
- the name of an environmentIOException
public void updateEnvironment(String environmentName, String environmentProperties) throws IOException
environmentName
- the name of an environmentenvironmentProperties
- the environment properties to update (plain string JSON)IOException
public void createEnvironment(String environmentName, String environmentProperties) throws IOException
environmentName
- the name of the environment to create.environmentProperties
- the environment properties to set (plain string JSON) or null
IOException
public void duplicateEnvironment(String environmentName, String duplicateFrom, String environmentProperties) throws IOException
environmentName
- the name of the environment to createduplicateFrom
- name of the environment to duplicateenvironmentProperties
- the environment properties to set (plain string JSON) or null
IOException
public void deleteEnvironment(String environmentName) throws IOException
environmentName
- the name of an environmentIOException
public String getRelease(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseIOException
public void updateRelease(String environmentName, String releaseName, String releaseProperties) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releasereleaseProperties
- the release properties to update (plain string JSON)IOException
public void tagRelease(String environmentName, String releaseName, String releaseProperties) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of tagged release to createreleaseProperties
- the release properties to set (plain string JSON)IOException
public void reeditRelease(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of existing tagged releaseIOException
public void deleteRelease(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseIOException
public String getEffectiveReleaseArtifacts(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseIOException
public void setReleaseArtifactActiveVersion(String environmentName, String releaseName, String artifactName, String versionName, String serverName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactversionName
- the active version to be setserverName
- null
for default active versionIOException
public String getReleasePackageFiles(String environmentName, String releaseName, String artifactName, String serverName, String path) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the directory to list within package (null
for full recursive
listing)IOException
public String getReleaseSpecialFiles(String environmentName, String releaseName, String artifactName, String serverName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packageIOException
public void updateReleasePackageFileProperties(String environmentName, String releaseName, String artifactName, String serverName, String path, String fileProperties) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the file within the packagefileProperties
- the file properties to update (plain string JSON)IOException
public void downloadReleasePackageFile(String environmentName, String releaseName, String artifactName, String serverName, String path, File downloadFile) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the file within the packagedownloadFile
- the location to store the result intoIOException
public void uploadReleasePackageOverlay(String environmentName, String releaseName, String artifactName, String serverName, String path, File uploadFile) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the overlay directory within the packageuploadFile
- the file to uploadIOException
public void uploadReleasePackageOverlay(String environmentName, String releaseName, String artifactName, String serverName, String path, String uploadUrl) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the overlay directory within the packageuploadUrl
- the url to the file (can be file:///) to uploadIOException
public void deleteReleasePackageOverlay(String environmentName, String releaseName, String artifactName, String serverName, String path) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseartifactName
- the name of an artifactserverName
- null
for list files in default packagepath
- the relative path of the file within the packageIOException
public String getReleaseVariables(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseIOException
public void setReleaseVariables(String environmentName, String releaseName, String variables) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releasevariables
- an array of variables (plain string JSON)IOException
public String getDeployments() throws IOException
IOException
public String getDeployment(String environmentName, String releaseName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseIOException
public void downloadLightweightInstaller(String environmentName, String releaseName, File downloadFile) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releasedownloadFile
- the location to store the result intoIOException
public void downloadInstaller(String environmentName, String releaseName, File downloadFile) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releasedownloadFile
- the location to store the result intoIOException
public String manageDeploy(String environmentName, String releaseName, String serverName, String artifactName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentIOException
public String manageUndeploy(String environmentName, String releaseName, String serverName, String artifactName, boolean forceUndeploy) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentforceUndeploy
- if true
ignores errors and removes filesIOException
public String manageCheckIntegrity(String environmentName, String releaseName, String serverName, String artifactName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentIOException
public String manageStart(String environmentName, String releaseName, String serverName, String artifactName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentIOException
public String manageStop(String environmentName, String releaseName, String serverName, String artifactName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentIOException
public String manageStatus(String environmentName, String releaseName, String serverName, String artifactName) throws IOException
environmentName
- the name of the release's environmentreleaseName
- the name of the release or null
for snapshot releaseserverName
- the name of a server or null
for all servers in environmentartifactName
- the name of an artifact or null
for all artifacts within server/environmentIOException
public String getOngoingOperation() throws IOException
null
if no operation is in progressIOException
public int getOperationStatus(String ref) throws IOException
ref
- the reference of an ongoing deployment operation200
if successfully completed, 204
if the operation is in progress,
410
if gone and 400
in case of errorIOException
public String getOperationProgress(String ref) throws IOException
ref
- the reference of an ongoing deployment operationIOException
public String getProgressMessages(String ref, String serverName, String artifactName) throws IOException
ref
- the reference of an ongoing deployment operationserverName
- the name of the server for which info is requestedartifactName
- the name of an artifact for which info is requested. If null
, server-wide information is
returnedIOException
public void manageCancel(String ref, boolean dontClear) throws IOException
ref
- the reference of an ongoing deployment operationdontClear
- if true
the status is kept activeIOException
public void sendCredentials(String environmentName, String serverName, boolean sameForAllServers, String credentials) throws IOException
environmentName
- the name of an environmentserverName
- the name of the serversameForAllServers
- if true
, these same credentials will be applied to all servers that need it.credentials
- the optional credentials (plain string JSON or null
)IOException
public String getInfoContext() throws IOException
IOException
public String getInfoPlatforms() throws IOException
IOException
public String getInfoConduitTypes() throws IOException
IOException
public String getInfoServerPoolTypes() throws IOException
IOException
Copyright © 2016 Kwatee. All Rights Reserved.