C# Class Microsoft.Protocols.TestSuites.MS_CPSWS.MS_CPSWSAdapter

Adapter class of MS-CPSWS.

Inheritance: Microsoft.Protocols.TestTools.ManagedAdapterBase, IMS_CPSWSAdapter

Show file Open project: OfficeDev/Interop-TestSuites

Public Methods

Method	Description
ClaimTypes ( ArrayOfString providerNames ) : ArrayOfString	A method used to get the claim types.
ClaimValueTypes ( ArrayOfString providerNames ) : ArrayOfString	A method used to get the claim value types.
EntityTypes ( ArrayOfString providerNames ) : ArrayOfString	A method used to get the entity types.
GetHierarchy ( string providerName, SPPrincipalType principalType, string hierarchyNodeID, int numberOfLevels ) : SPProviderHierarchyTree	A method used to retrieve a claims provider hierarchy tree from a claims provider.
GetHierarchyAll ( ArrayOfString providerNames, SPPrincipalType principalType, int numberOfLevels ) : SPProviderHierarchyTree[]	A method used to retrieve a list of claims provider hierarchy trees from a list of claims providers.
HierarchyProviderSchema ( ) : SPProviderSchema	A method used to retrieve schema for the current hierarchy provider.
Initialize ( ITestSite testSite ) : void	Overrides IAdapter's Initialize(), to set default protocol short name of the testSite.
ProviderSchemas ( ArrayOfString providerNames ) : SPProviderSchema[]	A method used to retrieve a list of claims provider schemas from a list of claims providers.
Resolve ( ArrayOfString providerNames, SPPrincipalType principalType, string resolveInput ) : PickerEntity[]	A method used to resolve an input string to picker entities using a list of claims providers.
ResolveClaim ( ArrayOfString providerNames, SPPrincipalType principalType, SPClaim resolveInput ) : PickerEntity[]	A method used to resolve an input claim to picker entities using a list of claims providers.
ResolveMultiple ( ArrayOfString providerNames, SPPrincipalType principalType, ArrayOfString resolveInput ) : PickerEntity[]	A method used to resolve a list of strings to picker entities using a list of claims providers.
ResolveMultipleClaim ( ArrayOfString providerNames, SPPrincipalType principalType, SPClaim resolveInput ) : PickerEntity[]	A method used to resolve a list of claims to picker entities using a list of claims providers.
Search ( SPProviderSearchArguments providerSearchArguments, SPPrincipalType principalType, string searchPattern ) : SPProviderHierarchyTree[]	A method used to perform a search for entities on a list of claims providers.
SearchAll ( ArrayOfString providerNames, SPPrincipalType principalType, string searchPattern, int maxCount ) : SPProviderHierarchyTree[]	A method used to perform a search for entities on a list of claims providers.

Private Methods

Method	Description
CaptureTransportRelatedRequirements ( ) : void	Capture underlying transport protocol related requirements.
GetClaimProviderWebServiceClient ( ) : ClaimProviderWebServiceClient	A method used to get the claim provider web service client
LoadCommonConfiguration ( ) : void	A method used to load Common Configuration
ResponseExists ( XmlElement xmlElement, string responseName ) : bool	This method is used to validate whether there is an element named as responseName in xmlElement.
ValidArrayOfStringComplexType ( ) : void	A method used to validate the ArrayOfString complex type.
ValidateAndCaptureSOAPFaultRequirement ( System.ServiceModel.FaultException exception ) : void	Validate server fault returned by FaultException and capture related requirements.
ValidateArrayOfAnyTypeComplexType ( ) : void	A method used to validate ArrayOfAnyType complex type.
ValidateArrayOfPairComplexType ( ) : void	A method used to validate ArrayOfPair complex type.
ValidateArrayOfPickerEntityComplexType ( ) : void	A method used to validate ArrayOfPickerEntity complex type.
ValidateClaimTypesResponseData ( ArrayOfString claimTypesResult ) : void	A method used to validate the ClaimTypes response.
ValidateClaimValueTypesResponseData ( ArrayOfString claimValueTypesResult ) : void	A method used to validate the ClaimValueTypes response.
ValidateEntityTypesResponseData ( ArrayOfString entityTypesResult ) : void	A method used to validate the EntityTypes response.
ValidateGetHierarchyAllResponseData ( SPProviderHierarchyTree getHierarchyAllResult ) : void	A method used to validate the GetHierarchyAll response.
ValidateGetHierarchyResponseData ( SPProviderHierarchyTree getHierarchyResult ) : void	A method used to validate the GetHierarchy response.
ValidatePairComplexType ( ) : void	A method used to validate Pair complex type.
ValidatePickerEntityComplexType ( ) : void	A method used to validate PickerEntity complex type.
ValidateResolveClaimResponseData ( PickerEntity resolveClaimResult ) : void	A method used to validate the resolve claim response.
ValidateResolveMultipleClaimResponseData ( PickerEntity resolveMultipleClaimResult ) : void	A method used to validate the resolve multiple claim response.
ValidateResolveMultipleResponseData ( PickerEntity resolveMultipleResult ) : void	A method used to validate the resolve multiple response.
ValidateResolveResponseData ( PickerEntity resolveResult ) : void	A method used to validate the resolve operation response.
VerifyArrayOfSPProviderHierarchyTreeComplexType ( SPProviderHierarchyTree providerHierarchyTreeArray ) : void	A method used to verify the ArrayOfSPProviderHierarchyTree complex type.
VerifyHierarchyProviderSchema ( SPProviderSchema hierarchyProviderSchemaResult ) : void	A method used to verify the HierarchyProviderSchema response.
VerifyProviderSchemas ( SPProviderSchema providerSchemasResult ) : void	A method used to verify the ProviderSchemas response.
VerifySPProviderHierarchyTreeComplexType ( SPProviderHierarchyTree providerHierarchyTree ) : void	A method used to verify the SPProviderHierarchyTree complex type.
VerifySPProviderSchemaComplexType ( SPProviderSchema providerSchema ) : void	A method used to verify the SPProviderSchema complex type.
VerifySPSchemaElementComplexType ( bool isResponseValid ) : void	A method used to verify the SPSchemaElement complex type.
VerifySearch ( SPProviderHierarchyTree searchResult ) : void	A method used to verify the Search response.
VerifySearchAll ( SPProviderHierarchyTree searchAllResult ) : void	A method used to verify the SearchAll response.

