CkSecrets Java Reference Documentation
CkSecrets
Current Version: 10.1.0
Provides a unified API for managing secrets stored in the following locations:
- Windows Credentials Manager
- Apple Keychain
- AWS Secrets Manager
- Azure Key Vault
- IBM Cloud Secrets Manager
- Oracle Cloud Secrets
- Doppler Secrets
- In-Memory Secrets
Object Creation
CkSecrets obj = new CkSecrets();
Properties
AutoSplit
void put_AutoSplit(boolean newVal);
The AutoSplit property is specific to "local_manager" secrets on Windows. The Windows Credentials Manager supports a maximum of 2560 bytes per secret. If a secret exceeds this size, it will be automatically compressed and split when created or updated, and automatically recomposed when retrieved.
A secret can be split into a maximum of 10 parts.
The default value is true.
Compression
void put_Compression(boolean newVal);
If set to true, then the contents of the secret will be stored compressed. The default value of this property is false.
topDebugLogFilePath
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void put_LastMethodSuccess(boolean newVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topLocation
The location of the secrets. Possible values are:
- "local_manager" - On Windows this is the Credentials Manager. On MacOS and iOS it is the Keychain. This is not yet an option on Linux or Android.
- "aws_secrets_manager" - AWS Secrets Manager
- "azure_key_vault" - Azure Key Vault
- "ibm_cloud" - IBM Cloud Secrets Manager
- "oracle_cloud" - Oracle Cloud Secrets
- "doppler" - Doppler Secrets
- "memory" - In-Memory Secrets
The default location is the "local_manager". On Linux and Android, "local_manager" will behave the same as "memory".
topUncommonOptions
String uncommonOptions();
void put_UncommonOptions(String newVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topVerboseLogging
void put_VerboseLogging(boolean newVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
DeleteSecret
Deletes a secret. Cloud secrets managers will typically disable the secret and schedule the secret for deletion after some number of days.
Returns true for success, false for failure.
DeleteSecretAsync (Android™) (Java)
Creates an asynchronous task to call the DeleteSecret method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topGetSecretBd
Fetches a binary secret and returns the content in bd.
Returns true for success, false for failure.
GetSecretBdAsync (Android™) (Java)
Creates an asynchronous task to call the GetSecretBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topGetSecretJson
Fetches a JSON secret and returns the content in jsonOut.
Returns true for success, false for failure.
GetSecretJsonAsync (Android™) (Java)
Creates an asynchronous task to call the GetSecretJson method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topGetSecretSb
Fetches a string secret and returns the content in sb.
Returns true for success, false for failure.
GetSecretSbAsync (Android™) (Java)
Creates an asynchronous task to call the GetSecretSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topGetSecretStr
String getSecretStr(CkJsonObject jsonId);
Fetches a string secret and returns the content of the secret.
Returns true for success, false for failure.
GetSecretStrAsync (Android™) (Java)
Creates an asynchronous task to call the GetSecretStr method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topListSecrets
Lists secrets matching the wildcarded or exact values passed in json. The results of the query are returned in jsonOut.
Returns true for success, false for failure.
ListSecretsAsync (Android™) (Java)
Creates an asynchronous task to call the ListSecrets method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topSetBootstrapSecret
Accessing a cloud-based secrets manager requires authentication credentials, which cannot be stored in the manager itself. Instead, they must be securely stored locally.
One solution is to store the authentication credentials as a secret in the Windows Credentials Manager or Apple Keychain. These credentials serve as the "bootstrap secret" for authenticating with the cloud-based secrets manager.
jsonId contains the name of the bootstrap secret. secretContent contains the bootstrap's secret content.
Returns true for success, false for failure.
UpdateSecretBd
Creates a binary secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in jsonId, and the binary content of the secret in secret.
Returns true for success, false for failure.
UpdateSecretBdAsync (Android™) (Java)
Creates an asynchronous task to call the UpdateSecretBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topUpdateSecretJson
Creates a JSON secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in jsonId, and the JSON content of the secret in secret.
Returns true for success, false for failure.
UpdateSecretJsonAsync (Android™) (Java)
Creates an asynchronous task to call the UpdateSecretJson method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topUpdateSecretSb
Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in jsonId, and the string content of the secret in sb.
Returns true for success, false for failure.
UpdateSecretSbAsync (Android™) (Java)
Creates an asynchronous task to call the UpdateSecretSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topUpdateSecretStr
Creates a string secret if it does not yet exist, or updates an existing secret. The name of the secret is specified in jsonId, and the string content of the secret in secret.
Returns true for success, false for failure.
UpdateSecretStrAsync (Android™) (Java)
Creates an asynchronous task to call the UpdateSecretStr method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEvents
Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.
For example:
// Install an event callback handler to get progress events. MyBaseProgress secretsProgress = new MyBaseProgress(); http.put_EventCallbackObject(secretsProgress);
MyBaseProgress example:
import com.chilkatsoft.CkBaseProgress;
import com.chilkatsoft.CkTask;
public class MyBaseProgress extends CkBaseProgress
{
public boolean AbortCheck()
{
System.out.println("AbortCheck");
// Return true to abort, false to allow the method to continue.
return false;
}
// pctDone is a value from 0 to 100
// (it is actually value from 0 to the PercentDoneScale property setting)
public boolean PercentDone(int pctDone)
{
System.out.println(pctDone);
// Return true to abort, false to allow the method to continue.
// Note: A PercentDone event is the equivalent of an AbortCheck.
// When PercentDone events are frequently firing, AbortCheck events are suppressed.
// AbortCheck events will fire when the time between PercentDone events is longer
// than the HeartbeatMs property setting.
return false;
}
public void ProgressInfo(String name, String value)
{
System.out.println(name + ": " + value);
}
public void TaskCompleted(CkTask task)
{
System.out.println("task completed!");
}
}
AbortCheck
Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return true to abort; return false to continue (not abort)
PercentDone
Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).
The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.
Return true to abort; return false to continue (not abort)
ProgressInfo
A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.
TaskCompleted
Called in the background thread when an asynchronous task completes.