org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter クラス

org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter の継承関係図

org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter 連携図

クラス
class	OAuthHttpServletRequestWrapper

公開メンバ関数
void	init (final FilterConfig filterConfig) throws ServletException
void	destroy ()
void	doFilter (final ServletRequest servletRequest, final ServletResponse servletResponse, final FilterChain filterChain) throws IOException, ServletException

限定公開メンバ関数
SimplePrincipal	retrievePrincipalFromSessionOrRequest (final ServletRequest servletRequest)
final String	getPropertyFromInitParams (final FilterConfig filterConfig, final String propertyName, final String defaultValue)

限定公開変数類
final Log	log = LogFactory.getLog(getClass())

詳解

Implementation of a filter that wraps the normal HttpServletRequest with a wrapper that overrides the following methods to provide data from the OAuth data:

• HttpServletRequest#getUserPrincipal()
• HttpServletRequest#getRemoteUser()

This filter needs to be configured in the chain so that it executes after both the authentication and the validation filters.

著者

Yuriy Movchan

バージョン

0.1, 03/20/2013

関数詳解

destroy()

void org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter.destroy ( )

inline

                          {
    }

doFilter()

void org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter.doFilter ( final ServletRequest  servletRequest, final ServletResponse  servletResponse, final FilterChain  filterChain  ) throws IOException, ServletException

inline

Wraps the HttpServletRequest in a wrapper class that delegates request.getRemoteUser to the underlying OAuthData object stored in the user session.

                                                                                                                                                                         {
        final SimplePrincipal principal = retrievePrincipalFromSessionOrRequest(servletRequest);
        
        if (principal == null) {
            log.trace("There is no principal");
                filterChain.doFilter(servletRequest, servletResponse);
        } else {
                filterChain.doFilter(new OAuthHttpServletRequestWrapper((HttpServletRequest) servletRequest, principal), servletResponse);
        }
    }

getPropertyFromInitParams()

final String org.gluu.oxauth.client.util.AbstractConfigurationFilter.getPropertyFromInitParams ( final FilterConfig  filterConfig, final String  propertyName, final String  defaultValue  )

inlineprotectedinherited

Retrieves the property from the FilterConfig. First it checks the FilterConfig's initParameters to see if it has a value. If it does, it returns that, otherwise it retrieves the ServletContext's initParameters and returns that value if any.

引数

filterConfig	the Filter Configuration.
propertyName	the property to retrieve.
defaultValue	the default value if the property is not found.

戻り値

the property value, following the above conventions. It will always return the more specific value (i.e. filter vs. context).

                                                                                                                                             {
//        final String value = filterConfig.getInitParameter(propertyName);
//
//        if (StringHelper.isNotEmpty(value)) {
//            log.info("Property [" + propertyName + "] loaded from FilterConfig.getInitParameter with value [" + value + "]");
//            return value;
//        }
//
//        final String value2 = filterConfig.getServletContext().getInitParameter(propertyName);
//        if (StringHelper.isNotEmpty(value2)) {
//            log.info("Property [" + propertyName + "] loaded from ServletContext.getInitParameter with value [" + value2 + "]");
//            return value2;
//        }

        final String value3 = Configuration.instance().getPropertyValue(propertyName);
        if (StringHelper.isNotEmpty(value3)) {
            log.info("Property [" + propertyName + "] loaded from oxTrust.properties");
            return value3;
        }

        log.info("Property [" + propertyName + "] not found.  Using default value [" + defaultValue + "]");
        return defaultValue;
    }

init()

void org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter.init ( final FilterConfig  filterConfig ) throws ServletException

inline

                                                                              {
    }

retrievePrincipalFromSessionOrRequest()

SimplePrincipal org.gluu.oxauth.client.util.HttpServletRequestWrapperFilter.retrievePrincipalFromSessionOrRequest ( final ServletRequest  servletRequest )

inlineprotected

                                                                                                         {
        final HttpServletRequest request = (HttpServletRequest) servletRequest;
        final HttpSession session = request.getSession(false);
        final OAuthData oAuthData = (OAuthData) (session == null ? request.getAttribute(Configuration.SESSION_OAUTH_DATA) : session.getAttribute(Configuration.SESSION_OAUTH_DATA));

        if (oAuthData == null) {
            log.trace("There is no OAuthData in session");
                return null;
        }
        
        SimplePrincipal principanl = new SimplePrincipal(oAuthData.getUserUid()); 

        return principanl;
    }

メンバ詳解

log

final Log org.gluu.oxauth.client.util.AbstractConfigurationFilter.log = LogFactory.getLog(getClass())

protectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/saml-openid-auth-client/src/main/java/org/gluu/oxauth/client/util/HttpServletRequestWrapperFilter.java