net.adamcin.granite.client.packman

Interface PackageManagerClient

All Known Implementing Classes:

AbstractPackageManagerClient, AsyncPackageManagerClient, Http3PackageManagerClient, Http4PackageManagerClient

public interface PackageManagerClient

This is the Public API for a CRX Package Manager Console client. It is intended to be used for implementation of higher level deployment management workflows, and therefore it does not expose any mutable connection details.

Method Summary

Modifier and Type	Method and Description
DetailedResponse	build(PackId packageId) Builds the specified package
DetailedResponse	build(PackId packageId, ResponseProgressListener listener) Builds the specified package
DetailedResponse	contents(PackId packageId) Prints the contents of the package to the response
DetailedResponse	contents(PackId packageId, ResponseProgressListener listener) Prints the contents of the package to the response
SimpleResponse	create(PackId packageId) Create a package with the specified packageId
SimpleResponse	delete(PackId packageId) Delete a package from the server.
DownloadResponse	download(PackId packageId, File toFile) Downloads the package identified by packageId to the absolute path specified by toFile
DownloadResponse	downloadToDirectory(PackId packageId, File toDirectory) Downloads the package to a qualified relative path under toDirectory
DetailedResponse	dryRun(PackId packageId) Performs a dryRun of an installation of the specified package
DetailedResponse	dryRun(PackId packageId, ResponseProgressListener listener) Performs a dryRun of an installation of the specified package
boolean	existsOnServer(PackId packageId) Checks if a package with the specified packageId has already been uploaded to the server.
String	getBaseUrl()
String	getConsoleUiUrl(PackId packageId) Return the Console UI Url for the specified package, which is useful for creating HTML links.
PackId	identify(File file) Identify a CRX package based on its metadata.
PackId	identify(File file, boolean strict) Identify a CRX package based on its metadata
DetailedResponse	install(PackId packageId, boolean recursive, int autosave, ACHandling acHandling) Install a package that has already been uploaded to the server.
DetailedResponse	install(PackId packageId, boolean recursive, int autosave, ACHandling acHandling, ResponseProgressListener listener) Install a package that has already been uploaded to the server.
ListResponse	list() List all packages
ListResponse	list(PackId packageId, boolean includeVersions) List one package matching packageId or many packages matching the package group and name up to the first hyphen.
ListResponse	list(String query) List all packages and filter by query
SimpleResponse	move(PackId packageId, PackId moveToId) Move/Rename a package on the server
SimpleResponse	replicate(PackId packageId) Replicates the package using the server's default replication agents
DetailedResponse	rewrap(PackId packageId) Rewraps the specified package
DetailedResponse	rewrap(PackId packageId, ResponseProgressListener listener) Rewraps the specified package
void	setRequestTimeout(long requestTimeout) Set the amount of time in milliseconds to wait for a response for any given request.
void	setServiceTimeout(long serviceTimeout) Set the amount of time in milliseconds to wait for service availability, which may span multiple retry requests.
void	setWaitDelay(long waitDelay) Set a delay in milliseconds for calls to the waitForService() method.
DetailedResponse	uninstall(PackId packageId) Uninstalls the specified package
DetailedResponse	uninstall(PackId packageId, ResponseProgressListener listener) Uninstalls the specified package
SimpleResponse	updateFilter(PackId packageId, WspFilter filter) Update a package definition with the specified WspFilter
SimpleResponse	upload(File file, boolean force, PackId packageId) Upload a package to the server.
boolean	waitForService() Wait for service availability.

Method Detail

setRequestTimeout

void setRequestTimeout(long requestTimeout)

Set the amount of time in milliseconds to wait for a response for any given request. Set to a negative number for no timeout.

Parameters:

requestTimeout - timeout in milliseconds

setServiceTimeout

void setServiceTimeout(long serviceTimeout)

Set the amount of time in milliseconds to wait for service availability, which may span multiple retry requests. Set to a negative number for no timeout.

Parameters:

serviceTimeout - timeout in milliseconds

setWaitDelay

void setWaitDelay(long waitDelay)

