Class EndpointService

Namespace

Dynamicweb.DataIntegration.EndpointManagement

Assembly

Dynamicweb.DataIntegration.dll

Service for endpoints.

public class EndpointService : ICacheStorage<int, Endpoint>, ICacheStorage<int>, ICacheStorage

Inheritance

object

EndpointService

Implements

ICacheStorage<int, Endpoint>

ICacheStorage<int>

ICacheStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EndpointService()

Initializes a new instance of the EndpointService class.

public EndpointService()

Properties

EmptyRequest

public string EmptyRequest { get; }

Property Value

string

Info

Information about the object cache

public CacheInformation Info { get; }

Property Value

CacheInformation

SoapHeaderKey

protected string SoapHeaderKey { get; }

Property Value

string

Methods

AddContentTypeHeader(Endpoint)

Adds Content-Type header value

public void AddContentTypeHeader(Endpoint endpoint)

Parameters

endpoint Endpoint

Endpoint

AddDynamicwebServiceSoapHeader(Endpoint)

Adds SoapAction header with DynamicwebServiceSoapAction

public void AddDynamicwebServiceSoapHeader(Endpoint endpoint)

Parameters

endpoint Endpoint

Endpoint

ClearCache()

Resets all keys to the default value for objects stored in the object cache

public void ClearCache()

ClearCache(IEnumerable<int>)

Resets the specified keys to the default value for objects stored in the object cache

public void ClearCache(IEnumerable<int> keys)

Parameters

keys IEnumerable<int>

Keys to reset

ClearCache(int)

Resets the specified key to the default value for objects stored in the object cache

public void ClearCache(int key)

Parameters

key int

Key to reset

Copy(Endpoint)

public Endpoint Copy(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

Endpoint

DeleteEndpoint(int)

Deletes the Endpoint.

public virtual void DeleteEndpoint(int id)

Parameters

id int

The identifier.

Execute(Endpoint)

public string Execute(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

string

Execute(Endpoint, string)

Executes request from Endpoint

public string Execute(Endpoint endpoint, string requestBody = null)

Parameters

endpoint Endpoint

Endpoint

requestBody string

Request body

Returns

string

Response string

Execute(Endpoint, TimeSpan)

Executes request from Endpoint

public string Execute(Endpoint endpoint, TimeSpan requestTimeout)

Parameters

endpoint Endpoint

requestTimeout TimeSpan

Returns

string

Response string

Execute(Endpoint, TimeSpan, string)

Executes request from Endpoint

public string Execute(Endpoint endpoint, TimeSpan requestTimeout, string requestBody = null)

Parameters

endpoint Endpoint

Endpoint

requestTimeout TimeSpan

requestBody string

Request body

Returns

string

Response string

Execute(int)

Executes request from Endpoint

public string Execute(int endpointId)

Parameters

endpointId int

Endpoint id

Returns

string

Response string

Execute(int, string)

Executes request from Endpoint

public string Execute(int endpointId, string requestBody)

Parameters

endpointId int

Endpoint id

requestBody string

Request body

Returns

string

Response string

Execute(int, string, TimeSpan)

Executes request from Endpoint

public string Execute(int endpointId, string requestBody, TimeSpan requestTimeout)

Parameters

endpointId int

Endpoint id

requestBody string

Request body

requestTimeout TimeSpan

Returns

string

Response string

ExtractContentFromSoapXml(string, string, string)

protected string ExtractContentFromSoapXml(string response, string methodName, string methodNamespace)

Parameters

response string

methodName string

methodNamespace string

Returns

string

GetDefaultDynamicwebServiceHeaders(Endpoint)

public Dictionary<string, string> GetDefaultDynamicwebServiceHeaders(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

Dictionary<string, string>

GetDynamicwebServiceEndpointInfo(Endpoint)

public DynamicwebServiceEndpointInfo GetDynamicwebServiceEndpointInfo(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

DynamicwebServiceEndpointInfo

GetDynamicwebServiceEndpointType(Endpoint)

public DynamicwebServiceEndpointType GetDynamicwebServiceEndpointType(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

DynamicwebServiceEndpointType

GetDynamicwebServiceRequest(Endpoint)

public string GetDynamicwebServiceRequest(Endpoint endpoint)

Parameters

endpoint Endpoint

Returns

string

GetDynamicwebServiceSoapBody(Endpoint, string)

public string GetDynamicwebServiceSoapBody(Endpoint endpoint, string request)

Parameters

endpoint Endpoint

request string

Returns

string

GetEndpointById(int)

Gets an Endpoint by id.

public virtual Endpoint GetEndpointById(int id)

Parameters

id int

The identifier.

Returns

Endpoint

An instance of Endpoint, if found, otherwise null.

GetEndpoints()

Gets the endpoints.

public virtual IEnumerable<Endpoint> GetEndpoints()

Returns

IEnumerable<Endpoint>

A collection of endpoints.

GetEndpointsByIDs(IEnumerable<int>)

Gets Endpoints by ids.

public virtual IEnumerable<Endpoint> GetEndpointsByIDs(IEnumerable<int> ids)

Parameters

ids IEnumerable<int>

The identifiers.

Returns

IEnumerable<Endpoint>

An enumeration of Endpoint.

GetNewCopyEndpointName(string, string, int)

public string GetNewCopyEndpointName(string currentName, string prefix = "(Copy)", int index = 0)

Parameters

currentName string

prefix string

index int

Returns

string

GetSoapHeaderKey(string[])

protected string GetSoapHeaderKey(string[] headerKeys)

Parameters

headerKeys string[]

Returns

string

IsDynamicwebServiceEndpoint(Endpoint)

Checks if endpoint is Dynamicweb webservice

public bool IsDynamicwebServiceEndpoint(Endpoint endpoint)

Parameters

endpoint Endpoint

Endpoint

Returns

bool

True if endpoint is Dynamicweb webservice, otherwise false

IsEmptyRequestDynamicwebServiceEndpoint(Endpoint, string)

Checks if the endpoint is for the Live integration.

public bool IsEmptyRequestDynamicwebServiceEndpoint(Endpoint endpoint, string EmptyRequest)

Parameters

endpoint Endpoint

EmptyRequest string

Returns

bool

MakeDynamicwebServiceEndpoint(Endpoint, string)

public void MakeDynamicwebServiceEndpoint(Endpoint endpoint, string request)

Parameters

endpoint Endpoint

request string

MakeNotDynamicwebServiceEndpoint(Endpoint)

public void MakeNotDynamicwebServiceEndpoint(Endpoint endpoint)

Parameters

endpoint Endpoint

RemoveContentTypeHeader(Endpoint)

public static void RemoveContentTypeHeader(Endpoint endpoint)

Parameters

endpoint Endpoint

RemoveDynamicwebServiceSoapHeader(Endpoint)

Removes SoapAction header

public void RemoveDynamicwebServiceSoapHeader(Endpoint endpoint)

Parameters

endpoint Endpoint

SaveEndpoint(Endpoint)

Saves the Endpoint.

public virtual void SaveEndpoint(Endpoint endpoint)

Parameters

endpoint Endpoint

The Endpoint.

SaveEndpoints(IList<Endpoint>)

Saves the Endpoints.

public virtual void SaveEndpoints(IList<Endpoint> endpoints)

Parameters

endpoints IList<Endpoint>

The Endpoints.