Class BaseStardogServer

Abstract implementation of a management connection to a Stardog server using the HTTP protocol.
Inheritance
System.Object
BaseHttpConnector
BaseStardogServer
StardogV1Server
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: VDS.RDF.Storage.Management
Assembly: dotNetRDF.dll
Syntax
public abstract class BaseStardogServer : BaseHttpConnector, IAsyncStorageServer, IConfigurationSerializable, IStorageServer, IDisposable

Constructors

| Improve this Doc View Source

BaseStardogServer(String)

Creates a new connection to a Stardog Server.
Declaration
public BaseStardogServer(string baseUri)
Parameters
Type Name Description
System.String baseUri Base Uri of the Server.
| Improve this Doc View Source

BaseStardogServer(String, IWebProxy)

Creates a new connection to a Stardog Server.
Declaration
public BaseStardogServer(string baseUri, IWebProxy proxy)
Parameters
Type Name Description
System.String baseUri Base Uri of the Server.
System.Net.IWebProxy proxy Proxy Server.
| Improve this Doc View Source

BaseStardogServer(String, String, String)

Creates a new connection to a Stardog Server.
Declaration
public BaseStardogServer(string baseUri, string username, string password)
Parameters
Type Name Description
System.String baseUri Base Uri of the Server.
System.String username Username.
System.String password Password.
| Improve this Doc View Source

BaseStardogServer(String, String, String, IWebProxy)

Creates a new connection to a Stardog Server.
Declaration
public BaseStardogServer(string baseUri, string username, string password, IWebProxy proxy)
Parameters
Type Name Description
System.String baseUri Base Uri of the Server.
System.String username Username.
System.String password Password.
System.Net.IWebProxy proxy Proxy Server.

Fields

| Improve this Doc View Source

AdminUri

The URI of the admin API.
Declaration
protected readonly string AdminUri
Field Value
Type Description
System.String
| Improve this Doc View Source

BaseUri

The base URI of the Stardog server.
Declaration
protected readonly string BaseUri
Field Value
Type Description
System.String
| Improve this Doc View Source

HasCredentials

True if a user name and password are specified, false otherwise.
Declaration
protected readonly bool HasCredentials
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Password

The password to use for the connection.
Declaration
protected readonly string Password
Field Value
Type Description
System.String
| Improve this Doc View Source

Username

The username to use for the connection.
Declaration
protected readonly string Username
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

IOBehaviour

Gets the IO Behaviour of the server.
Declaration
public virtual IOBehaviour IOBehaviour { get; }
Property Value
Type Description
IOBehaviour

Methods

| Improve this Doc View Source

CreateAdminRequest(String, String, String, Dictionary<String, String>)

Create a request to the Stardog server's Admin API.
Declaration
protected virtual HttpWebRequest CreateAdminRequest(string servicePath, string accept, string method, Dictionary<string, string> requestParams)
Parameters
Type Name Description
System.String servicePath The admin API service path.
System.String accept Accept header content.
System.String method HTTP method to use.
System.Collections.Generic.Dictionary<System.String, System.String> requestParams Additional request parameters.
Returns
Type Description
System.Net.HttpWebRequest
| Improve this Doc View Source

CreateStore(IStoreTemplate)

Creates a new Store based off the given template.
Declaration
public virtual bool CreateStore(IStoreTemplate template)
Parameters
Type Name Description
IStoreTemplate template Template.
Returns
Type Description
System.Boolean
Remarks

Templates must inherit from BaseStardogTemplate.

Uses some code based off on answers here to help do the multipart form data request.

| Improve this Doc View Source

CreateStore(IStoreTemplate, AsyncStorageCallback, Object)

Creates a new store based on the given template.
Declaration
public virtual void CreateStore(IStoreTemplate template, AsyncStorageCallback callback, object state)
Parameters
Type Name Description
IStoreTemplate template Template.
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
Remarks

Template must inherit from BaseStardogTemplate.

| Improve this Doc View Source

DeleteStore(String)

Deletes a Store with the given ID.
Declaration
public virtual void DeleteStore(string storeID)
Parameters
Type Name Description
System.String storeID Store ID.
| Improve this Doc View Source

DeleteStore(String, AsyncStorageCallback, Object)

Deletes a database from the server.
Declaration
public virtual void DeleteStore(string storeID, AsyncStorageCallback callback, object state)
Parameters
Type Name Description
System.String storeID Store ID.
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
| Improve this Doc View Source

Dispose()

Disposes of the server.
Declaration
public virtual void Dispose()
| Improve this Doc View Source

GetAvailableTemplates(String)

Gets all available templates for creating a new Store.
Declaration
public virtual IEnumerable<IStoreTemplate> GetAvailableTemplates(string id)
Parameters
Type Name Description
System.String id Store ID.
Returns
Type Description
System.Collections.Generic.IEnumerable<IStoreTemplate>
| Improve this Doc View Source

GetAvailableTemplates(String, AsyncStorageCallback, Object)

Gets all available templates for creating a new Store.
Declaration
public virtual void GetAvailableTemplates(string id, AsyncStorageCallback callback, object state)
Parameters
Type Name Description
System.String id Store ID.
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
| Improve this Doc View Source

GetDefaultTemplate(String)

Gets a default template for creating a new Store.
Declaration
public virtual IStoreTemplate GetDefaultTemplate(string id)
Parameters
Type Name Description
System.String id Store ID.
Returns
Type Description
IStoreTemplate
| Improve this Doc View Source

GetDefaultTemplate(String, AsyncStorageCallback, Object)

Gets a default template for creating a new Store.
Declaration
public virtual void GetDefaultTemplate(string id, AsyncStorageCallback callback, object state)
Parameters
Type Name Description
System.String id Store ID.
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
| Improve this Doc View Source

GetStore(String)

Gets a provider for the Store with the given ID.
Declaration
public abstract IStorageProvider GetStore(string storeID)
Parameters
Type Name Description
System.String storeID Store ID.
Returns
Type Description
IStorageProvider
| Improve this Doc View Source

GetStore(String, AsyncStorageCallback, Object)

Gets a database from the server.
Declaration
public abstract void GetStore(string storeID, AsyncStorageCallback callback, object state)
Parameters
Type Name Description
System.String storeID Store ID.
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
| Improve this Doc View Source

ListStores()

Lists the database available on the server.
Declaration
public virtual IEnumerable<string> ListStores()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>
| Improve this Doc View Source

ListStores(AsyncStorageCallback, Object)

Lists all databases available on the server.
Declaration
public virtual void ListStores(AsyncStorageCallback callback, object state)
Parameters
Type Name Description
AsyncStorageCallback callback Callback.
System.Object state State to pass to the callback.
| Improve this Doc View Source

SerializeConfiguration(ConfigurationSerializationContext)

Serializes the connection's configuration.
Declaration
public virtual void SerializeConfiguration(ConfigurationSerializationContext context)
Parameters
Type Name Description
ConfigurationSerializationContext context Configuration Serialization Context.

Implements

System.IDisposable

Extension Methods