Cloud Connector API  version 3.5.1001.64485
API for managing and configuring the Cloud Connector
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. More...
 
IDirSyncConfiguration GetConfiguration ()
 Retrieves the configuration for the organization. More...
 
void SetConfiguration (IDirSyncConfiguration configuration)
 Updates the configuration for the organization. More...
 
IDryRunManager CreateDryRunManager (ISyncDomain syncDomain)
 Creates a IDryRunManager to allow for testing the provided ISyncDomain in synchronizing directory information on-premise to the cloud. More...
 
IList< ISyncDomainGetDomains ()
 Receive the domain names existing in cloud More...
 
void Bind (ISyncDomain domain, bool newBinding)
 Bind domain for the connector More...
 
void SetDomainPriority (ISyncDomain[] domains)
 Set domain priority for multiple domain case More...
 
ISyncControl GetSyncControl ()
 Get specific sync control flag More...
 
void SetSyncControl (ISyncControl syncControl)
 Set specific sync control flag More...
 
IAttrExprVerificationResult VerifyAttrExpr (string expression)
 Verify the attribute expression More...
 
IAttrExprSampleResult SamplingAttrExpr (string expression, IDictionary< string, string > props)
 Get the expression sample result More...
 
IAttributeExprMetaData GetAttrExprMeta ()
 Get the attribute expression opeartor and function detail information More...
 
void SetInfoLogsToCloud (HashSet< string > logMsgs)
 Send logs to cloud More...
 
- Public Member Functions inherited from IServiceContext
void SendServiceCommand (Command command)
 Sends a command to the connector service. More...
 
void SetServiceMode (Mode mode)
 Set (change) the service mode. This allows you to enable, disable or pause the connector service. More...
 
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. More...
 
bool IsConnectorRegistered ()
 Test to see if the connector is registered or not. More...
 
void UnregisterConnector ()
 Un-register a Cloud Connector for the service type from this computer. More...
 
void UnregisterConnector (byte[] connectorGuid)
 Un-register a Cloud Connector for the service type from a different computer. More...
 
void ResetConnectorSecret ()
 Manually reset the userid/secret used by the Cloud Connector Windows service. More...
 
IServiceInformation GetServiceInformation ()
 Retrieves the service information for the organization. More...
 
void SaveConnectorServiceUri (string uri)
 Save connector service uri. More...
 

Detailed Description

Context for sending DirSync specific actions to the connector service.

Member Function Documentation

void Bind ( ISyncDomain  domain,
bool  newBinding 
)

Bind domain for the connector

Parameters
domainsync domain<
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionSet configuration failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
NoSuchDomainExceptionDomain does not exist in cloud
ExceptionOther exceptions may also be thrown by the platform and operating system
IDryRunManager CreateDryRunManager ( ISyncDomain  syncDomain)

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

Parameters
syncDomainISyncDomain to try the dry run.
Returns
IAttributeExprMetaData GetAttrExprMeta ( )

Get the attribute expression opeartor and function detail information

Returns
IDirSyncConfiguration GetConfiguration ( )

Retrieves the configuration for the organization.

Returns
A IDirSyncConfiguration interface
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionGet configuration failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
IList<ISyncDomain> GetDomains ( )

Receive the domain names existing in cloud

Returns
domain name list
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionSet configuration failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
ISyncControl GetSyncControl ( )

Get specific sync control flag

Returns
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

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

Get the expression sample result

Parameters
expression
props
Returns
void SetConfiguration ( IDirSyncConfiguration  configuration)

Updates the configuration for the organization.

Parameters
configurationConfiguration to set (previously retrieved using GetConfiguration)
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionSet configuration failed
NoSuchOrganizationExceptionThe organization does not exist
SessionExpiredExceptionThe session to the Connector Service has expired
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
void SetDomainPriority ( ISyncDomain[]  domains)

Set domain priority for multiple domain case

Parameters
domains
void SetInfoLogsToCloud ( HashSet< string >  logMsgs)

Send logs to cloud

Parameters
logMsgs
void SetSyncControl ( ISyncControl  syncControl)

Set specific sync control flag

Parameters
syncControl
IAttrExprVerificationResult VerifyAttrExpr ( string  expression)

Verify the attribute expression

Parameters
expression
Returns

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