Package com.predic8.membrane.core.interceptor.oauth2

Class OAuth2ResourceInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.oauth2.OAuth2ResourceInterceptor

All Implemented Interfaces:

Interceptor

public class OAuth2ResourceInterceptor
extends AbstractInterceptor

Description

Allows only authorized HTTP requests to pass through. Unauthorized requests get a redirect to the authorization server as response.

Topic

6. Security

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OA2REDIRECT
static final String	OAUTH2_ANSWER

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

name, router

Constructor Summary

Constructors

Constructor	Description
OAuth2ResourceInterceptor()

Method Summary

Modifier and Type	Method	Description
AuthorizationService	getAuthService()
String	getLoginLocation()
String	getLoginPath()
String	getPublicURL()
int	getRevalidateTokenAfter()
SessionManager	getSessionManager()
String	getShortDescription()
void	handleLoginRequest(Exchange exc)
final Outcome	handleRequest(Exchange exc)
boolean	handleRequest(Exchange exc, String state, String publicURL, SessionManager.Session session)
Outcome	handleResponse(Exchange exc)
void	init(Router router)
boolean	isLoginRequest(Exchange exc)
void	setAuthService(AuthorizationService auth)
void	setLoginLocation(String login)
void	setLoginPath(String loginPath)
void	setPublicURL(String publicURL)
void	setRevalidateTokenAfter(int revalidateTokenAfter)
void	setSessionManager(SessionManager sessionManager)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getLongDescription, getMessage, getRouter, getRule, handleAbort, init, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Field Details

OAUTH2_ANSWER

public static final String OAUTH2_ANSWER

See Also:

• Constant Field Values

OA2REDIRECT

public static final String OA2REDIRECT

See Also:

• Constant Field Values

Constructor Details

OAuth2ResourceInterceptor

public OAuth2ResourceInterceptor()

Method Details

getLoginLocation

public String getLoginLocation()

setLoginLocation

public void setLoginLocation(String login)

Description

location of the login dialog template (a directory containing the index.html file as well as possibly other resources). Required for older browsers to work.

Example

file:c:/work/login/

getLoginPath

public String getLoginPath()

setLoginPath

public void setLoginPath(String loginPath)

Default

/login/

Description

context path of the login dialog

getPublicURL

public String getPublicURL()

setPublicURL

public void setPublicURL(String publicURL)

getAuthService

public AuthorizationService getAuthService()

setAuthService

public void setAuthService(AuthorizationService auth)

getSessionManager

public SessionManager getSessionManager()

setSessionManager

public void setSessionManager(SessionManager sessionManager)

getRevalidateTokenAfter

public int getRevalidateTokenAfter()

setRevalidateTokenAfter

public void setRevalidateTokenAfter(int revalidateTokenAfter)

Default

-1

Description

time in seconds until a oauth2 access token is revalidatet with authorization server. This is disabled for values < 0

init

public void init(Router router)
          throws Exception

Specified by:

init in interface Interceptor

Overrides:

init in class AbstractInterceptor

Throws:

Exception

handleRequest

public final Outcome handleRequest(Exchange exc)
                            throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

handleResponse

public Outcome handleResponse(Exchange exc)
                       throws Exception

Specified by:

handleResponse in interface Interceptor

Overrides:

handleResponse in class AbstractInterceptor

Throws:

Exception

isLoginRequest

public boolean isLoginRequest(Exchange exc)

handleLoginRequest

public void handleLoginRequest(Exchange exc)
                        throws Exception

Throws:

Exception

handleRequest

public boolean handleRequest(Exchange exc,
 String state,
 String publicURL,
 SessionManager.Session session)
                      throws Exception

Throws:

Exception

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor