Package com.aserto.directory.v3

Class DirectoryClient

java.lang.Object

com.aserto.directory.v3.DirectoryClient

All Implemented Interfaces:

DirectoryClientExporter, DirectoryClientImporter, DirectoryClientModel, DirectoryClientReader, DirectoryClientWriter

public class DirectoryClient
extends Object
implements DirectoryClientReader, DirectoryClientWriter, DirectoryClientModel, DirectoryClientImporter, DirectoryClientExporter

Constructor Summary

Constructors

Constructor	Description
DirectoryClient(io.grpc.ManagedChannel managedChannel)
DirectoryClient(io.grpc.ManagedChannel readerChannel, io.grpc.ManagedChannel writerChannel, io.grpc.ManagedChannel importerChannel, io.grpc.ManagedChannel exporterChannel, io.grpc.ManagedChannel modelChannel)

Method Summary

Modifier and Type	Method	Description
com.aserto.directory.reader.v3.CheckResponse	check(String objectType, String objectId, String relationName, String subjectType, String subjectId)
com.aserto.directory.reader.v3.CheckResponse	check(String objectType, String objectId, String relationName, String subjectType, String subjectId, boolean trace)
com.aserto.directory.reader.v3.CheckPermissionResponse	checkPermission(String objectType, String objectId, String subjectType, String subjectId, String permissionName)	Deprecated. use @link check(String, String, String, String, String) instead.
com.aserto.directory.reader.v3.CheckPermissionResponse	checkPermission(String objectType, String objectId, String subjectType, String subjectId, String permissionName, boolean trace)	Deprecated. use @link check(String, String, String, String, String, boolean) instead.
com.aserto.directory.reader.v3.CheckRelationResponse	checkRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId)	Deprecated. use @link check(String, String, String, String, String) instead.
com.aserto.directory.reader.v3.CheckRelationResponse	checkRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, boolean trace)	Deprecated. use @link check(String, String, String, String, String, boolean) instead.
com.aserto.directory.model.v3.DeleteManifestResponse	deleteManifest()
com.aserto.directory.writer.v3.DeleteObjectResponse	deleteObject(String type, String id)
com.aserto.directory.writer.v3.DeleteObjectResponse	deleteObject(String type, String id, boolean withRelations)
com.aserto.directory.writer.v3.DeleteRelationResponse	deleteRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId)
com.aserto.directory.writer.v3.DeleteRelationResponse	deleteRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, String subjectRelation)
Iterator<com.aserto.directory.exporter.v3.ExportResponse>	exportData(com.aserto.directory.exporter.v3.Option options)
Iterator<com.aserto.directory.exporter.v3.ExportResponse>	exportData(com.aserto.directory.exporter.v3.Option options, com.google.protobuf.Timestamp startFrom)
com.aserto.directory.reader.v3.GetGraphResponse	getGraph(com.aserto.directory.reader.v3.GetGraphRequest getGraphRequest)
com.aserto.directory.model.v3.GetManifestResponse	getManifest()
com.aserto.directory.reader.v3.GetObjectResponse	getObject(String type, String id)
com.aserto.directory.reader.v3.GetObjectResponse	getObject(String type, String id, boolean withRelations)
com.aserto.directory.reader.v3.GetObjectManyResponse	getObjectManyRequest(List<com.aserto.directory.common.v3.ObjectIdentifier> objectIdentifiers)
com.aserto.directory.reader.v3.GetObjectsResponse	getObjects(String type)
com.aserto.directory.reader.v3.GetObjectsResponse	getObjects(String type, int pageSize, String pageToken)
com.aserto.directory.reader.v3.GetRelationResponse	getRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId)
com.aserto.directory.reader.v3.GetRelationResponse	getRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, boolean withObjects)
com.aserto.directory.reader.v3.GetRelationResponse	getRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, String subjectRelation)
com.aserto.directory.reader.v3.GetRelationResponse	getRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, String subjectRelation, boolean withObjects)
com.aserto.directory.reader.v3.GetRelationsResponse	getRelations(com.aserto.directory.reader.v3.GetRelationsRequest relationsRequest)
void	importData(Stream<ImportElement> importStream)	Sets and/or deletes a stream of objects and relations without any feedback.
io.grpc.Status	importData(Stream<ImportElement> importStream, ImportHandler handler)	Sets and/or deletes a stream of objects and relations.
void	setManifest(String manifest)
com.aserto.directory.writer.v3.SetObjectResponse	setObject(String type, String id)
com.aserto.directory.writer.v3.SetObjectResponse	setObject(String type, String id, String displayName, com.google.protobuf.Struct properties, String hash)
com.aserto.directory.writer.v3.SetRelationResponse	setRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId)
com.aserto.directory.writer.v3.SetRelationResponse	setRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, String subjectRelation)
com.aserto.directory.writer.v3.SetRelationResponse	setRelation(String objectType, String objectId, String relationName, String subjectType, String subjectId, String subjectRelation, String hash)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DirectoryClient

