com.atlassian.seraph.spi.rememberme
Interface RememberMeConfiguration

All Known Implementing Classes:
DefaultRememberMeConfiguration

public interface RememberMeConfiguration

This interface provides the information to allow the RememberMeService to know what the name of the remember me cookie could be and how old it should be made and what path it should be placed on and so on.


Method Summary
 String getCookieDomain(javax.servlet.http.HttpServletRequest httpServletRequest)
           
 int getCookieMaxAgeInSeconds()
           
 String getCookieName()
           
 String getCookiePath(javax.servlet.http.HttpServletRequest httpServletRequest)
           
 boolean isCookieHttpOnly(javax.servlet.http.HttpServletRequest httpServletRequest)
          If this is true than Seraph will make the remember me a HttpOnly cookie.
 boolean isInsecureCookieAlwaysUsed()
          See JRA-10508
 

Method Detail

getCookieName

String getCookieName()
Returns:
the name of the cookie to look into for remember me information

getCookieMaxAgeInSeconds

int getCookieMaxAgeInSeconds()
Returns:
the age in seconds for the remember me cookie

getCookieDomain

String getCookieDomain(javax.servlet.http.HttpServletRequest httpServletRequest)
Parameters:
httpServletRequest - the request in play
Returns:
the domain that should be used when writing the remember me cookie

getCookiePath

String getCookiePath(javax.servlet.http.HttpServletRequest httpServletRequest)
Parameters:
httpServletRequest - the request in play
Returns:
the path that should be used when writing the remember me cookie

isInsecureCookieAlwaysUsed

boolean isInsecureCookieAlwaysUsed()
See JRA-10508

Returns:
true if the cookie should never be set to secure according to the request

isCookieHttpOnly

boolean isCookieHttpOnly(javax.servlet.http.HttpServletRequest httpServletRequest)
If this is true than Seraph will make the remember me a HttpOnly cookie. Not all applications, browsers and testing framework can handle HttpOnly cookies

Parameters:
httpServletRequest - the request in play
Returns:
true for HttpOnly cookies


Copyright © 2013 Atlassian. All Rights Reserved.