Set a delay in milliseconds for calls to the waitForService() method. Increase this value to account for delayed OSGi bundle cycling on the server after installing packages with embedded bundles. Set this to a negative number or zero for no delay.

Parameters:

waitDelay - delay in milliseconds

getBaseUrl

String getBaseUrl()

Returns:

the base URL (not including /crx.*) of the target server

getConsoleUiUrl

String getConsoleUiUrl(PackId packageId)

Return the Console UI Url for the specified package, which is useful for creating HTML links.

Parameters:

packageId - the PackId representing the package

Returns:

the Console UI Url for the specified package, which is useful for creating HTML links.

identify

PackId identify(File file)
         throws IOException

Identify a CRX package based on its metadata. Will be strict about it so that it won't naively pick up OSGi bundles if the client isn't careful about which files it is scanning.

Parameters:

file - a File representing the package

Returns:

a PackId object if the file represents a package, or null otherwise

Throws:

IOException - if the file can not be read, or it is not a zip file

identify

PackId identify(File file,
                boolean strict)
         throws IOException

Identify a CRX package based on its metadata

Parameters:

file - a File representing the package

strict - set to true to require a META-INF/vault/properties.xml file.

Returns:

a PackId object if the file represents a package, or null otherwise

Throws:

IOException - if the file can not be read, or it is not a zip file

waitForService

boolean waitForService()
                throws Exception

Wait for service availability. Use this method between installing a package and any calling any other POST-based service operation

Returns:

true if service availability was successfully determined, false otherwise

Throws:

Exception - on timeout, interruption, or IOException

existsOnServer

boolean existsOnServer(PackId packageId)
                throws Exception

Checks if a package with the specified packageId has already been uploaded to the server. This does not indicate whether the package has already been installed.

Parameters:

packageId - the PackId representing the package

Returns:

true if a package exists, false otherwise

Throws:

Exception - for unknown errors

list

ListResponse list()
           throws Exception

List all packages

Returns:

package list service response

Throws:

Exception - for unknown errors

list

ListResponse list(String query)
           throws Exception

List all packages and filter by query

Parameters:

query - can be null or empty string

Returns:

package list service response filtered by query

Throws:

Exception - for unknown errors

list

ListResponse list(PackId packageId,
                  boolean includeVersions)
           throws Exception

List one package matching packageId or many packages matching the package group and name up to the first hyphen.

Parameters:

packageId - the PackId representing the group:name(:version)? to match

includeVersions - set to true to match on group:name up to the first hyphen in the "name-version" string, which effectively matches against all versions of the package

Returns:

package list service response

Throws:

Exception - for unknown errors

upload

SimpleResponse upload(File file,
                      boolean force,
                      PackId packageId)
               throws Exception

Upload a package to the server. Does not install the package once uploaded.

Parameters:

file - the package file to be uploaded

force - set to true for the uploaded file to replace an existing package on the server that has the same id. Has no effect if no existing package is found.

packageId - optional PackId providing the installation path. If null, the file will be identified and that PackId will be used.

Returns:

standard simple service response

Throws:

Exception - for unknown errors

download

DownloadResponse download(PackId packageId,
                          File toFile)
                   throws Exception

Downloads the package identified by packageId to the absolute path specified by toFile

Parameters:

packageId - PackId representing package to be downloaded

toFile - the file to save the downloaded binary data to.

Returns:

a download service response

Throws:

Exception - for unknown errors

downloadToDirectory

DownloadResponse downloadToDirectory(PackId packageId,
                                     File toDirectory)
                              throws Exception

Downloads the package to a qualified relative path under toDirectory

Parameters:

packageId - PackId representing package to be downloaded

toDirectory - a base directory under which packages will be saved at a relative path matching their CRX installation path, starting with "./etc/packages"

Returns:

a download service response

Throws:

Exception - for unknown errors

delete

SimpleResponse delete(PackId packageId)
               throws Exception

Delete a package from the server. Does not uninstall the package.

Parameters:

packageId - PackId representing package to be deleted

Returns:

standard simple service response

Throws:

Exception - for unknown errors

replicate