public DirectoryClient(io.grpc.ManagedChannel readerChannel,
 io.grpc.ManagedChannel writerChannel,
 io.grpc.ManagedChannel importerChannel,
 io.grpc.ManagedChannel exporterChannel,
 io.grpc.ManagedChannel modelChannel)

DirectoryClient

public DirectoryClient(io.grpc.ManagedChannel managedChannel)

Method Details

getObject

public com.aserto.directory.reader.v3.GetObjectResponse getObject(String type,
 String id)
                                                           throws UninitilizedClientException

Specified by:

getObject in interface DirectoryClientReader

Throws:

UninitilizedClientException

getObject

public com.aserto.directory.reader.v3.GetObjectResponse getObject(String type,
 String id,
 boolean withRelations)
                                                           throws UninitilizedClientException

Specified by:

getObject in interface DirectoryClientReader

Throws:

UninitilizedClientException

getObjects

public com.aserto.directory.reader.v3.GetObjectsResponse getObjects(String type)
                                                             throws UninitilizedClientException

Specified by:

getObjects in interface DirectoryClientReader

Throws:

UninitilizedClientException

getObjects

public com.aserto.directory.reader.v3.GetObjectsResponse getObjects(String type,
 int pageSize,
 String pageToken)
                                                             throws UninitilizedClientException

Specified by:

getObjects in interface DirectoryClientReader

Throws:

UninitilizedClientException

getObjectManyRequest

public com.aserto.directory.reader.v3.GetObjectManyResponse getObjectManyRequest(List<com.aserto.directory.common.v3.ObjectIdentifier> objectIdentifiers)
                                                                          throws UninitilizedClientException

Specified by:

getObjectManyRequest in interface DirectoryClientReader

Throws:

UninitilizedClientException

getRelation

public com.aserto.directory.reader.v3.GetRelationResponse getRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId)
                                                               throws UninitilizedClientException

Specified by:

getRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

getRelation

public com.aserto.directory.reader.v3.GetRelationResponse getRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 boolean withObjects)
                                                               throws UninitilizedClientException

Specified by:

getRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

getRelation

public com.aserto.directory.reader.v3.GetRelationResponse getRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 String subjectRelation)
                                                               throws UninitilizedClientException

Specified by:

getRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

getRelation

public com.aserto.directory.reader.v3.GetRelationResponse getRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 String subjectRelation,
 boolean withObjects)
                                                               throws UninitilizedClientException

Specified by:

getRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

getRelations

public com.aserto.directory.reader.v3.GetRelationsResponse getRelations(com.aserto.directory.reader.v3.GetRelationsRequest relationsRequest)
                                                                 throws UninitilizedClientException

Specified by:

getRelations in interface DirectoryClientReader

Throws:

UninitilizedClientException

checkPermission

@Deprecated
public com.aserto.directory.reader.v3.CheckPermissionResponse checkPermission(String objectType,
 String objectId,
 String subjectType,
 String subjectId,
 String permissionName)
                                                                       throws UninitilizedClientException

Deprecated.

use @link check(String, String, String, String, String) instead.

Checks whether a subject has a given permission on an object.

Specified by:

checkPermission in interface DirectoryClientReader

Throws:

UninitilizedClientException

checkPermission

@Deprecated
public com.aserto.directory.reader.v3.CheckPermissionResponse checkPermission(String objectType,
 String objectId,
 String subjectType,
 String subjectId,
 String permissionName,
 boolean trace)
                                                                       throws UninitilizedClientException

Deprecated.

use @link check(String, String, String, String, String, boolean) instead.

Checks whether a subject has a given permission on an object.

Specified by:

checkPermission in interface DirectoryClientReader

Throws:

UninitilizedClientException

checkRelation

@Deprecated
public com.aserto.directory.reader.v3.CheckRelationResponse checkRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId)
                                                                   throws UninitilizedClientException

Deprecated.

use @link check(String, String, String, String, String) instead.

Checks whether a subject has a given relation to an object.

Specified by:

checkRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

checkRelation

@Deprecated
public com.aserto.directory.reader.v3.CheckRelationResponse checkRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 boolean trace)
                                                                   throws UninitilizedClientException

Deprecated.

use @link check(String, String, String, String, String, boolean) instead.

Checks whether a subject has a given relation to an object.

Specified by:

checkRelation in interface DirectoryClientReader

Throws:

UninitilizedClientException

check

public com.aserto.directory.reader.v3.CheckResponse check(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId)
                                                   throws UninitilizedClientException

Specified by:

check in interface DirectoryClientReader

Throws:

UninitilizedClientException

check

public com.aserto.directory.reader.v3.CheckResponse check(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 boolean trace)
                                                   throws UninitilizedClientException

Specified by:

check in interface DirectoryClientReader

Throws:

UninitilizedClientException

getGraph

public com.aserto.directory.reader.v3.GetGraphResponse getGraph(com.aserto.directory.reader.v3.GetGraphRequest getGraphRequest)

