class AkamaiCacheControlClient in Akamai 7
Same name and namespace in other branches
- 8 akamai.class.inc \AkamaiCacheControlClient
- 8.2 akamai.class.inc \AkamaiCacheControlClient
- 6.2 akamai.class.inc \AkamaiCacheControlClient
- 7.3 akamai.class.inc \AkamaiCacheControlClient
- 7.2 akamai.class.inc \AkamaiCacheControlClient
Default implementation of the AkamaiCacheControl interface
Hierarchy
- class \AkamaiCacheControlClient implements AkamaiCacheControl
Expanded class hierarchy of AkamaiCacheControlClient
1 string reference to 'AkamaiCacheControlClient'
- akamai_get_class in ./
akamai.module - Returns the Akamai Cache Control class. This is abstracted to provide the capability of a no-op or recording class for testing purposes.
File
- ./
akamai.class.inc, line 25 - akamai.class.inc Akamai is a registered trademark of Akamai Technologies, Inc. This class is an abstraction around the Akamai Cache Control API.
View source
class AkamaiCacheControlClient implements AkamaiCacheControl {
private $defaults;
//akamai_get_defaults();
public $parameters;
/**
* Constructs an instance of the Akamai Cache Control facade.
*
* Valid parameters are specified in the options array as key/value pairs with the
* parameter name being the key and the parameter setting being the value
*
* @param options An array of parameter options for the Akamae Cache Control
* Web Service. These will override the defaults.
*/
function __construct($options = array()) {
$this->defaults = array(
'basepath' => variable_get("akamai_basepath", ""),
'name' => variable_get("akamai_username", ""),
'pwd' => variable_get("akamai_password", ""),
'action' => variable_get("akamai_action", ""),
'type' => "arl",
'domain' => variable_get("akamai_domain", ""),
'soap_wsdl' => variable_get("akamai_wsdl", ""),
'restapi' => variable_get("akamai_restapi", ""),
'email' => variable_get("akamai_email", ""),
'restapi_default' => variable_get("akamai_restapi_default", ""),
);
$this->parameters = array_merge($this->defaults, $options);
}
/**
* Clears the provided URLs from the Akamai Content Cache.
*
* @param $paths
* A path (or array of paths) to clear from Akamai
* @return
* An array with 2 keys:
* success: TRUE or FALSE indicating cache clearing success
* message: Blank if successful, the error message if not successful.
*/
function clear_url($paths) {
// Grab params
extract($this->parameters);
// make paths an array
if (!is_array($paths)) {
$url = array(
$paths,
);
}
// prepend base path to paths to make URIs
$uris = array();
foreach ($paths as $path) {
$path = rtrim(preg_match("/^\\//", $path) ? $path : "/{$path}");
array_push($uris, $basepath . $path);
}
$opt = array(
"action={$action}",
"domain={$domain}",
"type={$type}",
);
if (!empty($email) && $email != AKAMAI_EMAIL_DISABLE) {
$opt[] = "email-notification={$email}";
}
//use SOAP protocol is Rest API is not default in the settings page
if ($restapi_default !== 1) {
try {
$ccuapi = new SoapClient($soap_wsdl, array(
'trace' => 1,
'features' => SOAP_USE_XSI_ARRAY_TYPE,
));
$response = $ccuapi
->purgeRequest($name, $pwd, '', $opt, $uris);
$is_success = $response->resultCode < 300;
if (!$is_success) {
throw new Exception($response->resultMsg);
}
foreach ($uris as $uri) {
watchdog('Akamai', t("Akamai %action of %uri: %message"), array(
'%uri' => $uri,
'%action' => $action,
'%message' => $response->resultMsg,
), WATCHDOG_NOTICE);
}
return array(
'success' => TRUE,
'code' => $response->resultCode,
'message' => $response->resultMsg,
);
} catch (Exception $e) {
watchdog('Akamai', t("Error Clearing Akamai Cache: %msg"), array(
'%msg' => $e
->getMessage(),
));
throw $e;
}
}
else {
$data = array(
"type" => "arl",
"action" => "{$action}",
"domain" => "{$domain}",
"objects" => $uris,
);
$data_string = json_encode($data);
$data_string = str_replace("\\/", '/', $data_string);
//url needs to be in the format of scheme://user:pass@url
$url_parsed = parse_url($restapi);
$url = $url_parsed['scheme'] . '://' . $name . ':' . $pwd . '@' . $url_parsed['host'] . $url_parsed['path'];
$response = drupal_http_request($url, array(
'method' => 'POST',
'data' => $data_string,
'timeout' => 5,
'headers' => array(
'Content-Type' => 'application/json',
'Content-Length' => strlen($data_string),
),
));
$is_success = $response->code < 300;
if (!$is_success) {
throw new Exception($response->data);
}
$response_data = json_decode($response->data);
watchdog('Akamai', t("Akamai RestAPI %action for %uris: Response: %response"), array(
'%uris' => implode(' ', $uris),
'%action' => $action,
'%response' => $response_data->detail,
), WATCHDOG_NOTICE);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AkamaiCacheControlClient:: |
private | property | ||
AkamaiCacheControlClient:: |
public | property | ||
AkamaiCacheControlClient:: |
function |
Clears the provided URLs from the Akamai Content Cache. Overrides AkamaiCacheControl:: |
||
AkamaiCacheControlClient:: |
function | Constructs an instance of the Akamai Cache Control facade. |