Class RestRepositoryClient

Provides a REST client used to access Colectica Repository.

Inheritance
Object
RepositoryClientBase
RestRepositoryClient
Implements
Inherited Members
Namespace: Algenta.Colectica.Repository.Client
Assembly: Algenta.Colectica.Repository.Client.dll
Syntax
public class RestRepositoryClient : RepositoryClientBase, IDisposable
Examples

// The RestRepositoryClient takes a configation object // detailing how to connect to the Repository. var connectionInfo = new RepositoryConnectionInfo() { // TODO Replace this with the hostname of your Colectica Repository Url = "localhost", AuthenticationMethod = RepositoryAuthenticationMethod.Windows, TransportMethod = RepositoryTransportMethod.REST, };

// Create the client object, passing in the connection information. var client = new RestRepositoryClient(connectionInfo); var info = client.GetRepositoryInfo();

Constructors

RestRepositoryClient(RepositoryConnectionInfo)

Initializes a new instance of the RestRepositoryClient class.

Declaration
public RestRepositoryClient(RepositoryConnectionInfo connectionInfo)
Parameters
Type Name Description
RepositoryConnectionInfo connectionInfo

The connection information.
Exceptions
Type Condition
ArgumentNullException

connectionInfo

Properties

ClientType

Declaration
public override ClientType ClientType { get; }
Property Value
Type Description
ClientType
Overrides

Name

Declaration
public override string Name { get; }
Property Value
Type Description
String
Overrides

Methods

AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest)

Declaration
public override Task<RepositoryTransaction> AddItemsToTransactionAsync(RepositoryTransactionAddItemsRequest request)
Parameters
Type Name Description
RepositoryTransactionAddItemsRequest request
Returns
Type Description
Task<RepositoryTransaction>
Overrides

AddPermissions(RepositorySecurityContext)

Declaration
public override void AddPermissions(RepositorySecurityContext context)
Parameters
Type Name Description
RepositorySecurityContext context
Overrides

CancelTransactionAsync(RepositoryTransactionCancelOptions)

Declaration
public override Task<RepositoryTransaction> CancelTransactionAsync(RepositoryTransactionCancelOptions options)
Parameters
Type Name Description
RepositoryTransactionCancelOptions options
Returns
Type Description
Task<RepositoryTransaction>
Overrides

CommitTransactionAsync(RepositoryTransactionCommitOptions)

Declaration
public override Task<RepositoryTransactionResult> CommitTransactionAsync(RepositoryTransactionCommitOptions options)
Parameters
Type Name Description
RepositoryTransactionCommitOptions options
Returns
Type Description
Task<RepositoryTransactionResult>
Overrides

CreateComment(Guid, String, Int64, String)

Declaration
public override void CreateComment(Guid identifier, string agency, long version, string comment)
Parameters
Type Name Description
Guid identifier
String agency
Int64 version
String comment
Overrides

CreateRepository(String, String)

Declaration
public override void CreateRepository(string agency, string name)
Parameters
Type Name Description
String agency
String name
Overrides

CreateTag(Guid, String, Int64, String)

Declaration
public override void CreateTag(Guid id, string agency, long version, string name)
Parameters
Type Name Description
Guid id
String agency
Int64 version
String name
Overrides

CreateTransactionAsync()

Declaration
public override Task<RepositoryTransaction> CreateTransactionAsync()
Returns
Type Description
Task<RepositoryTransaction>
Overrides

DeprecateAllItemVersions(Guid, String)

