VolcstackSign (volcengine-java-sdk-core 2.0.10 API)

java.lang.Object
- com.volcengine.sign.VolcstackSign

All Implemented Interfaces:

Authentication
```
public class VolcstackSign
extends Object
implements Authentication
```
[email protected] 2022/3/18 13:13

Constructor Summary

Constructors
Constructor Description

VolcstackSign()

VolcstackSign(Credentials credentials)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`applyToParams(List<Pair> queryParams, Map<String,String> headerParams, String payload)`	Apply authentication settings to header and query params.
`VolcstackSign`	`copy()`
`Credentials`	`getCredentials()`
`String`	`getMethod()`
`String`	`getRegion()`
`String`	`getService()`
`Map<String,String>`	`presign(Map<String,String> queryParams)`	Generate presigned URL query parameters (without host signing)
`Map<String,String>`	`presign(Map<String,String> queryParams, String host)`	Generate presigned URL query parameters
`void`	`setCredentials(Credentials credentials)`
`void`	`setMethod(String method)`
`void`	`setRegion(String region)`
`void`	`setService(String service)`

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

Constructor Detail

VolcstackSign
```
public VolcstackSign()
```

VolcstackSign

public VolcstackSign(Credentials credentials)

Method Detail

applyToParams
```
public void applyToParams(List<Pair> queryParams,
                          Map<String,String> headerParams,
                          String payload)
```
Description copied from interface: Authentication

Apply authentication settings to header and query params.

Specified by:

applyToParams in interface Authentication

Parameters:

queryParams - List of query parameters

headerParams - Map of header parameters

getCredentials
```
public Credentials getCredentials()
```

setCredentials

public void setCredentials(Credentials credentials)

getRegion
```
public String getRegion()
```

setRegion

public void setRegion(String region)

getService
```
public String getService()
```

setService

public void setService(String service)

getMethod
```
public String getMethod()
```

setMethod

public void setMethod(String method)

copy
```
public VolcstackSign copy()
```

presign
```
public Map<String,String> presign(Map<String,String> queryParams)
                                 throws Exception
```
Generate presigned URL query parameters (without host signing)

Parameters:

queryParams - Original query parameters

Returns:

Complete query parameters Map containing all signature information

Throws:

Exception

presign
```
public Map<String,String> presign(Map<String,String> queryParams,
                                        String host)
                                 throws Exception
```
Generate presigned URL query parameters

Parameters:

queryParams - Original query parameters

host - Host header value to include in signing (e.g., "rds-mysql.cn-beijing.volcengineapi.com"). If null or empty, no host header is signed.

Returns:

Complete query parameters Map containing all signature information

Throws:

Exception