Package codes.grow.packages.vault
Class Capabilities
java.lang.Object
codes.grow.packages.vault.Capabilities
The capabilities a token has on each requested path (
sys/capabilities-self or
sys/capabilities), for example ["create", "read", "update"], ["deny"] or
["root"]. Use allows(String, String) to check a policy before acting.
Capabilities caps = client.sys().capabilitiesSelf("secret/data/app/db");
if (caps.allows("secret/data/app/db", Capabilities.UPDATE)) { ... }
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringCapabilitycreate.static final StringCapabilitydelete.static final StringCapabilitydeny: nothing is allowed.static final StringCapabilitylist.static final StringCapabilitypatch.static final StringCapabilityread.static final StringCapabilityroot: everything is allowed.static final StringCapabilitysudo.static final StringCapabilityupdate. -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhetherpathgrantscapability:rootgrants everything;denyor a path that was not requested grants nothing.asMap()All requested paths with their capabilities.booleanThe capabilities on one path; empty when the path was not requested.inthashCode()static CapabilitiesCreates a capability map (tests, fakes).toString()
-
Field Details
-
CREATE
Capabilitycreate.- See Also:
-
READ
Capabilityread.- See Also:
-
UPDATE
Capabilityupdate.- See Also:
-
PATCH
Capabilitypatch.- See Also:
-
DELETE
Capabilitydelete.- See Also:
-
LIST
Capabilitylist.- See Also:
-
SUDO
Capabilitysudo.- See Also:
-
DENY
Capabilitydeny: nothing is allowed.- See Also:
-
ROOT
Capabilityroot: everything is allowed.- See Also:
-
-
Method Details
-
of
Creates a capability map (tests, fakes).- Parameters:
byPath- capabilities by path- Returns:
- the map
-
get
The capabilities on one path; empty when the path was not requested.- Parameters:
path- requested path- Returns:
- the capabilities (never null)
-
allows
Whetherpathgrantscapability:rootgrants everything;denyor a path that was not requested grants nothing.- Parameters:
path- requested pathcapability- capability name, e.g.READ- Returns:
- true when allowed
-
asMap
All requested paths with their capabilities.- Returns:
- an unmodifiable map
-
equals
-
hashCode
public int hashCode() -
toString
-