Declaration
public override void DeprecateAllItemVersions(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Overrides

DeprecateItem(Guid, String, Int64)

Declaration
public override void DeprecateItem(Guid id, string agency, long version)
Parameters
Type Name Description
Guid id
String agency
Int64 version
Overrides

GetComments(Guid, String)

Declaration
public override Collection<UserComment> GetComments(Guid identifier, string agency)
Parameters
Type Name Description
Guid identifier
String agency
Returns
Type Description
Collection<UserComment>
Overrides

GetCommentsCollection(Collection<IdentifierTriple>)

Declaration
public override Collection<UserComment> GetCommentsCollection(Collection<IdentifierTriple> ids)
Parameters
Type Name Description
Collection<IdentifierTriple> ids
Returns
Type Description
Collection<UserComment>
Overrides

GetItemsInTransactionAsync(Int64)

Declaration
public override Task<Collection<RepositoryItem>> GetItemsInTransactionAsync(long transactionId)
Parameters
Type Name Description
Int64 transactionId
Returns
Type Description
Task<Collection<RepositoryItem>>
Overrides

GetLatestRepositoryItem(Guid, String)

Declaration
public override RepositoryItem GetLatestRepositoryItem(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Returns
Type Description
RepositoryItem
Overrides

GetLatestRepositoryItems(Collection<IdentifierTriple>)

Declaration
public override Collection<RepositoryItem> GetLatestRepositoryItems(Collection<IdentifierTriple> identifiers)
Parameters
Type Name Description
Collection<IdentifierTriple> identifiers
Returns
Type Description
Collection<RepositoryItem>
Overrides

GetLatestSet(IdentifierTriple)

Declaration
public override Collection<IdentifierTriple> GetLatestSet(IdentifierTriple rootItem)
Parameters
Type Name Description
IdentifierTriple rootItem
Returns
Type Description
Collection<IdentifierTriple>
Overrides

GetLatestVersionNumber(Guid, String)

Declaration
public override long GetLatestVersionNumber(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Returns
Type Description
Int64
Overrides

GetLatestVersionNumberOfTag(Guid, String, String)

Declaration
public override long GetLatestVersionNumberOfTag(Guid id, string agency, string tag)
Parameters
Type Name Description
Guid id
String agency
String tag
Returns
Type Description
Int64
Overrides

GetLatestVersionNumbers(Collection<IdentifierTriple>)

Declaration
public override Collection<IdentifierTriple> GetLatestVersionNumbers(Collection<IdentifierTriple> identifiers)
Parameters
Type Name Description
Collection<IdentifierTriple> identifiers
Returns
Type Description
Collection<IdentifierTriple>
Overrides

GetPermissions(Collection<IdentifierTriple>, Collection<Guid>)

Declaration
public override RepositorySecurityContext GetPermissions(Collection<IdentifierTriple> identifiers, Collection<Guid> itemTypes)
Parameters
Type Name Description
Collection<IdentifierTriple> identifiers
Collection<Guid> itemTypes
Returns
Type Description
RepositorySecurityContext
Overrides

GetRelationshipByObject(GraphSearchFacet)

Declaration
public override Collection<TypedIdTriple> GetRelationshipByObject(GraphSearchFacet facet)
Parameters
Type Name Description
GraphSearchFacet facet
Returns
Type Description
Collection<TypedIdTriple>
Overrides

GetRelationshipBySubject(GraphSearchFacet)

Declaration
public override Collection<TypedIdTriple> GetRelationshipBySubject(GraphSearchFacet facet)
Parameters
Type Name Description
GraphSearchFacet facet
Returns
Type Description
Collection<TypedIdTriple>
Overrides

GetRelationships(Collection<IdentifierTriple>, RelationshipFacet)

Declaration
public override AdjacencyMatrix GetRelationships(Collection<IdentifierTriple> rootItems, RelationshipFacet facet)
Parameters
Type Name Description
Collection<IdentifierTriple> rootItems
RelationshipFacet facet
Returns
Type Description
AdjacencyMatrix
Overrides

GetRepositoryInfo()

Declaration
public override RepositoryInfo GetRepositoryInfo()
Returns
Type Description
RepositoryInfo
Overrides

GetRepositoryItem(Guid, String, Int64)

Declaration
public override RepositoryItem GetRepositoryItem(Guid id, string agency, long version)
Parameters
Type Name Description
Guid id
String agency
Int64 version
Returns
Type Description
RepositoryItem
Overrides

GetRepositoryItemDescription(Guid, String, Int64)

Declaration
public override RepositoryItemMetadata GetRepositoryItemDescription(Guid id, string agency, long version)
Parameters
Type Name Description
Guid id
String agency
Int64 version
Returns
Type Description
RepositoryItemMetadata
Overrides

GetRepositoryItemDescriptions(Collection<IdentifierTriple>)

Declaration
public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptions(Collection<IdentifierTriple> identifiers)
Parameters
Type Name Description
Collection<IdentifierTriple> identifiers
Returns
Type Description
Collection<RepositoryItemMetadata>
Overrides

GetRepositoryItemDescriptionsByObject(GraphSearchFacet)

Declaration
public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptionsByObject(GraphSearchFacet facet)
Parameters
Type Name Description
GraphSearchFacet facet
Returns
Type Description
Collection<RepositoryItemMetadata>
Overrides

GetRepositoryItemDescriptionsBySubject(GraphSearchFacet)

Declaration
public override Collection<RepositoryItemMetadata> GetRepositoryItemDescriptionsBySubject(GraphSearchFacet facet)
Parameters
Type Name Description
GraphSearchFacet facet
Returns
Type Description
Collection<RepositoryItemMetadata>
Overrides

GetRepositoryItems(Collection<IdentifierTriple>)

Declaration
public override Collection<RepositoryItem> GetRepositoryItems(Collection<IdentifierTriple> identifiers)
Parameters
Type Name Description
Collection<IdentifierTriple> identifiers
Returns
Type Description
Collection<RepositoryItem>
Overrides

GetRepositorySetting(String)

Declaration
public override RepositorySetting GetRepositorySetting(string settingName)
Parameters
Type Name Description
String settingName
Returns
Type Description
RepositorySetting
Overrides

GetRepositorySettings()

Declaration
public override Collection<RepositorySetting> GetRepositorySettings()
Returns
Type Description
Collection<RepositorySetting>
Overrides

GetSet(IdentifierTriple)

Declaration
public override Collection<IdentifierTriple> GetSet(IdentifierTriple rootItem)
Parameters
Type Name Description
IdentifierTriple rootItem
Returns
Type Description
Collection<IdentifierTriple>
Overrides

GetTags(Guid, String, Int64)

Declaration
public override Collection<string> GetTags(Guid id, string agency, long version)
Parameters
Type Name Description
Guid id
String agency
Int64 version
Returns
Type Description
Collection<String>
Overrides

GetTransactionsAsync(Collection<Int64>)

Declaration
public override Task<Collection<RepositoryTransaction>> GetTransactionsAsync(Collection<long> transactionIds)
Parameters
Type Name Description
Collection<Int64> transactionIds
Returns
Type Description
Task<Collection<RepositoryTransaction>>
Overrides

GetTypedRelationships(Collection<IdentifierTriple>, RelationshipFacet)

Declaration
public override TypedAdjacencyMatrix GetTypedRelationships(Collection<IdentifierTriple> rootItems, RelationshipFacet facet)
Parameters
Type Name Description
Collection<IdentifierTriple> rootItems
RelationshipFacet facet
Returns
Type Description
TypedAdjacencyMatrix
Overrides

GetVersionHistory(Guid, String)

Declaration
public override Collection<RepositoryItemMetadata> GetVersionHistory(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Returns
Type Description
Collection<RepositoryItemMetadata>
Overrides

GetVersions(Guid, String)

Declaration
public override Collection<IdentifierTriple> GetVersions(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Returns
Type Description
Collection<IdentifierTriple>
Overrides

ListTransactionsAsync(RepositoryTransactionListOptions)

Declaration
public override Task<Collection<RepositoryTransaction>> ListTransactionsAsync(RepositoryTransactionListOptions options)
Parameters
Type Name Description
RepositoryTransactionListOptions options
Returns
Type Description
Task<Collection<RepositoryTransaction>>
Overrides

LogEvent(LoggedEvent)

Declaration
public override void LogEvent(LoggedEvent loggedEvent)
Parameters
Type Name Description
LoggedEvent loggedEvent
Overrides

PrepareRequest(HttpClient, HttpRequestMessage, String)

Declaration
public Task PrepareRequest(HttpClient client, HttpRequestMessage request, string url)
Parameters
Type Name Description
HttpClient client
HttpRequestMessage request
String url
Returns
Type Description
Task

RegisterItem(RepositoryItem, CommitOptions)

Declaration
public override void RegisterItem(RepositoryItem item, CommitOptions options)
Parameters
Type Name Description
RepositoryItem item
CommitOptions options
Overrides

RegisterItems(Collection<RepositoryItem>, CommitOptions)

Declaration
public override Collection<RepositoryConflict> RegisterItems(Collection<RepositoryItem> items, CommitOptions options)
Parameters
Type Name Description
Collection<RepositoryItem> items
CommitOptions options
Returns
Type Description
Collection<RepositoryConflict>
Overrides

RemovePermissions(Collection<Int64>)

Declaration
public override void RemovePermissions(Collection<long> permissionIds)
Parameters
Type Name Description
Collection<Int64> permissionIds
Overrides

RemoveRepository(String)

Declaration
public override void RemoveRepository(string agency)
Parameters
Type Name Description
String agency
Overrides

RemoveRepositorySetting(String)

Declaration
public override void RemoveRepositorySetting(string settingName)
Parameters
Type Name Description
String settingName
Overrides

RemoveTag(Guid, String, Int64, String)

Declaration
public override void RemoveTag(Guid id, string agency, long version, string name)
Parameters
Type Name Description
Guid id
String agency
Int64 version
String name
Overrides

RestoreAllItemVersions(Guid, String)

Declaration
public override void RestoreAllItemVersions(Guid id, string agency)
Parameters
Type Name Description
Guid id
String agency
Overrides

RestoreItem(Guid, String, Int64)

Declaration
public override void RestoreItem(Guid id, string agency, long version)
Parameters
Type Name Description
Guid id
String agency
Int64 version
Overrides

Search(SearchFacet)

Declaration
public override SearchResponse Search(SearchFacet facet)
Parameters
Type Name Description
SearchFacet facet
Returns
Type Description
SearchResponse
Overrides

SearchTypedSet(IdentifierTriple, SetSearchFacet)

Declaration
public override Collection<TypedIdTriple> SearchTypedSet(IdentifierTriple rootItem, SetSearchFacet facet)
Parameters
Type Name Description
IdentifierTriple rootItem
SetSearchFacet facet
Returns
Type Description
Collection<TypedIdTriple>
Overrides

SetRepositorySetting(RepositorySetting)

Declaration
public override void SetRepositorySetting(RepositorySetting setting)
Parameters
Type Name Description
RepositorySetting setting
Overrides

UpdateDeprecatedState(Collection<IdentifierTriple>, Boolean, Boolean)

Declaration
public override void UpdateDeprecatedState(Collection<IdentifierTriple> ids, bool deprecatedState, bool applyToAllVersions)
Parameters
Type Name Description
Collection<IdentifierTriple> ids
Boolean deprecatedState
Boolean applyToAllVersions
Overrides

Implements