Package dev.openfga.sdk.api.client
Class OpenFgaClient
- java.lang.Object
-
- dev.openfga.sdk.api.client.OpenFgaClient
-
public class OpenFgaClient extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description OpenFgaClient(ClientConfiguration configuration)OpenFgaClient(ClientConfiguration configuration, ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.concurrent.CompletableFuture<java.util.List<ClientBatchCheckResponse>>batchCheck(java.util.List<ClientCheckRequest> requests)BatchCheck - Run a set of checks (evaluates)java.util.concurrent.CompletableFuture<java.util.List<ClientBatchCheckResponse>>batchCheck(java.util.List<ClientCheckRequest> requests, ClientBatchCheckOptions batchCheckOptions)BatchCheck - Run a set of checks (evaluates)java.util.concurrent.CompletableFuture<ClientCheckResponse>check(ClientCheckRequest request)Check - Check if a user has a particular relation with an object (evaluates)java.util.concurrent.CompletableFuture<ClientCheckResponse>check(ClientCheckRequest request, ClientCheckOptions options)Check - Check if a user has a particular relation with an object (evaluates)java.util.concurrent.CompletableFuture<ClientCreateStoreResponse>createStore(CreateStoreRequest request)CreateStore - Initialize a storejava.util.concurrent.CompletableFuture<ClientCreateStoreResponse>createStore(CreateStoreRequest request, ClientCreateStoreOptions options)CreateStore - Initialize a storejava.util.concurrent.CompletableFuture<ClientDeleteStoreResponse>deleteStore()DeleteStore - Delete a storejava.util.concurrent.CompletableFuture<ClientDeleteStoreResponse>deleteStore(ClientDeleteStoreOptions options)DeleteStore - Delete a storejava.util.concurrent.CompletableFuture<ClientWriteResponse>deleteTuples(java.util.List<ClientTupleKeyWithoutCondition> tupleKeys)DeleteTuples - Utility method to delete tuples, wraps Writejava.util.concurrent.CompletableFuture<ClientWriteResponse>deleteTuples(java.util.List<ClientTupleKeyWithoutCondition> tupleKeys, ClientDeleteTuplesOptions options)DeleteTuples - Utility method to delete tuples, wraps Writejava.util.concurrent.CompletableFuture<ClientExpandResponse>expand(ClientExpandRequest request)Expand - Expands the relationships in userset tree format (evaluates)java.util.concurrent.CompletableFuture<ClientExpandResponse>expand(ClientExpandRequest request, ClientExpandOptions options)Expand - Expands the relationships in userset tree format (evaluates)java.util.concurrent.CompletableFuture<ClientGetStoreResponse>getStore()GetStore - Get information about the current store.java.util.concurrent.CompletableFuture<ClientGetStoreResponse>getStore(ClientGetStoreOptions options)GetStore - Get information about the current store.java.util.concurrent.CompletableFuture<ClientListObjectsResponse>listObjects(ClientListObjectsRequest request)ListObjects - List the objects of a particular type that the user has a certain relation to (evaluates)java.util.concurrent.CompletableFuture<ClientListObjectsResponse>listObjects(ClientListObjectsRequest request, ClientListObjectsOptions options)ListObjects - List the objects of a particular type that the user has a certain relation to (evaluates)java.util.concurrent.CompletableFuture<ClientListRelationsResponse>listRelations(ClientListRelationsRequest request)ListRelations - List allowed relations a user has with an object (evaluates)java.util.concurrent.CompletableFuture<ClientListRelationsResponse>listRelations(ClientListRelationsRequest request, ClientListRelationsOptions listRelationsOptions)ListRelations - List allowed relations a user has with an object (evaluates)java.util.concurrent.CompletableFuture<ClientListStoresResponse>listStores()ListStores - Get a paginated list of stores.java.util.concurrent.CompletableFuture<ClientListStoresResponse>listStores(ClientListStoresOptions options)ListStores - Get a paginated list of stores.java.util.concurrent.CompletableFuture<ClientReadResponse>read(ClientReadRequest request)Read - Read tuples previously written to the store (does not evaluate)java.util.concurrent.CompletableFuture<ClientReadResponse>read(ClientReadRequest request, ClientReadOptions options)Read - Read tuples previously written to the store (does not evaluate)java.util.concurrent.CompletableFuture<ClientReadAssertionsResponse>readAssertions()ReadAssertions - Read assertions for a particular authorization modeljava.util.concurrent.CompletableFuture<ClientReadAssertionsResponse>readAssertions(ClientReadAssertionsOptions options)ReadAssertions - Read assertions for a particular authorization modeljava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse>readAuthorizationModel()ReadAuthorizationModel - Read the current authorization modeljava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse>readAuthorizationModel(ClientReadAuthorizationModelOptions options)ReadAuthorizationModel - Read the current authorization modeljava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelsResponse>readAuthorizationModels()ReadAuthorizationModels - Read all authorization modelsjava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelsResponse>readAuthorizationModels(ClientReadAuthorizationModelsOptions options)ReadAuthorizationModels - Read all authorization modelsjava.util.concurrent.CompletableFuture<ClientReadChangesResponse>readChanges(ClientReadChangesRequest request)Read Changes - Read the list of historical relationship tuple writes and deletesjava.util.concurrent.CompletableFuture<ClientReadChangesResponse>readChanges(ClientReadChangesRequest request, ClientReadChangesOptions readChangesOptions)Read Changes - Read the list of historical relationship tuple writes and deletesjava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse>readLatestAuthorizationModel()ReadLatestAuthorizationModel - Read the latest authorization model for the current storejava.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse>readLatestAuthorizationModel(ClientReadLatestAuthorizationModelOptions options)ReadLatestAuthorizationModel - Read the latest authorization model for the current storevoidsetAuthorizationModelId(java.lang.String authorizationModelId)voidsetConfiguration(ClientConfiguration configuration)voidsetStoreId(java.lang.String storeId)java.util.concurrent.CompletableFuture<ClientWriteResponse>write(ClientWriteRequest request)Write - Create or delete relationship tuplesjava.util.concurrent.CompletableFuture<ClientWriteResponse>write(ClientWriteRequest request, ClientWriteOptions options)Write - Create or delete relationship tuplesjava.util.concurrent.CompletableFuture<ClientWriteAssertionsResponse>writeAssertions(java.util.List<ClientAssertion> assertions)WriteAssertions - Updates assertions for a particular authorization modeljava.util.concurrent.CompletableFuture<ClientWriteAssertionsResponse>writeAssertions(java.util.List<ClientAssertion> assertions, ClientWriteAssertionsOptions options)WriteAssertions - Updates assertions for a particular authorization modeljava.util.concurrent.CompletableFuture<ClientWriteAuthorizationModelResponse>writeAuthorizationModel(WriteAuthorizationModelRequest request)WriteAuthorizationModel - Create a new version of the authorization modeljava.util.concurrent.CompletableFuture<ClientWriteAuthorizationModelResponse>writeAuthorizationModel(WriteAuthorizationModelRequest request, ClientWriteAuthorizationModelOptions options)WriteAuthorizationModel - Create a new version of the authorization modeljava.util.concurrent.CompletableFuture<ClientWriteResponse>writeTuples(java.util.List<ClientTupleKey> tupleKeys)WriteTuples - Utility method to write tuples, wraps Writejava.util.concurrent.CompletableFuture<ClientWriteResponse>writeTuples(java.util.List<ClientTupleKey> tupleKeys, ClientWriteTuplesOptions options)WriteTuples - Utility method to write tuples, wraps Write
-
-
-
Constructor Detail
-
OpenFgaClient
public OpenFgaClient(ClientConfiguration configuration) throws FgaInvalidParameterException
- Throws:
FgaInvalidParameterException
-
OpenFgaClient
public OpenFgaClient(ClientConfiguration configuration, ApiClient apiClient) throws FgaInvalidParameterException
- Throws:
FgaInvalidParameterException
-
-
Method Detail
-
setStoreId
public void setStoreId(java.lang.String storeId)
-
setAuthorizationModelId
public void setAuthorizationModelId(java.lang.String authorizationModelId)
-
setConfiguration
public void setConfiguration(ClientConfiguration configuration) throws FgaInvalidParameterException
- Throws:
FgaInvalidParameterException
-
listStores
public java.util.concurrent.CompletableFuture<ClientListStoresResponse> listStores() throws FgaInvalidParameterException
ListStores - Get a paginated list of stores.- Throws:
FgaInvalidParameterException
-
listStores
public java.util.concurrent.CompletableFuture<ClientListStoresResponse> listStores(ClientListStoresOptions options) throws FgaInvalidParameterException
ListStores - Get a paginated list of stores.- Throws:
FgaInvalidParameterException
-
createStore
public java.util.concurrent.CompletableFuture<ClientCreateStoreResponse> createStore(CreateStoreRequest request) throws FgaInvalidParameterException
CreateStore - Initialize a store- Throws:
FgaInvalidParameterException
-
createStore
public java.util.concurrent.CompletableFuture<ClientCreateStoreResponse> createStore(CreateStoreRequest request, ClientCreateStoreOptions options) throws FgaInvalidParameterException
CreateStore - Initialize a store- Throws:
FgaInvalidParameterException
-
getStore
public java.util.concurrent.CompletableFuture<ClientGetStoreResponse> getStore() throws FgaInvalidParameterException
GetStore - Get information about the current store.- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
getStore
public java.util.concurrent.CompletableFuture<ClientGetStoreResponse> getStore(ClientGetStoreOptions options) throws FgaInvalidParameterException
GetStore - Get information about the current store.- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
deleteStore
public java.util.concurrent.CompletableFuture<ClientDeleteStoreResponse> deleteStore() throws FgaInvalidParameterException
DeleteStore - Delete a store- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
deleteStore
public java.util.concurrent.CompletableFuture<ClientDeleteStoreResponse> deleteStore(ClientDeleteStoreOptions options) throws FgaInvalidParameterException
DeleteStore - Delete a store- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readAuthorizationModels
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelsResponse> readAuthorizationModels() throws FgaInvalidParameterException
ReadAuthorizationModels - Read all authorization models- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readAuthorizationModels
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelsResponse> readAuthorizationModels(ClientReadAuthorizationModelsOptions options) throws FgaInvalidParameterException
ReadAuthorizationModels - Read all authorization models- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
writeAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientWriteAuthorizationModelResponse> writeAuthorizationModel(WriteAuthorizationModelRequest request) throws FgaInvalidParameterException
WriteAuthorizationModel - Create a new version of the authorization model- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
writeAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientWriteAuthorizationModelResponse> writeAuthorizationModel(WriteAuthorizationModelRequest request, ClientWriteAuthorizationModelOptions options) throws FgaInvalidParameterException
WriteAuthorizationModel - Create a new version of the authorization model- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse> readAuthorizationModel() throws FgaInvalidParameterException
ReadAuthorizationModel - Read the current authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID are null, empty, or whitespace
-
readAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse> readAuthorizationModel(ClientReadAuthorizationModelOptions options) throws FgaInvalidParameterException
ReadAuthorizationModel - Read the current authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID are null, empty, or whitespace
-
readLatestAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse> readLatestAuthorizationModel() throws FgaInvalidParameterException
ReadLatestAuthorizationModel - Read the latest authorization model for the current store- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readLatestAuthorizationModel
public java.util.concurrent.CompletableFuture<ClientReadAuthorizationModelResponse> readLatestAuthorizationModel(ClientReadLatestAuthorizationModelOptions options) throws FgaInvalidParameterException
ReadLatestAuthorizationModel - Read the latest authorization model for the current store- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readChanges
public java.util.concurrent.CompletableFuture<ClientReadChangesResponse> readChanges(ClientReadChangesRequest request) throws FgaInvalidParameterException
Read Changes - Read the list of historical relationship tuple writes and deletes- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
readChanges
public java.util.concurrent.CompletableFuture<ClientReadChangesResponse> readChanges(ClientReadChangesRequest request, ClientReadChangesOptions readChangesOptions) throws FgaInvalidParameterException
Read Changes - Read the list of historical relationship tuple writes and deletes- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
read
public java.util.concurrent.CompletableFuture<ClientReadResponse> read(ClientReadRequest request) throws FgaInvalidParameterException
Read - Read tuples previously written to the store (does not evaluate)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
read
public java.util.concurrent.CompletableFuture<ClientReadResponse> read(ClientReadRequest request, ClientReadOptions options) throws FgaInvalidParameterException
Read - Read tuples previously written to the store (does not evaluate)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
write
public java.util.concurrent.CompletableFuture<ClientWriteResponse> write(ClientWriteRequest request) throws FgaInvalidParameterException
Write - Create or delete relationship tuples- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
write
public java.util.concurrent.CompletableFuture<ClientWriteResponse> write(ClientWriteRequest request, ClientWriteOptions options) throws FgaInvalidParameterException
Write - Create or delete relationship tuples- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
writeTuples
public java.util.concurrent.CompletableFuture<ClientWriteResponse> writeTuples(java.util.List<ClientTupleKey> tupleKeys) throws FgaInvalidParameterException
WriteTuples - Utility method to write tuples, wraps Write- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
writeTuples
public java.util.concurrent.CompletableFuture<ClientWriteResponse> writeTuples(java.util.List<ClientTupleKey> tupleKeys, ClientWriteTuplesOptions options) throws FgaInvalidParameterException
WriteTuples - Utility method to write tuples, wraps Write- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
deleteTuples
public java.util.concurrent.CompletableFuture<ClientWriteResponse> deleteTuples(java.util.List<ClientTupleKeyWithoutCondition> tupleKeys) throws FgaInvalidParameterException
DeleteTuples - Utility method to delete tuples, wraps Write- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
deleteTuples
public java.util.concurrent.CompletableFuture<ClientWriteResponse> deleteTuples(java.util.List<ClientTupleKeyWithoutCondition> tupleKeys, ClientDeleteTuplesOptions options) throws FgaInvalidParameterException
DeleteTuples - Utility method to delete tuples, wraps Write- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
check
public java.util.concurrent.CompletableFuture<ClientCheckResponse> check(ClientCheckRequest request) throws FgaInvalidParameterException
Check - Check if a user has a particular relation with an object (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
check
public java.util.concurrent.CompletableFuture<ClientCheckResponse> check(ClientCheckRequest request, ClientCheckOptions options) throws FgaInvalidParameterException
Check - Check if a user has a particular relation with an object (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
batchCheck
public java.util.concurrent.CompletableFuture<java.util.List<ClientBatchCheckResponse>> batchCheck(java.util.List<ClientCheckRequest> requests) throws FgaInvalidParameterException
BatchCheck - Run a set of checks (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
batchCheck
public java.util.concurrent.CompletableFuture<java.util.List<ClientBatchCheckResponse>> batchCheck(java.util.List<ClientCheckRequest> requests, ClientBatchCheckOptions batchCheckOptions) throws FgaInvalidParameterException
BatchCheck - Run a set of checks (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
expand
public java.util.concurrent.CompletableFuture<ClientExpandResponse> expand(ClientExpandRequest request) throws FgaInvalidParameterException
Expand - Expands the relationships in userset tree format (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
expand
public java.util.concurrent.CompletableFuture<ClientExpandResponse> expand(ClientExpandRequest request, ClientExpandOptions options) throws FgaInvalidParameterException
Expand - Expands the relationships in userset tree format (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
listObjects
public java.util.concurrent.CompletableFuture<ClientListObjectsResponse> listObjects(ClientListObjectsRequest request) throws FgaInvalidParameterException
ListObjects - List the objects of a particular type that the user has a certain relation to (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
listObjects
public java.util.concurrent.CompletableFuture<ClientListObjectsResponse> listObjects(ClientListObjectsRequest request, ClientListObjectsOptions options) throws FgaInvalidParameterException
ListObjects - List the objects of a particular type that the user has a certain relation to (evaluates)- Throws:
FgaInvalidParameterException- When the Store ID is null, empty, or whitespace
-
listRelations
public java.util.concurrent.CompletableFuture<ClientListRelationsResponse> listRelations(ClientListRelationsRequest request) throws FgaInvalidParameterException
ListRelations - List allowed relations a user has with an object (evaluates)- Throws:
FgaInvalidParameterException
-
listRelations
public java.util.concurrent.CompletableFuture<ClientListRelationsResponse> listRelations(ClientListRelationsRequest request, ClientListRelationsOptions listRelationsOptions) throws FgaInvalidParameterException
ListRelations - List allowed relations a user has with an object (evaluates)- Throws:
FgaInvalidParameterException
-
readAssertions
public java.util.concurrent.CompletableFuture<ClientReadAssertionsResponse> readAssertions() throws FgaInvalidParameterException
ReadAssertions - Read assertions for a particular authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID is null, empty, or whitespace
-
readAssertions
public java.util.concurrent.CompletableFuture<ClientReadAssertionsResponse> readAssertions(ClientReadAssertionsOptions options) throws FgaInvalidParameterException
ReadAssertions - Read assertions for a particular authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID is null, empty, or whitespace
-
writeAssertions
public java.util.concurrent.CompletableFuture<ClientWriteAssertionsResponse> writeAssertions(java.util.List<ClientAssertion> assertions) throws FgaInvalidParameterException
WriteAssertions - Updates assertions for a particular authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID is null, empty, or whitespace
-
writeAssertions
public java.util.concurrent.CompletableFuture<ClientWriteAssertionsResponse> writeAssertions(java.util.List<ClientAssertion> assertions, ClientWriteAssertionsOptions options) throws FgaInvalidParameterException
WriteAssertions - Updates assertions for a particular authorization model- Throws:
FgaInvalidParameterException- When either the Store ID or Authorization Model ID is null, empty, or whitespace
-
-