AbstractPackageManagerClient (Granite Client

java.lang.Object
- net.adamcin.granite.client.packman.AbstractPackageManagerClient

All Implemented Interfaces:

PackageManagerClient

Direct Known Subclasses:

AsyncPackageManagerClient, Http3PackageManagerClient, Http4PackageManagerClient
```
public abstract class AbstractPackageManagerClient
extends Object
implements PackageManagerClient
```
The AbstractPackageManagerClient provides constants and concrete implementations for generic method logic and response handling.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractPackageManagerClient.Either<T,U>`
`protected static class`	`AbstractPackageManagerClient.ResponseBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CMD_BUILD`
`static String`	`CMD_CONTENTS`
`static String`	`CMD_CREATE`
`static String`	`CMD_DELETE`
`static String`	`CMD_DRY_RUN`
`static String`	`CMD_INSTALL`
`static String`	`CMD_REPLICATE`
`static String`	`CMD_REWRAP`
`static String`	`CMD_UNINSTALL`
`static String`	`CMD_UPLOAD`
`static String`	`CONSOLE_UI_BASE_PATH`
`static String`	`CONSOLE_UI_DOWNLOAD_PATH`
`static String`	`CONSOLE_UI_LIST_PATH`
`static String`	`CONSOLE_UI_UPDATE_PATH`
`static String`	`DEFAULT_BASE_URL`
`static String`	`DEFAULT_CHARSET`
`static ResponseProgressListener`	`DEFAULT_LISTENER`
`static String`	`DEFAULT_PASSWORD`
`static String`	`DEFAULT_USERNAME`
`static String`	`HTML_SERVICE_PATH`
`static String`	`JSON_SERVICE_PATH`
`static String`	`KEY_ACHANDLING`
`static String`	`KEY_AUTOSAVE`
`static String`	`KEY_CHARSET`
`static String`	`KEY_CMD`
`static String`	`KEY_FILTER`
`static String`	`KEY_FORCE`
`static String`	`KEY_GROUP`
`static String`	`KEY_GROUP_NAME`
`static String`	`KEY_HAS_SNAPSHOT`
`static String`	`KEY_INCLUDE_VERSIONS`
`static String`	`KEY_MESSAGE`
`static String`	`KEY_NAME`
`static String`	`KEY_NEEDS_REWRAP`
`static String`	`KEY_NO_SLING`
`static String`	`KEY_PACKAGE`
`static String`	`KEY_PACKAGE_NAME`
`static String`	`KEY_PACKAGE_VERSION`
`static String`	`KEY_PATH`
`static String`	`KEY_QUERY`
`static String`	`KEY_RECURSIVE`
`static String`	`KEY_RESULTS`
`static String`	`KEY_SUCCESS`
`static String`	`KEY_TOTAL`
`static String`	`KEY_VERSION`
`static String`	`LEGACY_PARAM_PASSWORD`
`static String`	`LEGACY_PARAM_TOKEN`
`static String`	`LEGACY_PARAM_USERID`
`static String`	`LEGACY_PARAM_WORKSPACE`
`static String`	`LEGACY_PATH`
`static String`	`LEGACY_VALUE_TOKEN`
`static String`	`LEGACY_VALUE_WORKSPACE`
`static String`	`LOGIN_PARAM_CHARSET`
`static String`	`LOGIN_PARAM_PASSWORD`
`static String`	`LOGIN_PARAM_USERNAME`
`static String`	`LOGIN_PARAM_VALIDATE`
`static String`	`LOGIN_PATH`
`static String`	`LOGIN_VALUE_CHARSET`
`static String`	`LOGIN_VALUE_VALIDATE`
`static String`	`MIME_ZIP`
`static int`	`MIN_AUTOSAVE`
`static PackId`	`NO_SUCH_PACK_ID`
`static String`	`SERVICE_BASE_PATH`
`static String`	`VAL_NO_SLING`

Constructor Summary

Constructors
Constructor and Description

AbstractPackageManagerClient()

Constructors
Constructor and Description
`AbstractPackageManagerClient()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`DetailedResponse`	`build(PackId packageId)` Builds the specified package
`DetailedResponse`	`build(PackId packageId, ResponseProgressListener listener)` Builds the specified package
`protected abstract AbstractPackageManagerClient.Either<? extends Exception,Boolean>`	`checkServiceAvailability(boolean checkTimeout, long timeoutRemaining)` The CRX PackageManagerServlet does not support GET requests.
`protected String`	`constructUrl(String path, String query, String fragment)`
`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
`protected static DownloadResponse`	`createDownloadResponse(File outputFile)`
`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()`
`Charset`	`getCharset()`
`String`	`getConsoleUiUrl()`
`String`	`getConsoleUiUrl(PackId packageId)` Return the Console UI Url for the specified package, which is useful for creating HTML links.
`protected String`	`getDownloadUrl()`
`protected String`	`getHtmlUrl()`
`protected String`	`getHtmlUrl(PackId packageId)`
`protected String`	`getJsonUrl()`
`protected String`	`getJsonUrl(PackId packageId)`
`protected String`	`getListUrl()`
`String`	`getLoginUrl()`
`long`	`getRequestTimeout()`
`protected abstract AbstractPackageManagerClient.ResponseBuilder`	`getResponseBuilder()`
`long`	`getServiceTimeout()`
`protected String`	`getUpdateUrl()`
`long`	`getWaitDelay()`
`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.
`protected static <T,U> AbstractPackageManagerClient.Either<T,U>`	`left(T left, Class<U> right)`
`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`
`abstract boolean`	`login(String username, String password)` Login to CRX using a POST request /crx/j_security_check.
`SimpleResponse`	`move(PackId packageId, PackId moveToId)` Move/Rename a package on the server
`protected static DetailedResponse`	`parseDetailedResponse(int statusCode, String statusText, InputStream stream, String charset, ResponseProgressListener listener)`
`protected static DownloadResponse`	`parseDownloadResponse(int statusCode, String statusText, InputStream stream, File outputFile)`
`protected static ListResponse`	`parseListResponse(int statusCode, String statusText, InputStream stream, String charset)`
`protected static SimpleResponse`	`parseSimpleResponse(int statusCode, String statusText, InputStream stream, String charset)`
`protected static SimpleResponse`	`parseSimpleResponse(int statusCode, String statusText, InputStream stream, String charset, boolean nullOnNonIOError)`
`abstract void`	`preemptLogin(String username, String password)` Enable preemptive authentication using Basic Auth credentials.
`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
`protected static <T,U> AbstractPackageManagerClient.Either<T,U>`	`right(Class<T> left, U right)`
`void`	`setBaseUrl(String baseUrl)`
`void`	`setCharset(Charset charset)`
`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 `PackageManagerClient.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LISTENER
```
public static final ResponseProgressListener DEFAULT_LISTENER
```
  - CONSOLE_UI_BASE_PATH
```
public static final String CONSOLE_UI_BASE_PATH
```
    See Also:
    
    Constant Field Values
  - CONSOLE_UI_LIST_PATH
```
public static final String CONSOLE_UI_LIST_PATH
```
    See Also:
    
    Constant Field Values
  - CONSOLE_UI_DOWNLOAD_PATH
```
public static final String CONSOLE_UI_DOWNLOAD_PATH
```
    See Also:
    
    Constant Field Values
  - CONSOLE_UI_UPDATE_PATH
```
public static final String CONSOLE_UI_UPDATE_PATH
```
    See Also:
    
    Constant Field Values
  - SERVICE_BASE_PATH
```
public static final String SERVICE_BASE_PATH
```
    See Also:
    
    Constant Field Values
  - HTML_SERVICE_PATH
```
public static final String HTML_SERVICE_PATH
```
    See Also:
    
    Constant Field Values
  - JSON_SERVICE_PATH
```
public static final String JSON_SERVICE_PATH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BASE_URL
```
public static final String DEFAULT_BASE_URL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USERNAME
```
public static final String DEFAULT_USERNAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PASSWORD
```
public static final String DEFAULT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARSET
```
public static final String DEFAULT_CHARSET
```
    See Also:
    
    Constant Field Values
  - MIN_AUTOSAVE
```
public static final int MIN_AUTOSAVE
```
    See Also:
    
    Constant Field Values
  - MIME_ZIP
```
public static final String MIME_ZIP
```
    See Also:
    
    Constant Field Values
  - KEY_CMD
```
public static final String KEY_CMD
```
    See Also:
    
    Constant Field Values
  - KEY_FORCE
```
public static final String KEY_FORCE
```
    See Also:
    
    Constant Field Values
  - KEY_PACKAGE
```
public static final String KEY_PACKAGE
```
    See Also:
    
    Constant Field Values
  - KEY_SUCCESS
```
public static final String KEY_SUCCESS
```
    See Also:
    
    Constant Field Values
  - KEY_MESSAGE
```
public static final String KEY_MESSAGE
```
    See Also:
    
    Constant Field Values
  - KEY_PATH
```
public static final String KEY_PATH
```
    See Also:
    
    Constant Field Values
  - KEY_RECURSIVE
```
public static final String KEY_RECURSIVE
```
    See Also:
    
    Constant Field Values
  - KEY_AUTOSAVE
```
public static final String KEY_AUTOSAVE
```
    See Also:
    
    Constant Field Values
  - KEY_ACHANDLING
```
public static final String KEY_ACHANDLING
```
    See Also:
    
    Constant Field Values
  - KEY_RESULTS
```
public static final String KEY_RESULTS
```
    See Also:
    
    Constant Field Values
  - KEY_TOTAL
```
public static final String KEY_TOTAL
```
    See Also:
    
    Constant Field Values
  - KEY_GROUP
```
public static final String KEY_GROUP
```
    See Also:
    
    Constant Field Values
  - KEY_NAME
```
public static final String KEY_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_VERSION
```
public static final String KEY_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_HAS_SNAPSHOT
```
public static final String KEY_HAS_SNAPSHOT
```
    See Also:
    
    Constant Field Values
  - KEY_NEEDS_REWRAP
```
public static final String KEY_NEEDS_REWRAP
```
    See Also:
    
    Constant Field Values
  - KEY_INCLUDE_VERSIONS
```
public static final String KEY_INCLUDE_VERSIONS
```
    See Also:
    
    Constant Field Values
  - KEY_QUERY
```
public static final String KEY_QUERY
```
    See Also:
    
    Constant Field Values
  - KEY_GROUP_NAME
```
public static final String KEY_GROUP_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_PACKAGE_NAME
```
public static final String KEY_PACKAGE_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_PACKAGE_VERSION
```
public static final String KEY_PACKAGE_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_FILTER
```
public static final String KEY_FILTER
```
    See Also:
    
    Constant Field Values
  - KEY_CHARSET
```
public static final String KEY_CHARSET
```
    See Also:
    
    Constant Field Values
  - KEY_NO_SLING
```
public static final String KEY_NO_SLING
```
    See Also:
    
    Constant Field Values
  - VAL_NO_SLING
```
public static final String VAL_NO_SLING
```
    See Also:
    
    Constant Field Values
  - NO_SUCH_PACK_ID
```
public static final PackId NO_SUCH_PACK_ID
```
  - CMD_CONTENTS
```
public static final String CMD_CONTENTS
```
    See Also:
    
    Constant Field Values
  - CMD_INSTALL
```
public static final String CMD_INSTALL
```
    See Also:
    
    Constant Field Values
  - CMD_UNINSTALL
```
public static final String CMD_UNINSTALL
```
    See Also:
    
    Constant Field Values
  - CMD_UPLOAD
```
public static final String CMD_UPLOAD
```
    See Also:
    
    Constant Field Values
  - CMD_CREATE
```
public static final String CMD_CREATE
```
    See Also:
    
    Constant Field Values
  - CMD_BUILD
```
public static final String CMD_BUILD
```
    See Also:
    
    Constant Field Values
  - CMD_REWRAP
```
public static final String CMD_REWRAP
```
    See Also:
    
    Constant Field Values
  - CMD_DRY_RUN
```
public static final String CMD_DRY_RUN
```
    See Also:
    
    Constant Field Values
  - CMD_DELETE
```
public static final String CMD_DELETE
```
    See Also:
    
    Constant Field Values
  - CMD_REPLICATE
```
public static final String CMD_REPLICATE
```
    See Also:
    
    Constant Field Values
  - LOGIN_PATH
```
public static final String LOGIN_PATH
```
    See Also:
    
    Constant Field Values
  - LOGIN_PARAM_USERNAME
```
public static final String LOGIN_PARAM_USERNAME
```
    See Also:
    
    Constant Field Values
  - LOGIN_PARAM_PASSWORD
```
public static final String LOGIN_PARAM_PASSWORD
```
    See Also:
    
    Constant Field Values
  - LOGIN_PARAM_VALIDATE
```
public static final String LOGIN_PARAM_VALIDATE
```
    See Also:
    
    Constant Field Values
  - LOGIN_VALUE_VALIDATE
```
public static final String LOGIN_VALUE_VALIDATE
```
    See Also:
    
    Constant Field Values
  - LOGIN_PARAM_CHARSET
```
public static final String LOGIN_PARAM_CHARSET
```
    See Also:
    
    Constant Field Values
  - LOGIN_VALUE_CHARSET
```
public static final String LOGIN_VALUE_CHARSET
```
    See Also:
    
    Constant Field Values
  - LEGACY_PATH
```
public static final String LEGACY_PATH
```
    See Also:
    
    Constant Field Values
  - LEGACY_PARAM_USERID
```
public static final String LEGACY_PARAM_USERID
```
    See Also:
    
    Constant Field Values
  - LEGACY_PARAM_PASSWORD
```
public static final String LEGACY_PARAM_PASSWORD
```
    See Also:
    
    Constant Field Values
  - LEGACY_PARAM_WORKSPACE
```
public static final String LEGACY_PARAM_WORKSPACE
```
    See Also:
    
    Constant Field Values
  - LEGACY_VALUE_WORKSPACE
```
public static final String LEGACY_VALUE_WORKSPACE
```
    See Also:
    
    Constant Field Values
  - LEGACY_PARAM_TOKEN
```
public static final String LEGACY_PARAM_TOKEN
```
    See Also:
    
    Constant Field Values
  - LEGACY_VALUE_TOKEN
```
public static final String LEGACY_VALUE_TOKEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractPackageManagerClient
```
public AbstractPackageManagerClient()
```
- Method Detail
  - getCharset
```
public Charset getCharset()
```
  - setCharset
```
public void setCharset(Charset charset)
```
  - setBaseUrl
```
public void setBaseUrl(String baseUrl)
```
  - getBaseUrl
```
public final String getBaseUrl()
```
    Specified by:
    
    getBaseUrl in interface PackageManagerClient
    
    Returns:
    
    the base URL (not including /crx.*) of the target server
  - constructUrl
```
protected final String constructUrl(String path,
                                    String query,
                                    String fragment)
```
  - getRequestTimeout
```
public long getRequestTimeout()
```
  - setRequestTimeout
```
public void setRequestTimeout(long requestTimeout)
```
    Description copied from interface: PackageManagerClient
    
    Set the amount of time in milliseconds to wait for a response for any given request. Set to a negative number for no timeout.
    
    Specified by:
    
    setRequestTimeout in interface PackageManagerClient
    
    Parameters:
    
    requestTimeout - timeout in milliseconds
  - getServiceTimeout
```
public long getServiceTimeout()
```
  - setServiceTimeout
```
public void setServiceTimeout(long serviceTimeout)
```
    Description copied from interface: PackageManagerClient
    
    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.
    
    Specified by:
    
    setServiceTimeout in interface PackageManagerClient
    
    Parameters:
    
    serviceTimeout - timeout in milliseconds
  - getWaitDelay
```
public long getWaitDelay()
```
  - setWaitDelay
```
public void setWaitDelay(long waitDelay)
```
    Description copied from interface: PackageManagerClient
    
    Set a delay in milliseconds for calls to the PackageManagerClient.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.
    
    Specified by:
    
    setWaitDelay in interface PackageManagerClient
    
    Parameters:
    
    waitDelay - delay in milliseconds
  - getHtmlUrl
```
protected final String getHtmlUrl()
```
  - getHtmlUrl
```
protected final String getHtmlUrl(PackId packageId)
```
  - getLoginUrl
```
public String getLoginUrl()
```
  - getJsonUrl
```
protected final String getJsonUrl()
```
  - getJsonUrl
```
protected final String getJsonUrl(PackId packageId)
```
  - getListUrl
```
protected final String getListUrl()
```
  - getDownloadUrl
```
protected final String getDownloadUrl()
```
  - getUpdateUrl
```
protected final String getUpdateUrl()
```
  - getConsoleUiUrl
```
public final String getConsoleUiUrl()
```
  - getConsoleUiUrl
```
public final String getConsoleUiUrl(PackId packageId)
```
    Description copied from interface: PackageManagerClient
    
    Return the Console UI Url for the specified package, which is useful for creating HTML links.
    
    Specified by:
    
    getConsoleUiUrl in interface PackageManagerClient
    
    Parameters:
    
    packageId - the PackId representing the package
    
    Returns:
    
    the Console UI Url for the specified package, which is useful for creating HTML links.
  - login
```
public abstract boolean login(String username,
                              String password)
                       throws IOException
```
    Login to CRX using a POST request /crx/j_security_check. Authentication for subsequent requests is expected to be handled by the underlying client implementation using a login-token cookie or equivalent client session context.
    
    Parameters:
    
    username - the username
    
    password - the password
    
    Returns:
    
    true if authenticated in the affirmative, false if authenticated in the negative
    
    Throws:
    
    IOException - for "a failure to communicate"
  - preemptLogin
```
public abstract void preemptLogin(String username,
                                  String password)
```
    Enable preemptive authentication using Basic Auth credentials. Set either to null to disable preemptive authentication. Warning: if misused or used incorrectly the preemptive authentication can lead to significant security issues, such as sending user credentials in clear text to an unauthorized third party. Therefore, users are expected to evaluate potential benefits of preemptive authentication versus security risks in the context of their specific application environment.
    
    Parameters:
    
    username - the username
    
    password - the password
  - checkServiceAvailability
```
protected abstract AbstractPackageManagerClient.Either<? extends Exception,Boolean> checkServiceAvailability(boolean checkTimeout,
                                                                                                             long timeoutRemaining)
```
    The CRX PackageManagerServlet does not support GET requests. The only use for GET is to check service availability. If anything other than 401 or 405 is returned, the service should be considered unavailable. Alternatively, a POST cmd to delete a non-existing package should
    
    Parameters:
    
    checkTimeout - set to true to enforce a timeout
    
    timeoutRemaining - remaining timeout in milliseconds
    
    Returns:
    
    either a throwable or a boolean
  - getResponseBuilder
```
protected abstract AbstractPackageManagerClient.ResponseBuilder getResponseBuilder()
```
  - parseDetailedResponse
```
protected static DetailedResponse parseDetailedResponse(int statusCode,
                                                        String statusText,
                                                        InputStream stream,
                                                        String charset,
                                                        ResponseProgressListener listener)
                                                 throws IOException
```
    Throws:
    
    IOException
  - parseSimpleResponse
```
protected static SimpleResponse parseSimpleResponse(int statusCode,
                                                    String statusText,
                                                    InputStream stream,
                                                    String charset)
                                             throws IOException
```
    Throws:
    
    IOException
  - parseSimpleResponse
```
protected static SimpleResponse parseSimpleResponse(int statusCode,
                                                    String statusText,
                                                    InputStream stream,
                                                    String charset,
                                                    boolean nullOnNonIOError)
                                             throws IOException
```
    Throws:
    
    IOException
  - parseListResponse
```
protected static ListResponse parseListResponse(int statusCode,
                                                String statusText,
                                                InputStream stream,
                                                String charset)
                                         throws IOException
```
    Throws:
    
    IOException
  - parseDownloadResponse
```
protected static DownloadResponse parseDownloadResponse(int statusCode,
                                                        String statusText,
                                                        InputStream stream,
                                                        File outputFile)
                                                 throws IOException
```
    Throws:
    
    IOException
  - createDownloadResponse
```
protected static DownloadResponse createDownloadResponse(File outputFile)
                                                  throws IOException
```
    Throws:
    
    IOException
  - left
```
protected static <T,U> AbstractPackageManagerClient.Either<T,U> left(T left,
                                                                     Class<U> right)
```
  - right
```
protected static <T,U> AbstractPackageManagerClient.Either<T,U> right(Class<T> left,
                                                                      U right)
```
  - identify
```
public final 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.
    
    Specified by:
    
    identify in interface PackageManagerClient
    
    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
```
public final PackId identify(File file,
                             boolean strict)
                      throws IOException
```
    Identify a CRX package based on its metadata
    
    Specified by:
    
    identify in interface PackageManagerClient
    
    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
```
public final boolean waitForService()
                             throws Exception
```
    Wait for service availability. Use this method between installing a package and any calling any other POST-based service operation
    
    Specified by:
    
    waitForService in interface PackageManagerClient
    
    Returns:
    
    true if service availability was successfully determined, false otherwise
    
    Throws:
    
    Exception - on timeout, interruption, or IOException
  - existsOnServer
```
public final 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.
    
    Specified by:
    
    existsOnServer in interface PackageManagerClient
    
    Parameters:
    
    packageId - the PackId representing the package
    
    Returns:
    
    true if a package exists, false otherwise
    
    Throws:
    
    Exception - for unknown errors
  - list
```
public final ListResponse list()
                        throws Exception
```
    List all packages
    
    Specified by:
    
    list in interface PackageManagerClient
    
    Returns:
    
    package list service response
    
    Throws:
    
    Exception - for unknown errors
  - list
```
public final ListResponse list(String query)
                        throws Exception
```
    List all packages and filter by query
    
    Specified by:
    
    list in interface PackageManagerClient
    
    Parameters:
    
    query - can be null or empty string
    
    Returns:
    
    package list service response filtered by query
    
    Throws:
    
    Exception - for unknown errors
  - list
```
public final 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.
    
    Specified by:
    
    list in interface PackageManagerClient
    
    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
```
public final SimpleResponse upload(File file,
                                   boolean force,
                                   PackId packageId)
                            throws Exception
```
    Upload a package to the server. Does not install the package once uploaded.
    
    Specified by:
    
    upload in interface PackageManagerClient
    
    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
```
public final DownloadResponse download(PackId packageId,
                                       File toFile)
                                throws Exception
```
    Downloads the package identified by packageId to the absolute path specified by toFile
    
    Specified by:
    
    download in interface PackageManagerClient
    
    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
```
public final DownloadResponse downloadToDirectory(PackId packageId,
                                                  File toDirectory)
                                           throws Exception
```
    Downloads the package to a qualified relative path under toDirectory
    
    Specified by:
    
    downloadToDirectory in interface PackageManagerClient
    
    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
```
public final SimpleResponse delete(PackId packageId)
                            throws Exception
```
    Delete a package from the server. Does not uninstall the package.
    
    Specified by:
    
    delete in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package to be deleted
    
    Returns:
    
    standard simple service response
    
    Throws:
    
    Exception - for unknown errors
  - replicate
```
public final SimpleResponse replicate(PackId packageId)
                               throws Exception
```
    Replicates the package using the server's default replication agents
    
    Specified by:
    
    replicate in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package to be replicated
    
    Returns:
    
    simple service response
    
    Throws:
    
    Exception - for unknown errors
  - contents
```
public final DetailedResponse contents(PackId packageId)
                                throws Exception
```
    Prints the contents of the package to the response
    
    Specified by:
    
    contents in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - contents
```
public final DetailedResponse contents(PackId packageId,
                                       ResponseProgressListener listener)
                                throws Exception
```
    Prints the contents of the package to the response
    
    Specified by:
    
    contents in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    listener - response progress listener
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - install
```
public final DetailedResponse install(PackId packageId,
                                      boolean recursive,
                                      int autosave,
                                      ACHandling acHandling)
                               throws Exception
```
    Install a package that has already been uploaded to the server.
    
    Specified by:
    
    install in interface PackageManagerClient
    
    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
```
public final 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.
    
    Specified by:
    
    install in interface PackageManagerClient
    
    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
```
public final DetailedResponse dryRun(PackId packageId)
                              throws Exception
```
    Performs a dryRun of an installation of the specified package
    
    Specified by:
    
    dryRun in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - dryRun
```
public final DetailedResponse dryRun(PackId packageId,
                                     ResponseProgressListener listener)
                              throws Exception
```
    Performs a dryRun of an installation of the specified package
    
    Specified by:
    
    dryRun in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    listener - response progress listener
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - create
```
public final SimpleResponse create(PackId packageId)
                            throws Exception
```
    Create a package with the specified packageId
    
    Specified by:
    
    create in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing new package
    
    Returns:
    
    simple service response
    
    Throws:
    
    Exception - for unknown errors
  - updateFilter
```
public final SimpleResponse updateFilter(PackId packageId,
                                         WspFilter filter)
                                  throws Exception
```
    Update a package definition with the specified WspFilter
    
    Specified by:
    
    updateFilter in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package to update
    
    filter - new workspace filter
    
    Returns:
    
    simple service response
    
    Throws:
    
    Exception - for unknown errors
  - move
```
public final SimpleResponse move(PackId packageId,
                                 PackId moveToId)
                          throws Exception
```
    Move/Rename a package on the server
    
    Specified by:
    
    move in interface PackageManagerClient
    
    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
```
public final DetailedResponse build(PackId packageId)
                             throws Exception
```
    Builds the specified package
    
    Specified by:
    
    build in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - build
```
public final DetailedResponse build(PackId packageId,
                                    ResponseProgressListener listener)
                             throws Exception
```
    Builds the specified package
    
    Specified by:
    
    build in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    listener - response progress listener
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - rewrap
```
public final DetailedResponse rewrap(PackId packageId)
                              throws Exception
```
    Rewraps the specified package
    
    Specified by:
    
    rewrap in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - rewrap
```
public final DetailedResponse rewrap(PackId packageId,
                                     ResponseProgressListener listener)
                              throws Exception
```
    Rewraps the specified package
    
    Specified by:
    
    rewrap in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    listener - response progress listener
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - uninstall
```
public final DetailedResponse uninstall(PackId packageId)
                                 throws Exception
```
    Uninstalls the specified package
    
    Specified by:
    
    uninstall in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors
  - uninstall
```
public final DetailedResponse uninstall(PackId packageId,
                                        ResponseProgressListener listener)
                                 throws Exception
```
    Uninstalls the specified package
    
    Specified by:
    
    uninstall in interface PackageManagerClient
    
    Parameters:
    
    packageId - PackId representing package
    
    listener - response progress listener
    
    Returns:
    
    detailed service response
    
    Throws:
    
    Exception - for unknown errors

Class AbstractPackageManagerClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LISTENER

CONSOLE_UI_BASE_PATH

CONSOLE_UI_LIST_PATH

CONSOLE_UI_DOWNLOAD_PATH

CONSOLE_UI_UPDATE_PATH

SERVICE_BASE_PATH

HTML_SERVICE_PATH

JSON_SERVICE_PATH

DEFAULT_BASE_URL

DEFAULT_USERNAME

DEFAULT_PASSWORD

DEFAULT_CHARSET

MIN_AUTOSAVE

MIME_ZIP

KEY_CMD

KEY_FORCE

KEY_PACKAGE

KEY_SUCCESS

KEY_MESSAGE

KEY_PATH

KEY_RECURSIVE

KEY_AUTOSAVE

KEY_ACHANDLING

KEY_RESULTS

KEY_TOTAL

KEY_GROUP

KEY_NAME

KEY_VERSION

KEY_HAS_SNAPSHOT

KEY_NEEDS_REWRAP

KEY_INCLUDE_VERSIONS

KEY_QUERY

KEY_GROUP_NAME

KEY_PACKAGE_NAME

KEY_PACKAGE_VERSION

KEY_FILTER

KEY_CHARSET

KEY_NO_SLING

VAL_NO_SLING

NO_SUCH_PACK_ID

CMD_CONTENTS

CMD_INSTALL

CMD_UNINSTALL

CMD_UPLOAD

CMD_CREATE

CMD_BUILD

CMD_REWRAP

CMD_DRY_RUN

CMD_DELETE

CMD_REPLICATE

LOGIN_PATH

LOGIN_PARAM_USERNAME

LOGIN_PARAM_PASSWORD

LOGIN_PARAM_VALIDATE

LOGIN_VALUE_VALIDATE

LOGIN_PARAM_CHARSET

LOGIN_VALUE_CHARSET

LEGACY_PATH

LEGACY_PARAM_USERID

LEGACY_PARAM_PASSWORD

LEGACY_PARAM_WORKSPACE

LEGACY_VALUE_WORKSPACE

LEGACY_PARAM_TOKEN

LEGACY_VALUE_TOKEN

Constructor Detail

AbstractPackageManagerClient

Method Detail

getCharset

setCharset

setBaseUrl

getBaseUrl

constructUrl

getRequestTimeout