Package org.wso2.carbon.user.api

Interface ClaimManager

public interface ClaimManager

This is the interface to manage claims in the system.

A claim is a name-value pair

Method Summary

Modifier and Type	Method	Description
void	addNewClaimMapping(ClaimMapping mapping)	Adds a new claim mapping
void	deleteClaimMapping(ClaimMapping mapping)	Deletes a claim mapping
ClaimMapping[]	getAllClaimMappings()	Gets all claim objects
ClaimMapping[]	getAllClaimMappings(String dialectUri)	Gets all claims in the dialect
String[]	getAllClaimUris()	Gets all claim URIs
ClaimMapping[]	getAllRequiredClaimMappings()	Gets all mandatory claims
ClaimMapping[]	getAllSupportClaimMappingsByDefault()	Gets all supported claims by default in the system.
String	getAttributeName(String claimURI)	Retrieves the attribute name of the claim URI.
String	getAttributeName(String domainName, String claimURI)
Claim	getClaim(String claimURI)	The Claim object of the claim URI
ClaimMapping	getClaimMapping(String claimURI)	Gets the claim mapping.
void	updateClaimMapping(ClaimMapping mapping)	Updates a claim mapping

Method Detail

getAttributeName

String getAttributeName(String claimURI)
                 throws UserStoreException

Retrieves the attribute name of the claim URI.

Parameters:

claimURI - The claim URI

Returns:

Throws:

UserStoreException

getClaim

Claim getClaim(String claimURI)
        throws UserStoreException

The Claim object of the claim URI

Parameters:

claimURI - The claim URI

Returns:

Throws:

UserStoreException

getClaimMapping

ClaimMapping getClaimMapping(String claimURI)
                      throws UserStoreException

Gets the claim mapping.

Parameters:

claimURI - The claim URI

Returns:

Throws:

UserStoreException

getAllSupportClaimMappingsByDefault

ClaimMapping[] getAllSupportClaimMappingsByDefault()
                                            throws UserStoreException

Gets all supported claims by default in the system.

Returns:

An array of claim objects supported by default

Throws:

UserStoreException

getAllClaimMappings

ClaimMapping[] getAllClaimMappings()
                            throws UserStoreException

Gets all claim objects

Returns:

An array of all claim objects

Throws:

UserStoreException

getAllClaimMappings

ClaimMapping[] getAllClaimMappings(String dialectUri)
                            throws UserStoreException

Gets all claims in the dialect

Parameters:

dialectUri - The dialect URI

Returns:

Throws:

UserStoreException

getAllRequiredClaimMappings

ClaimMapping[] getAllRequiredClaimMappings()
                                    throws UserStoreException

Gets all mandatory claims

Returns:

Throws:

UserStoreException

getAllClaimUris

String[] getAllClaimUris()
                  throws UserStoreException

Gets all claim URIs

Returns:

Throws:

UserStoreException

addNewClaimMapping

void addNewClaimMapping(ClaimMapping mapping)
                 throws UserStoreException

Adds a new claim mapping

Parameters:

mapping - The claim mapping to be added

Throws:

UserStoreException

deleteClaimMapping

void deleteClaimMapping(ClaimMapping mapping)
                 throws UserStoreException

Deletes a claim mapping

Parameters:

mapping - The claim mapping to be deleted

Throws:

UserStoreException

updateClaimMapping

void updateClaimMapping(ClaimMapping mapping)
                 throws UserStoreException

Updates a claim mapping

Parameters:

mapping - The claim mapping to be updated

Throws:

UserStoreException

getAttributeName

String getAttributeName(String domainName,
                        String claimURI)
                 throws UserStoreException

Parameters:

domainName -

claimURI -

Returns:

Throws:

UserStoreException