org.gluu.oxauth.client.logout.LogoutFilter クラス

org.gluu.oxauth.client.logout.LogoutFilter の継承関係図

org.gluu.oxauth.client.logout.LogoutFilter 連携図

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

静的公開メンバ関数
static String	getParameter (final HttpServletRequest request, final String parameter)

限定公開メンバ関数
final String	constructRedirectUrl (final HttpServletRequest request)
final String	getPropertyFromInitParams (final FilterConfig filterConfig, final String propertyName, final String defaultValue)

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

詳解

Filter implementation to intercept all requests and attempt to logout the client by redirecting them to OAuth.

著者

Dmitry Ognyannikov

関数詳解

constructRedirectUrl()

final String org.gluu.oxauth.client.session.AbstractOAuthFilter.constructRedirectUrl ( final HttpServletRequest  request )

inlineprotectedinherited

                                                                                  {
        int serverPort = request.getServerPort();

        String redirectUrl;
        if ((serverPort == 80) || (serverPort == 443)) {
                redirectUrl = String.format("%s://%s%s%s", request.getScheme(), request.getServerName(), request.getContextPath(), "/auth-code.jsp");
        } else {
                redirectUrl = String.format("%s://%s:%s%s%s", request.getScheme(), request.getServerName(), request.getServerPort(), request.getContextPath(), "/auth-code.jsp");
        }
        
        return redirectUrl.toLowerCase();
    }

destroy()

void org.gluu.oxauth.client.logout.LogoutFilter.destroy ( )

inline

                          {
    }

doFilter()

void org.gluu.oxauth.client.logout.LogoutFilter.doFilter ( ServletRequest  servletRequest, ServletResponse  servletResponse, FilterChain  chain  ) throws IOException, ServletException

inline

                                                                                                                                                 {
        final HttpServletRequest request = (HttpServletRequest) servletRequest;
        final HttpServletResponse response = (HttpServletResponse) servletResponse;
        
        HttpSession session = request.getSession(false);
        
        String urlToRedirectTo;
        try {
            SignOutHandler signOutHandler = SignOutHandler.instance();
            urlToRedirectTo = signOutHandler.getOAuthLogoutUrl(request);
            if (urlToRedirectTo == null) {
                urlToRedirectTo = signOutHandler.constructRedirectUrl(request);
            }
        } catch (Exception ex) {
            log.error("Failed to preapre request to OAuth server", ex);
            if (session != null) {
                // clear session
                session.invalidate();
            }
            return;
        }
        
        if (session != null) {
            // clear session
            session.invalidate();
        }
        
        log.debug("Redirecting to \"" + urlToRedirectTo + "\"");
        response.sendRedirect(urlToRedirectTo);
    }

getParameter()

static String org.gluu.oxauth.client.session.AbstractOAuthFilter.getParameter ( final HttpServletRequest  request, final String  parameter  )

inlinestaticinherited

Method for retrieving a parameter from the request without disrupting the reader UNLESS the parameter actually exists in the query string.

引数

request	the request to check.
parameter	the parameter to look for.

戻り値

the value of the parameter.

                                                                                                {
        return request.getQueryString() == null || request.getQueryString().indexOf(parameter) == -1 ? null : request.getParameter(parameter);       
    }

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.logout.LogoutFilter.init ( FilterConfig  filterConfig ) throws ServletException

inline

                                                                        {
    }

メンバ詳解

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/logout/LogoutFilter.java