net.adamcin.granite.client.packman.http3

Class Http3PackageManagerClient

java.lang.Object

net.adamcin.granite.client.packman.AbstractPackageManagerClient

net.adamcin.granite.client.packman.http3.Http3PackageManagerClient

All Implemented Interfaces:

PackageManagerClient

public final class Http3PackageManagerClient
extends AbstractPackageManagerClient

Nested Class Summary

Nested classes/interfaces inherited from class net.adamcin.granite.client.packman.AbstractPackageManagerClient

AbstractPackageManagerClient.Either<T,U>, AbstractPackageManagerClient.ResponseBuilder

Field Summary

Fields inherited from class net.adamcin.granite.client.packman.AbstractPackageManagerClient

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

Constructor Summary

Constructors

Constructor and Description
Http3PackageManagerClient()
Http3PackageManagerClient(org.apache.commons.httpclient.HttpClient client)

Method Summary

Modifier and Type	Method and Description
protected AbstractPackageManagerClient.Either<? extends Exception,Boolean>	checkServiceAvailability(boolean checkTimeout, long timeoutRemaining) The CRX PackageManagerServlet does not support GET requests.
org.apache.commons.httpclient.HttpClient	getClient()
protected net.adamcin.granite.client.packman.http3.Http3PackageManagerClient.Http3ResponseBuilder	getResponseBuilder()
boolean	login(String username, String password) Login to CRX using a POST request /crx/j_security_check.
void	preemptLogin(String username, String password) Enable preemptive authentication using Basic Auth credentials.
void	setBasicCredentials(String username, String password)

Methods inherited from class net.adamcin.granite.client.packman.AbstractPackageManagerClient

build, build, constructUrl, contents, contents, create, createDownloadResponse, delete, download, downloadToDirectory, dryRun, dryRun, existsOnServer, getBaseUrl, getCharset, getConsoleUiUrl, getConsoleUiUrl, getDownloadUrl, getHtmlUrl, getHtmlUrl, getJsonUrl, getJsonUrl, getListUrl, getLoginUrl, getRequestTimeout, getServiceTimeout, getUpdateUrl, getWaitDelay, identify, identify, install, install, left, list, list, list, move, parseDetailedResponse, parseDownloadResponse, parseListResponse, parseSimpleResponse, parseSimpleResponse, replicate, rewrap, rewrap, right, setBaseUrl, setCharset, setRequestTimeout, setServiceTimeout, setWaitDelay, uninstall, uninstall, updateFilter, upload, waitForService

Methods inherited from class java.lang.Object

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

Constructor Detail

Http3PackageManagerClient

public Http3PackageManagerClient()

Http3PackageManagerClient

public Http3PackageManagerClient(org.apache.commons.httpclient.HttpClient client)

Method Detail

getClient

public org.apache.commons.httpclient.HttpClient getClient()

checkServiceAvailability

protected AbstractPackageManagerClient.Either<? extends Exception,Boolean> checkServiceAvailability(boolean checkTimeout,
                                                                                                    long timeoutRemaining)

Description copied from class: AbstractPackageManagerClient

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

Specified by:

checkServiceAvailability in class AbstractPackageManagerClient

Parameters:

checkTimeout - set to true to enforce a timeout

timeoutRemaining - remaining timeout in milliseconds

Returns:

either a throwable or a boolean

setBasicCredentials

public void setBasicCredentials(String username,
                                String password)

preemptLogin

public void preemptLogin(String username,
                         String password)

Description copied from class: AbstractPackageManagerClient

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.

Specified by:

preemptLogin in class AbstractPackageManagerClient

Parameters:

username - the username

password - the password

login

public boolean login(String username,
                     String password)
              throws IOException

Description copied from class: AbstractPackageManagerClient

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.

Specified by:

login in class AbstractPackageManagerClient

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"

getResponseBuilder

protected net.adamcin.granite.client.packman.http3.Http3PackageManagerClient.Http3ResponseBuilder getResponseBuilder()

Specified by:

getResponseBuilder in class AbstractPackageManagerClient