IAdmNamespace

The IAdmNamespace interface is designed for locating and connecting to Adaxes services, and for binding to directory objects via a certain Adaxes service.

Inheritance: IUnknown

For details on how to use the IAdmNamespace interface, see Connecting to Adaxes service.

Methods

  • Method

  • Description

  • GetNearestService()

  • Returns the IAdmService interface that represents the nearest Adaxes service.

  • GetServicesForDomain()

  • Returns the IAdmServices interface that represents a collection of Adaxes services available in the domain specified.

  • GetService()

  • Returns the IAdmService interface that represents the Adaxes service installed on the specified host. The method doesn't throw an exception if the Adaxes service is not available.

  • GetServiceDirectly()

  • Returns the IAdmService interface that represents the Adaxes service installed on the specified host. If the Adaxes service is unavailable, the method throws an exception.

  • OpenObject()

  • Binds to a directory object, or Adaxes-specific object using the credentials supplied.

Properties

Details

GetNearestService()

Returns the IAdmService interface that represents the nearest Adaxes service.

IAdmService GetNearestService(string domainName, 
                              string username, 
                              string password)

Parameters

  • domainName - Specifies the name of the AD domain where to search for Adaxes services. The parameter can be null.
  • username - Specifies the username of the account, whose credentials will be used to search for Adaxes services. If set to null, the credentials of the currently logged on user will be used.
  • password - The password of the user specified in the username parameter.

Remarks

  • If the domainName parameter is specified, the method will search for Adaxes services in the specified domain.
  • If the domainName parameter is set to null, and the username and password parameters are specified, the method will search for Adaxes services in the domain of the user whose credentials are specified.
  • If all parameters are null, the method will search for Adaxes services in the current Active Directory domain using the credentials of the currently logged on user.
  • If you have multiple Adaxes services that manage one and the same domain and don't share common configuration (belong to different configuration sets), you need to explicitly specify which configuration set to use via the DefaultConfigurationSet property.

GetServicesForDomain()

Returns the IAdmServices interface that represents a collection of Adaxes services available in the domain specified.

IAdmServices GetServicesForDomain(string domainName, 
                                  string username, 
                                  string password)

Parameters

  • domainName - Specifies the name of the domain to list available Adaxes servers for.
  • username - Specifies the username of the account, whose credentials will be used to search for Adaxes services. If set to null, the credentials of the currently logged on user will be used.
  • password - The password of the user specified in the username parameter.

GetService()

Returns the IAdmService interface that represents the Adaxes service installed on the specified host. The method doesn't throw an exception if the Adaxes service is not available.

IAdmService GetService(string host, 
                       string username, 
                       string password)

Parameters

  • host - Specifies a valid IP address or DNS name of the desired Adaxes server.
  • username - Specifies the username of the account to be used to get information about the Adaxes service. If set to null, the credentials of the currently logged on user will be used.
  • password - The password of the user specified in the username parameter.

GetServiceDirectly()

Returns the IAdmService interface that represents the Adaxes service installed on the specified host. If the Adaxes service is unavailable, the method throws an exception.

IAdmService GetServiceDirectly(string host)

Parameters

The host parameter specifies the IP address or DNS host name of the desired Adaxes service.

Remarks

  • The method succeeds only if the Adaxes service is on-line and accessible from the client machine.
  • This method can 'hang-up' for several seconds while iterating through the list of available channels.

OpenObject()

Binds to a directory object, or Adaxes-specific object using the credentials supplied.

object OpenObject(string host, 
                  string adsPath, 
                  string username, 
                  string password, 
                  int authenticationOptions)

Parameters

  • host - Specifies the IP address or DNS host name of the Adaxes server to connect to. If set to null, automatic service discovery will be performed, otherwise the parameter must contain a valid IP address or DNS name of the host where the Adaxes service resides.
  • adsPath - Specifies the ADS path of the directory object to bind to.
  • username - Specifies the username to be used to bind to the object. If set to null, the credentials of the currently logged on user will be used.
  • password - Specifies the password of the account specified in the username parameter.
  • authenticationOptions - Specifies the authentication options. For more information and a list of values, see ADS_AUTHENTICATION_ENUM.

DefaultConfigurationSet

Gets or sets the ID of the default configuration set. This property is used to resolve ambiguity by forcing Adaxes ADSI provider to always prefer the specified configuration set among other configuration sets available.

  • Type:
  • string
  • Access:
  • Read/Write

Requirements

Minimum required version: 2009.1

See also

© Softerra 2022. All rights reserved.
Send feedback