org.apache.knox.gateway.security.principal

Interface PrincipalMapper

All Known Implementing Classes:

SimplePrincipalMapper

public interface PrincipalMapper

Method Summary

Modifier and Type	Method and Description
void	loadMappingTable(String principalMapping, String groupMapping) Load the internal principal mapping table from the provided string value which conforms to the following semicolon delimited format: actual[,another-actual]=mapped;...
String[]	mapGroupPrincipal(String principalName) Acquire array of group principal names from the mapping table as appropriate.
String	mapUserPrincipal(String principalName) Acquire a mapped principal name from the mapping table as appropriate.

Method Detail

loadMappingTable

void loadMappingTable(String principalMapping,
                      String groupMapping)
               throws PrincipalMappingException

Load the internal principal mapping table from the provided string value which conforms to the following semicolon delimited format: actual[,another-actual]=mapped;...

Parameters:

principalMapping - semicolon delimited format of principal mapping

groupMapping - semicolon delimited format of principal mapping

Throws:

PrincipalMappingException - Exception if principal mapping cannot be loaded

mapUserPrincipal

String mapUserPrincipal(String principalName)

Acquire a mapped principal name from the mapping table as appropriate. Otherwise, the provided principalName will be used.

Parameters:

principalName - principal name to look up in the mapping table

Returns:

principal name to be used in the assertion

mapGroupPrincipal

String[] mapGroupPrincipal(String principalName)

Acquire array of group principal names from the mapping table as appropriate. Otherwise, return null.

Parameters:

principalName - principal name to look up in the mapping table

Returns:

group principal names to be used in the assertion