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

Class CommonIdentityAssertionFilter

java.lang.Object

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

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

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

All Implemented Interfaces:

javax.servlet.Filter

public class CommonIdentityAssertionFilter
extends AbstractIdentityAssertionFilter

Constructor Summary

Constructors

Constructor and Description
CommonIdentityAssertionFilter()

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) Obtain the standard javax.security.auth.Subject, retrieve the caller principal, map to the identity to be asserted as appropriate and create the provider specific assertion token.
void	init(javax.servlet.FilterConfig filterConfig)
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.
protected String[]	mapGroupPrincipalsBase(String mappedPrincipalName, Subject subject)
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.
protected String	mapUserPrincipalBase(String principalName)
javax.servlet.http.HttpServletRequestWrapper	wrapHttpServletRequest(javax.servlet.ServletRequest request, String mappedPrincipalName)

Methods inherited from class org.apache.knox.gateway.identityasserter.common.filter.AbstractIdentityAssertionFilter

continueChainAsPrincipal

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

Constructor Detail

CommonIdentityAssertionFilter

public CommonIdentityAssertionFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

destroy

public void destroy()

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Obtain the standard javax.security.auth.Subject, retrieve the caller principal, map to the identity to be asserted as appropriate and create the provider specific assertion token. Add the assertion token to the request.

Throws:

IOException

javax.servlet.ServletException

wrapHttpServletRequest

public javax.servlet.http.HttpServletRequestWrapper wrapHttpServletRequest(javax.servlet.ServletRequest request,
                                                                           String mappedPrincipalName)

mapGroupPrincipalsBase

protected String[] mapGroupPrincipalsBase(String mappedPrincipalName,
                                          Subject subject)

mapUserPrincipalBase

protected String mapUserPrincipalBase(String principalName)

mapGroupPrincipals

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

Description copied from class: AbstractIdentityAssertionFilter

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.

Specified by:

mapGroupPrincipals in class AbstractIdentityAssertionFilter

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 String mapUserPrincipal(String principalName)

Description copied from class: AbstractIdentityAssertionFilter

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.

Specified by:

mapUserPrincipal in class AbstractIdentityAssertionFilter

Returns:

new username or the provided principalName