SimpleResponse replicate(PackId packageId)
                  throws Exception

Replicates the package using the server's default replication agents

Parameters:

packageId - PackId representing package to be replicated

Returns:

simple service response

Throws:

Exception - for unknown errors

contents

DetailedResponse contents(PackId packageId)
                   throws Exception

Prints the contents of the package to the response

Parameters:

packageId - PackId representing package

Returns:

detailed service response

Throws:

Exception - for unknown errors

contents

DetailedResponse contents(PackId packageId,
                          ResponseProgressListener listener)
                   throws Exception

Prints the contents of the package to the response

Parameters:

packageId - PackId representing package

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors

install

DetailedResponse install(PackId packageId,
                         boolean recursive,
                         int autosave,
                         ACHandling acHandling)
                  throws Exception

Install a package that has already been uploaded to the server.

Parameters:

packageId - PackId representing package to be installed

recursive - set to true to also install subpackages

autosave - number of changes between session saves.

acHandling - Access Control Handling value ACHandling. Unspecified if null.

Returns:

detailed service response

Throws:

Exception - for unknown errors

install

DetailedResponse install(PackId packageId,
                         boolean recursive,
                         int autosave,
                         ACHandling acHandling,
                         ResponseProgressListener listener)
                  throws Exception

Install a package that has already been uploaded to the server.

Parameters:

packageId - PackId representing package to be installed

recursive - set to true to also install subpackages

autosave - number of changes between session saves.

acHandling - Access Control Handling value ACHandling. Unspecified if null.

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors

dryRun

DetailedResponse dryRun(PackId packageId)
                 throws Exception

Performs a dryRun of an installation of the specified package

Parameters:

packageId - PackId representing package

Returns:

detailed service response

Throws:

Exception - for unknown errors

dryRun

DetailedResponse dryRun(PackId packageId,
                        ResponseProgressListener listener)
                 throws Exception

Performs a dryRun of an installation of the specified package

Parameters:

packageId - PackId representing package

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors

create

SimpleResponse create(PackId packageId)
               throws Exception

Create a package with the specified packageId

Parameters:

packageId - PackId representing new package

Returns:

simple service response

Throws:

Exception - for unknown errors

updateFilter

SimpleResponse updateFilter(PackId packageId,
                            WspFilter filter)
                     throws Exception

Update a package definition with the specified WspFilter

Parameters:

packageId - PackId representing package to update

filter - new workspace filter

Returns:

simple service response

Throws:

Exception - for unknown errors

move

SimpleResponse move(PackId packageId,
                    PackId moveToId)
             throws Exception

Move/Rename a package on the server

Parameters:

packageId - PackId representing package to move/rename

moveToId - PackId package ID to move to

Returns:

simple service response

Throws:

Exception - for unknown errors

build

DetailedResponse build(PackId packageId)
                throws Exception

Builds the specified package

Parameters:

packageId - PackId representing package

Returns:

detailed service response

Throws:

Exception - for unknown errors

build

DetailedResponse build(PackId packageId,
                       ResponseProgressListener listener)
                throws Exception

Builds the specified package

Parameters:

packageId - PackId representing package

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors

rewrap

DetailedResponse rewrap(PackId packageId)
                 throws Exception

Rewraps the specified package

Parameters:

packageId - PackId representing package

Returns:

detailed service response

Throws:

Exception - for unknown errors

rewrap

DetailedResponse rewrap(PackId packageId,
                        ResponseProgressListener listener)
                 throws Exception

Rewraps the specified package

Parameters:

packageId - PackId representing package

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors

uninstall

DetailedResponse uninstall(PackId packageId)
                    throws Exception

Uninstalls the specified package

Parameters:

packageId - PackId representing package

Returns:

detailed service response

Throws:

Exception - for unknown errors

uninstall

DetailedResponse uninstall(PackId packageId,
                           ResponseProgressListener listener)
                    throws Exception

Uninstalls the specified package

Parameters:

packageId - PackId representing package

listener - response progress listener

Returns:

detailed service response

Throws:

Exception - for unknown errors