| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* Copyright 2010-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
|
4 |
*
|
|
|
5 |
* Licensed under the Apache License, Version 2.0 (the "License").
|
|
|
6 |
* You may not use this file except in compliance with the License.
|
|
|
7 |
* A copy of the License is located at
|
|
|
8 |
*
|
|
|
9 |
* http://aws.amazon.com/apache2.0
|
|
|
10 |
*
|
|
|
11 |
* or in the "license" file accompanying this file. This file is distributed
|
|
|
12 |
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
|
13 |
* express or implied. See the License for the specific language governing
|
|
|
14 |
* permissions and limitations under the License.
|
|
|
15 |
*/
|
|
|
16 |
|
|
|
17 |
|
|
|
18 |
/*%******************************************************************************************%*/
|
|
|
19 |
// INTERFACE
|
|
|
20 |
|
|
|
21 |
/**
|
|
|
22 |
* The interface implemented by all signing classes.
|
|
|
23 |
*
|
|
|
24 |
* @version 2011.11.22
|
|
|
25 |
* @license See the included NOTICE.md file for more information.
|
|
|
26 |
* @copyright See the included NOTICE.md file for more information.
|
|
|
27 |
* @link http://aws.amazon.com/php/ PHP Developer Center
|
|
|
28 |
*/
|
|
|
29 |
interface Signable
|
|
|
30 |
{
|
|
|
31 |
/**
|
|
|
32 |
* Constructs a new instance of the implementing class.
|
|
|
33 |
*
|
|
|
34 |
* @param string $endpoint (Required) The endpoint to direct the request to.
|
|
|
35 |
* @param string $operation (Required) The operation to execute as a result of this request.
|
|
|
36 |
* @param array $payload (Required) The options to use as part of the payload in the request.
|
|
|
37 |
* @param CFCredential $credentials (Required) The credentials to use for signing and making requests.
|
|
|
38 |
* @return void
|
|
|
39 |
*/
|
|
|
40 |
public function __construct($endpoint, $operation, $payload, CFCredential $credentials);
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* Generates a cURL handle with all of the required authentication bits set.
|
|
|
44 |
*
|
|
|
45 |
* @return resource A cURL handle ready for executing.
|
|
|
46 |
*/
|
|
|
47 |
public function authenticate();
|
|
|
48 |
}
|