Package org.topbraidlive.client.java

Interface Client

All Superinterfaces:

AddProjectImportApiFunction, AddRoleToGroupApiFunction, AddTriplesApiFunction, Api, ApiFunction, AutoCloseable, CanCreateProjectApiFunction, CanDeleteProjectApiFunction, CheckGovernanceAreaExistsApiFunction, CheckProjectExistsApiFunction, ClearProjectApiFunction, CreateGovernanceAreaApiFunction, CreateProjectApiFunction, DeleteProjectApiFunction, DeleteResourceApiFunction, EnableGovernanceRoleApiFunction, ExecuteSpinTemplateApiFunction, ExecuteSwpViewClassApiFunction, ExportToRdfApiFunction, GetPlatformGraphqlConnectionApiFunction, GetProjectGraphqlConnectionApiFunction, GetRawGraphqlConnectionApiFunction, GetSparqlConnectionApiFunction, ListProjectsApiFunction, QuerySparqlApiFunction, SetGovernanceAreaPermission, UnzipProjectApiFunction

All Known Implementing Classes:

ClientImpl

public interface Client
extends Api, AutoCloseable

Primary client interface. Extends the server API with a few convenience methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.topbraidlive.client.java.api.exception.UnzipProjectApiFunction

UnzipProjectApiFunction.OldProject

Method Summary

Modifier and Type	Method	Description
void	addProjectImport(String import_, String projectGraph)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	addRoleToGroup(String group, String role)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	addTriples(boolean complete, String graphUri, org.apache.jena.shared.PrefixMapping prefixMapping, Iterator<org.apache.jena.graph.Triple> triples)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	addTriplesBatched(int batchSize, String graphUri, org.apache.jena.shared.PrefixMapping prefixMapping, Iterator<org.apache.jena.graph.Triple> triples)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	addTriplesBatched(int batchSize, Uri graphUri, org.apache.jena.shared.PrefixMapping prefixMapping, Iterator<org.apache.jena.graph.Triple> triples)	Convenience method to add triples in batches from an iterator.
boolean	canDeleteProject(String projectGraph)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
boolean	checkGovernanceAreaExists(String uri)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
boolean	checkProjectExists(String projectGraph)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	clearProject(String projectGraph)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	close()
ClientConfiguration	configuration()	Get the client's configuration.
static Client	create()	Factory method for implementations.
static Client	create(ClientConfiguration clientConfiguration)	Factory method for implementations.
void	createGovernanceArea(String label, String type, String uri, String labelLang)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	deleteProject(String projectGraph)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	deleteResource(String base, String resource)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
void	enableGovernanceRole(String governanceRole, String subjectArea)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.
RawGraphqlConnection	getRawGraphqlConnection(ProjectGraphUri projectGraphUri)	Convenience method to get a raw GraphQL connection for a project.
RawGraphqlConnection	getRawGraphqlConnection(ProjectGraphUri projectGraphUri, Optional<ProjectGraphqlSchemaType> projectGraphqlSchemaType)	Convenience method to get a raw GraphQL connection for a project.
void	setGovernanceRolePermission(String governanceArea, String governancePermission, String governanceRole)	Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

Methods inherited from interface org.topbraidlive.client.java.api.function.AddProjectImportApiFunction

addProjectImport

Methods inherited from interface org.topbraidlive.client.java.api.function.AddRoleToGroupApiFunction

addRoleToGroup

Methods inherited from interface org.topbraidlive.client.java.api.function.AddTriplesApiFunction

addTriples

Methods inherited from interface org.topbraidlive.client.java.api.function.CanCreateProjectApiFunction

canCreateProject

Methods inherited from interface org.topbraidlive.client.java.api.function.CanDeleteProjectApiFunction

canDeleteProject

Methods inherited from interface org.topbraidlive.client.java.api.function.CheckGovernanceAreaExistsApiFunction

checkGovernanceAreaExists

Methods inherited from interface org.topbraidlive.client.java.api.function.CheckProjectExistsApiFunction

checkProjectExists

Methods inherited from interface org.topbraidlive.client.java.api.function.ClearProjectApiFunction

clearProject

Methods inherited from interface org.topbraidlive.client.java.api.function.CreateGovernanceAreaApiFunction

createGovernanceArea

Methods inherited from interface org.topbraidlive.client.java.api.function.CreateProjectApiFunction

createProject

Methods inherited from interface org.topbraidlive.client.java.api.function.DeleteProjectApiFunction

deleteProject

Methods inherited from interface org.topbraidlive.client.java.api.function.DeleteResourceApiFunction

deleteResource

Methods inherited from interface org.topbraidlive.client.java.api.function.EnableGovernanceRoleApiFunction

enableGovernanceRole

Methods inherited from interface org.topbraidlive.client.java.api.function.ExecuteSpinTemplateApiFunction

executeSpinTemplate

Methods inherited from interface org.topbraidlive.client.java.api.function.ExecuteSwpViewClassApiFunction

