com.sap.smp.client.httpc.authflows.oauth2

Class OAuth2RequestFilter

java.lang.Object

com.sap.smp.client.httpc.authflows.oauth2.OAuth2RequestFilter

All Implemented Interfaces:

IRequestFilter

public class OAuth2RequestFilter
extends java.lang.Object
implements IRequestFilter

OAuth2 request filter taking part in the OAuth2 functionality of this library.

Constructor Summary

Constructors

Constructor and Description
OAuth2RequestFilter(java.util.List<OAuth2ServerSupport> serverSupports, android.content.Context appContext, OAuth2TokenStorage tokenStorage)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	filter(ISendEvent event, IRequestFilterChain chain) Filters the specified send event and optionally passes on the control to the rest of the chain.
java.lang.Object	getDescriptor() Returns a descriptor, which is a value-object that can be used to identify the filter for the purpose of chain transformation.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2RequestFilter

public OAuth2RequestFilter(java.util.List<OAuth2ServerSupport> serverSupports,
                           android.content.Context appContext,
                           OAuth2TokenStorage tokenStorage)

Method Detail

filter

public java.lang.Object filter(ISendEvent event,
                               IRequestFilterChain chain)

Description copied from interface: IRequestFilter

Filters the specified send event and optionally passes on the control to the rest of the chain. Returning a non-null object yields the cancellation of the conversation flow.

Implementations performing potentially long-running operations are expected to inspect the return value of IBaseEvent.isCancelledExternally() and return if it signals true.

Passing control over to the rest of the chain is done as follows:

 return chain.filter();
 

Specified by:

filter in interface IRequestFilter

Parameters:

event - the event, must be non-null

chain - the chain, must be non-null

Returns:

the object to be passed to the flow listener, non-null to cancel the flow. The return value does not matter in case the flow was cancelled externally.

getDescriptor

public java.lang.Object getDescriptor()

Description copied from interface: IRequestFilter

Returns a descriptor, which is a value-object that can be used to identify the filter for the purpose of chain transformation. In most cases it's an instance of an enum or some kind of value object.

Specified by:

getDescriptor in interface IRequestFilter

Returns:

the descriptor