sign_with_server.md

Sign With Server

A simple introduction to the signature server can refer to: Signature Server Guide.

The Local Time Is Incorrect

If the local time of user's clients are not synchronized with the network time.

You should get the network time form the server.

This is an example of the server about how to return the right time to clients.

String gmtTime = QSSignatureUtil.formatGmtDate(new Date());
return gmtTime;

After you get the time form the server, set the time before you call requestHandler1.send();.

reqHandler.getBuilder().setHeader(QSConstant.HEADER_PARAM_KEY_DATE, gmtTime);
reqHandler.sendAsync();

Code Snippet

Take uploading object for example:

try {
    // Step 1: new EnvContext and set zone and bucket
    EnvContext env = new EnvContext("", "");
    Bucket bucket = new Bucket(env, "zoneName", "bucketName");

    Bucket.PutObjectInput putObjectInput = new Bucket.PutObjectInput();
    File file = new File("/filePath/fileName");
    putObjectInput.setBodyInputFile(file);
    putObjectInput.setContentLength(file.length());

    // bucket.putObject("objectName", putObjectInput);

    // Step 2: get the request object
    RequestHandler reqHandler = bucket.putObjectAsyncRequest("objectName", putObjectInput,
        new ResponseCallBack<PutObjectOutput>() {
            @Override
            public void onAPIResponse(PutObjectOutput output) {
                System.out.println("Message = " + output.getMessage());
                System.out.println("RequestId = " + output.getRequestId());
                System.out.println("Code = " + output.getCode());
                System.out.println("StatueCode = " + output.getStatueCode());
                System.out.println("Url = " + output.getUrl());
                }
            });

    // Step 3: get the strToSignature.
    // Please send this strToSignature to the appropriate api of your self-built signature server.
    String strToSignature = reqHandler.getStringToSignature();

    // Step 4: serverAuthorization.
    // The server side processes the returned information, and the processing after the server side receives strToSignature
    // can refer to the following code (note that it is not a local call!!!):
    String serverAuthorization = QSSignatureUtil.generateSignature("secretKey",
        strToSignature);

    // Step 5: set the signature to the request.

    // There may be a time difference between the client and the server, and the result of the signature calculation is closely related to the time.
    // So it is necessary to set the time used for the server's signature to the request.
    // You can send strToSignature to the server to get the server's signature time.
    // The concrete server example refers to the "The Local Time Is Incorrect".
    reqHandler.getBuilder().setHeader(QSConstant.HEADER_PARAM_KEY_DATE, gmtTime);

    reqHandler.setSignature("accessKey", serverAuthorization);

    // Step 6: send request. Async requests use the method sendAsync(), sync requests use the method send().
    reqHandler.sendAsync();

} catch (QSException e) {
    e.printStackTrace();
}