Package org.wso2.carbon.ui

Class CarbonUILoginUtil

java.lang.Object

org.wso2.carbon.ui.CarbonUILoginUtil

public final class CarbonUILoginUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	CONTINUE
protected static final int	RETURN_FALSE
protected static final int	RETURN_TRUE

Constructor Summary

Constructors

Constructor	Description
CarbonUILoginUtil()

Method Summary

Modifier and Type	Method	Description
protected static String	addNewContext(String requestedURI)
protected static boolean	escapeTenantWebAppRequests(boolean authenticated, javax.servlet.http.HttpServletResponse response, String requestedURI, String context)
protected static CarbonUIAuthenticator	getAuthenticator(javax.servlet.http.HttpServletRequest request)	Returns the corresponding CarbonAuthenticator based on the request.
protected static String	getCustomIndexPage(javax.servlet.http.HttpServletRequest request, String indexPageURL)	Deprecated.
protected static String	getForcedSignOutRequestedURI(String requestedURI, javax.servlet.http.HttpServletRequest request)
protected static String	getIndexPageUrlFromCookie(String requestedURI, String indexPageURL, javax.servlet.http.HttpServletRequest request)
protected static Pattern	getTenantEnabledUriPattern()
protected static boolean	handleLogin(CarbonUIAuthenticator authenticator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpSession session, boolean authenticated, String contextPath, String indexPageURL, String httpLogin)
protected static int	handleLoginPageRequest(String requestedURI, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean authenticated, String context, String indexPageURL)
protected static boolean	handleLogout(CarbonUIAuthenticator authenticator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpSession session, boolean authenticated, String contextPath, String indexPageURL, String httpLogin)
protected static boolean	letRequestedUrlIn(String requestedURI, String tempUrl)
protected static boolean	saveOriginalUrl(CarbonUIAuthenticator authenticator, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.http.HttpSession session, boolean skipLoginPage, String contextPath, String indexPageURL, String requestedURI)
protected static String	uRIContextBuilder(String contextPath)

Methods inherited from class java.lang.Object

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

Field Details

RETURN_FALSE

protected static final int RETURN_FALSE

See Also:

• Constant Field Values

RETURN_TRUE

protected static final int RETURN_TRUE

See Also:

• Constant Field Values

CONTINUE

protected static final int CONTINUE

See Also:

• Constant Field Values

Constructor Details

CarbonUILoginUtil

public CarbonUILoginUtil()

Method Details

getTenantEnabledUriPattern

protected static Pattern getTenantEnabledUriPattern()

Returns:

getAuthenticator

protected static CarbonUIAuthenticator getAuthenticator(javax.servlet.http.HttpServletRequest request)

Returns the corresponding CarbonAuthenticator based on the request.

Parameters:

request -

Returns:

saveOriginalUrl

protected static boolean saveOriginalUrl(CarbonUIAuthenticator authenticator,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.http.HttpSession session,
 boolean skipLoginPage,
 String contextPath,
 String indexPageURL,
 String requestedURI)
                                  throws IOException

Parameters:

authenticator -

request -

response -

session -

skipLoginPage -

contextPath -

indexPageURL -

requestedURI -

Returns:

Throws:

IOException

getCustomIndexPage

@Deprecated
protected static String getCustomIndexPage(javax.servlet.http.HttpServletRequest request,
 String indexPageURL)

Deprecated.

Parameters:

request -

indexPageURL -

Returns:

getIndexPageUrlFromCookie

protected static String getIndexPageUrlFromCookie(String requestedURI,
 String indexPageURL,
 javax.servlet.http.HttpServletRequest request)

Parameters:

requestedURI -

indexPageURL -

request -

Returns:

letRequestedUrlIn

protected static boolean letRequestedUrlIn(String requestedURI,
 String tempUrl)

Parameters:

requestedURI -

Returns:

handleLogout

protected static boolean handleLogout(CarbonUIAuthenticator authenticator,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.http.HttpSession session,
 boolean authenticated,
 String contextPath,
 String indexPageURL,
 String httpLogin)
                               throws IOException

Parameters:

authenticator -

request -

response -

session -

authenticated -

contextPath -

indexPageURL -

httpLogin -

Returns:

Throws:

IOException

handleLogin

protected static boolean handleLogin(CarbonUIAuthenticator authenticator,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.http.HttpSession session,
 boolean authenticated,
 String contextPath,
 String indexPageURL,
 String httpLogin)
                              throws IOException

Parameters:

authenticator -

request -

response -

session -

authenticated -

contextPath -

indexPageURL -

httpLogin -

Returns:

Throws:

IOException

getForcedSignOutRequestedURI

protected static String getForcedSignOutRequestedURI(String requestedURI,
 javax.servlet.http.HttpServletRequest request)

Parameters:

requestedURI -

request -

Returns:

handleLoginPageRequest

protected static int handleLoginPageRequest(String requestedURI,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 boolean authenticated,
 String context,
 String indexPageURL)
                                     throws IOException

Parameters:

requestedURI -

request -

response -

authenticated -

context -

indexPageURL -

Returns:

Throws:

IOException

escapeTenantWebAppRequests

protected static boolean escapeTenantWebAppRequests(boolean authenticated,
 javax.servlet.http.HttpServletResponse response,
 String requestedURI,
 String context)
                                             throws IOException

Parameters:

authenticated -

response -

requestedURI -

context -

Returns:

Throws:

IOException

addNewContext

protected static String addNewContext(String requestedURI)

Parameters:

requestedURI -

Returns:

uRIContextBuilder

protected static String uRIContextBuilder(String contextPath)