org.apache.knox.gateway.identityasserter.common.filter

Class AbstractIdentityAssertionFilter

java.lang.Object

org.apache.knox.gateway.filter.security.AbstractIdentityAssertionBase

org.apache.knox.gateway.identityasserter.common.filter.AbstractIdentityAssertionFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

CommonIdentityAssertionFilter

public abstract class AbstractIdentityAssertionFilter
extends AbstractIdentityAssertionBase
implements javax.servlet.Filter

Constructor Summary

Constructors

Constructor and Description
AbstractIdentityAssertionFilter()

Method Summary

Modifier and Type	Method and Description
protected void	continueChainAsPrincipal(javax.servlet.http.HttpServletRequestWrapper request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain, String mappedPrincipalName, String[] groups)
abstract String[]	mapGroupPrincipals(String mappedPrincipalName, Subject subject) This method returns a Stringp[] of new group principal names to use based on implementation specific mapping or lookup mechanisms.
abstract String	mapUserPrincipal(String principalName) This method is used to map the username of the authenticated identity to some other principal name based on an implementation specific mechanism.

Methods inherited from class org.apache.knox.gateway.filter.security.AbstractIdentityAssertionBase

getPrincipalName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Constructor Detail

AbstractIdentityAssertionFilter

public AbstractIdentityAssertionFilter()

Method Detail

mapGroupPrincipals

public abstract String[] mapGroupPrincipals(String mappedPrincipalName,
                                            Subject subject)

This method returns a Stringp[] of new group principal names to use based on implementation specific mapping or lookup mechanisms. Returning null means that whatever set of GroupPrincipals is in the provided Subject is sufficient to use and no additional mapping is required.

Parameters:

mappedPrincipalName - username for the authenticated identity - post mapUserPrincipal mapping.

subject - the existing Subject from the authentication event which may or may not contain GroupPrincipals.

Returns:

String[] of new principal names to use as GroupPrincipals or null.

mapUserPrincipal

public abstract String mapUserPrincipal(String principalName)

This method is used to map the username of the authenticated identity to some other principal name based on an implementation specific mechanism. It will either return a new principal name or the provided principal name if there is no mapping required.

Parameters:

principalName -

Returns:

new username or the provided principalName

continueChainAsPrincipal

protected void continueChainAsPrincipal(javax.servlet.http.HttpServletRequestWrapper request,
                                        javax.servlet.ServletResponse response,
                                        javax.servlet.FilterChain chain,
                                        String mappedPrincipalName,
                                        String[] groups)
                                 throws IOException,
                                        javax.servlet.ServletException

Parameters:

request -

response -

chain -

mappedPrincipalName -

groups -

Throws:

IOException

javax.servlet.ServletException