IDirSyncContext Interface Reference

Context for sending DirSync specific actions to the connector service. More...

Inheritance diagram for IDirSyncContext:

Public Member Functions
void	OverrideDeleteThreshold ()
	Sends a command to to indicate that the next synchronization should override the delete threshold if it has been reached.
IDirSyncConfiguration	GetConfiguration ()
	Retrieves the configuration for the organization.
void	SetConfiguration (IDirSyncConfiguration configuration)
	Updates the configuration for the organization.
IDryRunManager	CreateDryRunManager (ISyncDomain syncDomain)
	Creates a IDryRunManager to allow for testing the provided ISyncDomain in synchronizing directory information on-premise to the cloud.
IList< ISyncDomain >	GetDomains ()
	Receive the domain names existing in cloud.
void	Bind (ISyncDomain domain, bool newBinding)
	Bind domain for the connector.
void	SetDomainPriority (ISyncDomain[] domains)
	Set domain priority for multiple domain case.
ISyncControl	GetSyncControl ()
	Get specific sync control flag.
void	SetSyncControl (ISyncControl syncControl)
	Set specific sync control flag.
IAttrExprVerificationResult	VerifyAttrExpr (string expression)
	Verify the attribute expression.
IAttrExprSampleResult	SamplingAttrExpr (string expression, IDictionary< string, string > props)
	Get the expression sample result.
IAttributeExprMetaData	GetAttrExprMeta ()
	Get the attribute expression opeartor and function detail information.
void	SetInfoLogsToCloud (HashSet< string > logMsgs)
	Send logs to cloud.
void	SetSyncDeleteObjects (List< string > objects, bool isAppend=false)
string[]	GetDeletableAttributes ()
	Get Deletable Attributes.
Public Member Functions inherited from IServiceContext
void	SendServiceCommand (Command command, CustomizeSyncCommandOptions options=null)
	Sends a command to the connector service.
void	SetServiceMode (Mode mode)
	Set (change) the service mode. This allows you to enable, disable or pause the connector service.
void	RegisterConnector (ISyncDomain boundDomain)
	Register a Cloud Connector for the service type on this computer. This will "bind" the Connector to the current organization if it isn't already bound. The connector cannot be bound to a different organization.
bool	IsConnectorRegistered ()
	Test to see if the connector is registered or not.
void	UnregisterConnector ()
	Un-register a Cloud Connector for the service type from this computer.
void	UnregisterConnector (byte[] connectorGuid)
	Un-register a Cloud Connector for the service type from a different computer.
void	ResetConnectorSecret ()
	Manually reset the userid/secret used by the Cloud Connector Windows service.
IServiceInformation	GetServiceInformation ()
	Retrieves the service information for the organization.
void	SaveConnectorServiceUri (string uri)
	Save connector service uri.

Detailed Description

Context for sending DirSync specific actions to the connector service.

Member Function Documentation

Bind()

void Bind	(	ISyncDomain	domain,
		bool	newBinding )

Bind domain for the connector.

Parameters

domain

sync domain<

Exceptions

PermissionDeniedException	The user does not have enough permissions
ServiceFailureException	Set configuration failed
NoSuchOrganizationException	The organization does not exist
SessionExpiredException	The session to the Connector Service has expired

Exceptions

ServiceException	Unspecified service error
NoSuchDomainException	Domain does not exist in cloud
Exception	Other exceptions may also be thrown by the platform and operating system

CreateDryRunManager()

IDryRunManager CreateDryRunManager

(

ISyncDomain

syncDomain

)

Creates a IDryRunManager to allow for testing the provided ISyncDomain in synchronizing directory information on-premise to the cloud.

Parameters

syncDomain

ISyncDomain to try the dry run.

Returns

GetAttrExprMeta()

IAttributeExprMetaData GetAttrExprMeta

(

)

Get the attribute expression opeartor and function detail information.

Returns

GetConfiguration()

IDirSyncConfiguration GetConfiguration

(

)

Retrieves the configuration for the organization.

Returns

A IDirSyncConfiguration interface

Exceptions

PermissionDeniedException	The user does not have enough permissions
ServiceFailureException	Get configuration failed
NoSuchOrganizationException	The organization does not exist
SessionExpiredException	The session to the Connector Service has expired

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

GetDomains()

IList< ISyncDomain > GetDomains

(

)

Receive the domain names existing in cloud.

Returns

domain name list

Exceptions

PermissionDeniedException	The user does not have enough permissions
ServiceFailureException	Set configuration failed
NoSuchOrganizationException	The organization does not exist
SessionExpiredException	The session to the Connector Service has expired

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

GetSyncControl()

ISyncControl GetSyncControl

(

)

Get specific sync control flag.

Returns

OverrideDeleteThreshold()

void OverrideDeleteThreshold

(

)

Sends a command to to indicate that the next synchronization should override the delete threshold if it has been reached.

See IDirSyncConfiguration.DeleteThreshold See IDirSyncEventInformation

SamplingAttrExpr()

IAttrExprSampleResult SamplingAttrExpr	(	string	expression,
		IDictionary< string, string >	props )

Get the expression sample result.

Parameters

expression
props

Returns

SetConfiguration()

void SetConfiguration

(

IDirSyncConfiguration

configuration

)

Updates the configuration for the organization.

Parameters

configuration

Configuration to set (previously retrieved using GetConfiguration)

Exceptions

PermissionDeniedException	The user does not have enough permissions
ServiceFailureException	Set configuration failed
NoSuchOrganizationException	The organization does not exist
SessionExpiredException	The session to the Connector Service has expired

Exceptions

ServiceException	Unspecified service error
Exception	Other exceptions may also be thrown by the platform and operating system

SetDomainPriority()

void SetDomainPriority

(

ISyncDomain[]

domains

)

Set domain priority for multiple domain case.

Parameters

domains

SetInfoLogsToCloud()

void SetInfoLogsToCloud

(

HashSet< string >

logMsgs

)

Send logs to cloud.

Parameters

logMsgs

SetSyncControl()

void SetSyncControl

(

ISyncControl

syncControl

)

Set specific sync control flag.

Parameters

syncControl

SetSyncDeleteObjects()

void SetSyncDeleteObjects	(	List< string >	objects,
		bool	isAppend = false )

Set SyncDeleteObjects

Parameters

objects
isAppend

VerifyAttrExpr()

IAttrExprVerificationResult VerifyAttrExpr

(

string

expression

)

Verify the attribute expression.

Parameters

expression

Returns

---

The documentation for this interface was generated from the following file:

• IDirSyncContext.cs