Specified by:

getGraph in interface DirectoryClientReader

setObject

public com.aserto.directory.writer.v3.SetObjectResponse setObject(String type,
 String id)
                                                           throws UninitilizedClientException

Specified by:

setObject in interface DirectoryClientWriter

Throws:

UninitilizedClientException

setObject

public com.aserto.directory.writer.v3.SetObjectResponse setObject(String type,
 String id,
 String displayName,
 com.google.protobuf.Struct properties,
 String hash)
                                                           throws UninitilizedClientException

Specified by:

setObject in interface DirectoryClientWriter

Throws:

UninitilizedClientException

deleteObject

public com.aserto.directory.writer.v3.DeleteObjectResponse deleteObject(String type,
 String id)
                                                                 throws UninitilizedClientException

Specified by:

deleteObject in interface DirectoryClientWriter

Throws:

UninitilizedClientException

deleteObject

public com.aserto.directory.writer.v3.DeleteObjectResponse deleteObject(String type,
 String id,
 boolean withRelations)
                                                                 throws UninitilizedClientException

Specified by:

deleteObject in interface DirectoryClientWriter

Throws:

UninitilizedClientException

setRelation

public com.aserto.directory.writer.v3.SetRelationResponse setRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId)
                                                               throws UninitilizedClientException

Specified by:

setRelation in interface DirectoryClientWriter

Throws:

UninitilizedClientException

setRelation

public com.aserto.directory.writer.v3.SetRelationResponse setRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 String subjectRelation)
                                                               throws UninitilizedClientException

Specified by:

setRelation in interface DirectoryClientWriter

Throws:

UninitilizedClientException

setRelation

public com.aserto.directory.writer.v3.SetRelationResponse setRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 String subjectRelation,
 String hash)
                                                               throws UninitilizedClientException

Specified by:

setRelation in interface DirectoryClientWriter

Throws:

UninitilizedClientException

deleteRelation

public com.aserto.directory.writer.v3.DeleteRelationResponse deleteRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId)
                                                                     throws UninitilizedClientException

Specified by:

deleteRelation in interface DirectoryClientWriter

Throws:

UninitilizedClientException

deleteRelation

public com.aserto.directory.writer.v3.DeleteRelationResponse deleteRelation(String objectType,
 String objectId,
 String relationName,
 String subjectType,
 String subjectId,
 String subjectRelation)
                                                                     throws UninitilizedClientException

Specified by:

deleteRelation in interface DirectoryClientWriter

Throws:

UninitilizedClientException

getManifest

public com.aserto.directory.model.v3.GetManifestResponse getManifest()
                                                              throws UninitilizedClientException

Specified by:

getManifest in interface DirectoryClientModel

Throws:

UninitilizedClientException

setManifest

public void setManifest(String manifest)
                 throws InterruptedException,
UninitilizedClientException

Specified by:

setManifest in interface DirectoryClientModel

Throws:

InterruptedException

UninitilizedClientException

deleteManifest

public com.aserto.directory.model.v3.DeleteManifestResponse deleteManifest()
                                                                    throws UninitilizedClientException

Specified by:

deleteManifest in interface DirectoryClientModel

Throws:

UninitilizedClientException

importData

public void importData(Stream<ImportElement> importStream)
                throws InterruptedException,
UninitilizedClientException

Description copied from interface: DirectoryClientImporter

Sets and/or deletes a stream of objects and relations without any feedback.

Specified by:

importData in interface DirectoryClientImporter

Parameters:

importStream - a stream of ImportElement objects representing the set of objects and/or relations to be added or deleted.

Throws:

InterruptedException - if the operations is interrupted before completion.

UninitilizedClientException - if called on an uninitialized client.

importData

public io.grpc.Status importData(Stream<ImportElement> importStream,
 ImportHandler handler)
                          throws InterruptedException,
UninitilizedClientException

Description copied from interface: DirectoryClientImporter

Sets and/or deletes a stream of objects and relations.

Specified by:

importData in interface DirectoryClientImporter

Parameters:

importStream - a stream of ImportElement objects representing the set of objects and/or relations to be added or deleted.

handler - a ImportHandler object to receive progress and error events.

Throws:

InterruptedException - if the operations is interrupted before completion.

UninitilizedClientException - if called on an uninitialized client.

exportData

public Iterator<com.aserto.directory.exporter.v3.ExportResponse> exportData(com.aserto.directory.exporter.v3.Option options)
                                                                     throws UninitilizedClientException

Specified by:

exportData in interface DirectoryClientExporter

Throws:

UninitilizedClientException

exportData

public Iterator<com.aserto.directory.exporter.v3.ExportResponse> exportData(com.aserto.directory.exporter.v3.Option options,
 com.google.protobuf.Timestamp startFrom)
                                                                     throws UninitilizedClientException

Specified by:

exportData in interface DirectoryClientExporter

Throws:

UninitilizedClientException