executeSwpViewClass, executeSwpViewClassToString

Methods inherited from interface org.topbraidlive.client.java.api.function.ExportToRdfApiFunction

exportToRdf

Methods inherited from interface org.topbraidlive.client.java.api.function.GetPlatformGraphqlConnectionApiFunction

getPlatformGraphqlConnection

Methods inherited from interface org.topbraidlive.client.java.api.function.GetProjectGraphqlConnectionApiFunction

getProjectGraphqlConnection

Methods inherited from interface org.topbraidlive.client.java.api.function.GetRawGraphqlConnectionApiFunction

getRawGraphqlConnection

Methods inherited from interface org.topbraidlive.client.java.api.function.GetSparqlConnectionApiFunction

getSparqlConnection

Methods inherited from interface org.topbraidlive.client.java.api.function.ListProjectsApiFunction

listProjects

Methods inherited from interface org.topbraidlive.client.java.api.function.QuerySparqlApiFunction

querySparql

Methods inherited from interface org.topbraidlive.client.java.api.function.SetGovernanceAreaPermission

setGovernanceRolePermission

Methods inherited from interface org.topbraidlive.client.java.api.exception.UnzipProjectApiFunction

unzipProject

Method Detail

addProjectImport

void addProjectImport(String import_,
                      String projectGraph)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

AddProjectImportApiFunction.addProjectImport(Uri, ProjectGraphUri)

addTriples

void addTriples(boolean complete,
                String graphUri,
                org.apache.jena.shared.PrefixMapping prefixMapping,
                Iterator<org.apache.jena.graph.Triple> triples)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

AddTriplesApiFunction.addTriples(boolean, Uri, PrefixMapping, Iterator)

addRoleToGroup

void addRoleToGroup(String group,
                    String role)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

AddRoleToGroupApiFunction.addRoleToGroup(RightsGroupId, SecurityRoleId)

addTriplesBatched

void addTriplesBatched(int batchSize,
                       String graphUri,
                       org.apache.jena.shared.PrefixMapping prefixMapping,
                       Iterator<org.apache.jena.graph.Triple> triples)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

addTriplesBatched(int, Uri, PrefixMapping, Iterator)

addTriplesBatched

void addTriplesBatched(int batchSize,
                       Uri graphUri,
                       org.apache.jena.shared.PrefixMapping prefixMapping,
                       Iterator<org.apache.jena.graph.Triple> triples)

Convenience method to add triples in batches from an iterator. Delegates to addTriples.

canDeleteProject

boolean canDeleteProject(String projectGraph)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

CanDeleteProjectApiFunction.canDeleteProject(ProjectGraphUri)

checkGovernanceAreaExists

boolean checkGovernanceAreaExists(String uri)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

CheckGovernanceAreaExistsApiFunction.checkGovernanceAreaExists(GovernanceAreaUri)

checkProjectExists

boolean checkProjectExists(String projectGraph)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

CheckProjectExistsApiFunction.checkProjectExists(ProjectGraphUri)

clearProject

void clearProject(String projectGraph)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

ClearProjectApiFunction.clearProject(ProjectGraphUri)

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

configuration

ClientConfiguration configuration()

Get the client's configuration.

create

static Client create()

Factory method for implementations. May return different concrete types depending on the configuration.

create

static Client create(ClientConfiguration clientConfiguration)

Factory method for implementations. May return different concrete types depending on the configuration.

createGovernanceArea

void createGovernanceArea(String label,
                          String type,
                          String uri,
                          String labelLang)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

CreateGovernanceAreaApiFunction.createGovernanceArea(String, GovernanceAreaType, GovernanceAreaUri, Optional)

deleteProject

void deleteProject(String projectGraph)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

DeleteProjectApiFunction.deleteProject(ProjectGraphUri)

deleteResource

void deleteResource(String base,
                    String resource)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

DeleteResourceApiFunction.deleteResource(Uri, Uri)

enableGovernanceRole

void enableGovernanceRole(String governanceRole,
                          String subjectArea)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

EnableGovernanceRoleApiFunction.enableGovernanceRole(GovernanceRoleUri, GovernanceAreaUri)

getRawGraphqlConnection

RawGraphqlConnection getRawGraphqlConnection(ProjectGraphUri projectGraphUri)

Convenience method to get a raw GraphQL connection for a project.

getRawGraphqlConnection

RawGraphqlConnection getRawGraphqlConnection(ProjectGraphUri projectGraphUri,
                                             Optional<ProjectGraphqlSchemaType> projectGraphqlSchemaType)

Convenience method to get a raw GraphQL connection for a project.

setGovernanceRolePermission

void setGovernanceRolePermission(String governanceArea,
                                 String governancePermission,
                                 String governanceRole)

Convenience method that only uses built-in and Jena types, to make the client easier to use from languages besides Java.

See Also:

SetGovernanceAreaPermission.setGovernanceRolePermission(GovernanceAreaUri, GovernancePermission, GovernanceRoleUri)