Method Details

ClaimTypes() public method

A method used to get the claim types.

public ClaimTypes ( ArrayOfString providerNames ) : ArrayOfString
providerNames	ArrayOfString	A parameter represents a list of provider names which are used to retrieve the claim types.
return	ArrayOfString

ClaimValueTypes() public method

A method used to get the claim value types.

public ClaimValueTypes ( ArrayOfString providerNames ) : ArrayOfString
providerNames	ArrayOfString	A parameter represents a list of provider names which are used to retrieve the claim value types.
return	ArrayOfString

EntityTypes() public method

A method used to get the entity types.

public EntityTypes ( ArrayOfString providerNames ) : ArrayOfString
providerNames	ArrayOfString	A parameter represents a list of provider names which are used to retrieve the entity types.
return	ArrayOfString

GetHierarchy() public method

A method used to retrieve a claims provider hierarchy tree from a claims provider.

public GetHierarchy ( string providerName, SPPrincipalType principalType, string hierarchyNodeID, int numberOfLevels ) : SPProviderHierarchyTree
providerName	string	A parameter represents a provider name.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the output claims provider hierarchy tree.
hierarchyNodeID	string	A parameter represents the identifier of the node to be used as root of the returned claims provider hierarchy tree.
numberOfLevels	int	A parameter represents the maximum number of levels that can be returned by the protocol server in any of the output claims provider hierarchy tree.
return	SPProviderHierarchyTree

GetHierarchyAll() public method

A method used to retrieve a list of claims provider hierarchy trees from a list of claims providers.

public GetHierarchyAll ( ArrayOfString providerNames, SPPrincipalType principalType, int numberOfLevels ) : SPProviderHierarchyTree[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the output claims provider hierarchy tree.
numberOfLevels	int	A parameter represents the maximum number of levels that can be returned by the protocol server in any of the output claims provider hierarchy tree.
return	SPProviderHierarchyTree[]

HierarchyProviderSchema() public method

A method used to retrieve schema for the current hierarchy provider.

public HierarchyProviderSchema ( ) : SPProviderSchema
return	SPProviderSchema

Initialize() public method

Overrides IAdapter's Initialize(), to set default protocol short name of the testSite.

public Initialize ( ITestSite testSite ) : void
testSite	ITestSite	Transfer ITestSite into Adapter,Make adapter can use ITestSite's function.
return	void

ProviderSchemas() public method

A method used to retrieve a list of claims provider schemas from a list of claims providers.

public ProviderSchemas ( ArrayOfString providerNames ) : SPProviderSchema[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
return	SPProviderSchema[]

Resolve() public method

A method used to resolve an input string to picker entities using a list of claims providers.

public Resolve ( ArrayOfString providerNames, SPPrincipalType principalType, string resolveInput ) : PickerEntity[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the result.
resolveInput	string	A parameter represents the input to be resolved.
return	PickerEntity[]

ResolveClaim() public method

A method used to resolve an input claim to picker entities using a list of claims providers.

public ResolveClaim ( ArrayOfString providerNames, SPPrincipalType principalType, SPClaim resolveInput ) : PickerEntity[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the result
resolveInput	SPClaim	A parameter represents the SPClaim to be resolved.
return	PickerEntity[]

ResolveMultiple() public method

A method used to resolve a list of strings to picker entities using a list of claims providers.

public ResolveMultiple ( ArrayOfString providerNames, SPPrincipalType principalType, ArrayOfString resolveInput ) : PickerEntity[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the result.
resolveInput	ArrayOfString	A parameter represents a list of input strings to be resolved.
return	PickerEntity[]

ResolveMultipleClaim() public method

A method used to resolve a list of claims to picker entities using a list of claims providers.

public ResolveMultipleClaim ( ArrayOfString providerNames, SPPrincipalType principalType, SPClaim resolveInput ) : PickerEntity[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the result.
resolveInput	SPClaim	A parameter represents a list of claims to be resolved.
return	PickerEntity[]

Search() public method

A method used to perform a search for entities on a list of claims providers.

public Search ( SPProviderSearchArguments providerSearchArguments, SPPrincipalType principalType, string searchPattern ) : SPProviderHierarchyTree[]
providerSearchArguments	SPProviderSearchArguments	A parameter represents the search arguments.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the output claims provider hierarchy tree.
searchPattern	string	A parameter represents the search string.
return	SPProviderHierarchyTree[]

SearchAll() public method

A method used to perform a search for entities on a list of claims providers.

public SearchAll ( ArrayOfString providerNames, SPPrincipalType principalType, string searchPattern, int maxCount ) : SPProviderHierarchyTree[]
providerNames	ArrayOfString	A parameter represents a list of provider names.
principalType	SPPrincipalType	A parameter represents which type of picker entities to be included in the output claims provider hierarchy tree.
searchPattern	string	A parameter represents the search string.
maxCount	int	A parameter represents the maximum number of matched entities to be returned in total across all the output claims provider hierarchy trees.
return	SPProviderHierarchyTree[]