Uses of Class org.forgerock.macaroons.Macaroon (OpenAM Server Only 7.4.1 Documentation)

Packages that use Macaroon
Package	Description
org.forgerock.macaroons	Implementation of Macaroons: Cookies with contextual caveats for decentralized authorization in the cloud. See `Macaroon` for more details.

Uses of Macaroon in org.forgerock.macaroons

Methods in org.forgerock.macaroons that return Macaroon
Modifier and Type	Method	Description
`Macaroon`	Macaroon.`addFirstPartyCaveat(byte[] caveat)`	Adds a first-party caveat to the macaroon.
`Macaroon`	Macaroon.`addFirstPartyCaveat(String caveat)`	Adds a first-party caveat to the macaroon.
`Macaroon`	Macaroon.`addFirstPartyCaveat(JsonValue caveat)`	Adds a first-party caveat to the macaroon.
`Macaroon`	Macaroon.`addThirdPartyCaveat(String location, byte[] caveatKey, byte[] identifier)`	Adds a third-party caveat to the macaroon.
`Macaroon`	Macaroon.`addThirdPartyCaveat(String location, byte[] caveatKey, String identifier)`	Adds a third-party caveat to the macaroon.
`Macaroon`	Macaroon.`copy()`	Creates a copy of this macaroon.
`static Macaroon`	Macaroon.`create(Key key, String location, byte[] identifier)`	Creates a fresh Macaroon with no caveats.
`static Macaroon`	Macaroon.`create(SigningKey key)`	Creates a fresh Macaroon with no caveats, a blank location hint, and a random identifier.
`static Macaroon`	Macaroon.`create(SigningKey key, String location)`	Creates a fresh Macaroon with no caveats and a random identifier.
`static Macaroon`	Macaroon.`create(SigningKey signingKey, String location, byte[] identifier)`	Creates a fresh Macaroon with no caveats.
`static Macaroon`	Macaroon.`create(SigningKey signingKey, String location, String identifier)`	Creates a fresh Macaroon with no caveats.
`static Macaroon`	Macaroon.`deserialize(String macaroon)`	Deserializes a macaroon from the default format.
`static Macaroon`	Macaroon.`deserialize(SerializationFormat format, String macaroon)`	Deserializes a macaroon from the given format.
`Macaroon`	SerializationFormat.`deserialize(String data)`	Reads a macaroon from a string.

Methods in org.forgerock.macaroons that return types with arguments of type Macaroon
Modifier and Type	Method	Description
`List<Macaroon>`	Macaroon.`prepareForRequest(Macaroon... dischargeMacaroons)`	Prepares this macaroon to be sent with a request by binding any discharge macaroons to it.

Methods in org.forgerock.macaroons with parameters of type Macaroon
Modifier and Type	Method	Description
`boolean`	CaveatVerifier.`isSatisfied(Macaroon.Caveat caveat, Macaroon macaroon)`	Checks whether the given caveat is satisfied.
`boolean`	JsonCaveatVerifier.`isSatisfied(Macaroon.Caveat caveat, Macaroon macaroon)`
`List<Macaroon>`	Macaroon.`prepareForRequest(Macaroon... dischargeMacaroons)`	Prepares this macaroon to be sent with a request by binding any discharge macaroons to it.
`MacaroonVerifier`	MacaroonVerifier.`satisfyThirdParty(Macaroon dischargeMacaroon)`	Satisfies a 3rd-party caveat using the given discharge macaroon.
`String`	SerializationFormat.`serialize(Macaroon macaroon)`	Converts the macaroon to a string.
`Promise<MacaroonVerifierResult,RejectedMacaroonException>`	MacaroonVerifier.`verify(Macaroon macaroon)`	Verifies the given macaroon using any valid verification key and testing to see that all caveats are satisfied.

Method parameters in org.forgerock.macaroons with type arguments of type Macaroon
Modifier and Type	Method	Description
`MacaroonVerifier`	MacaroonVerifier.`satisfyThirdParty(Iterable<Macaroon> dischargeMacaroons)`	Satisfies one or more 3rd-party caveats using the given discharge macaroons.