Interface Bucket
public interface Bucket
A
Bucket is a store for arbitrary data, available for plugins and procedures.- Since:
- 3.0.0
-
Method Summary
Modifier and TypeMethodDescriptionbooleanclearBucket(String subject, String purpose) Delete all attributes in a bucket for a given subject and purpose.getAttributes(String subject, String purpose) Get all attributes associated with the given subject and purpose.Persist provided attributes for the given subject and purpose.
-
Method Details
-
getAttributes
Get all attributes associated with the given subject and purpose.- Parameters:
subject- The subject for which to get attributespurpose- The purpose (i.e. "action") for which the subject's attributes should be retrieved for- Returns:
- All attributes found for the given subject and purpose (empty if no attributes found)
-
storeAttributes
Persist provided attributes for the given subject and purpose. This method overwrites any previous attributes.- Parameters:
subject- The subject for which to store attributespurpose- The purpose for which the stored attributes are storedattributes- The attributes- Returns:
- The attributes that were stored with the request
-
clearBucket
Delete all attributes in a bucket for a given subject and purpose.- Parameters:
subject- The subject for which to delete any stored attributespurpose- The purpose for which to delete any stored attributes- Returns:
- Whether anything was deleted as a result of this method being called
-