org.wso2.carbon.identity.oauth.client.auth.sample

Class OAuthSampleClientAuthenticator

java.lang.Object

org.wso2.carbon.identity.core.handler.AbstractIdentityHandler

org.wso2.carbon.identity.oauth2.client.authentication.AbstractOAuthClientAuthenticator

org.wso2.carbon.identity.oauth.client.auth.sample.OAuthSampleClientAuthenticator

All Implemented Interfaces:

org.wso2.carbon.identity.core.handler.IdentityHandler, org.wso2.carbon.identity.oauth2.client.authentication.OAuthClientAuthenticator

public class OAuthSampleClientAuthenticator
extends org.wso2.carbon.identity.oauth2.client.authentication.AbstractOAuthClientAuthenticator

Sample client authenticator which will authenticate client request using client_id and cleint_secret which are available as two separate HTTP headers.

Field Summary

Fields inherited from class org.wso2.carbon.identity.core.handler.AbstractIdentityHandler

initConfig, properties

Constructor Summary

Constructors

Constructor and Description
OAuthSampleClientAuthenticator()

Method Summary

Modifier and Type	Method and Description
boolean	authenticateClient(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List> bodyParams, org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext) Authenticates oauth client based on client_id and client_secret headers.
boolean	canAuthenticate(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List> bodyParams, org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext) Returns whether this request can be authenticated by this client authenticator.
String	getClientId(javax.servlet.http.HttpServletRequest httpServletRequest, Map<String,List> bodyParams, org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext) Extracts client id from incoming request and sends out.
String	getName() Returns the name of this client authenticator.
int	getPriority() Returns the execution order of this sample authenticator.

Methods inherited from class org.wso2.carbon.identity.oauth2.client.authentication.AbstractOAuthClientAuthenticator

getBodyParameters

Methods inherited from class org.wso2.carbon.identity.core.handler.AbstractIdentityHandler

init, isEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wso2.carbon.identity.core.handler.IdentityHandler

init, isEnabled

Constructor Detail

OAuthSampleClientAuthenticator

public OAuthSampleClientAuthenticator()

Method Detail

authenticateClient

public boolean authenticateClient(javax.servlet.http.HttpServletRequest httpServletRequest,
                                  Map<String,List> bodyParams,
                                  org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext)
                           throws org.wso2.carbon.identity.oauth2.client.authentication.OAuthClientAuthnException

Authenticates oauth client based on client_id and client_secret headers.

Parameters:

httpServletRequest - Incoming HttpServlet request.

bodyParams - body content map.

oAuthClientAuthnContext -

Returns:

True if successfully authenticates. False if authentication failes

Throws:

org.wso2.carbon.identity.oauth2.client.authentication.OAuthClientAuthnException

canAuthenticate

public boolean canAuthenticate(javax.servlet.http.HttpServletRequest httpServletRequest,
                               Map<String,List> bodyParams,
                               org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext)

Returns whether this request can be authenticated by this client authenticator.

Parameters:

httpServletRequest - Incoming HttpServletRequest.

bodyParams - Content of the body.

oAuthClientAuthnContext - OAuth Client authentication context.

Returns:

True if the client can be authenticated and false else.

getClientId

public String getClientId(javax.servlet.http.HttpServletRequest httpServletRequest,
                          Map<String,List> bodyParams,
                          org.wso2.carbon.identity.oauth2.bean.OAuthClientAuthnContext oAuthClientAuthnContext)
                   throws org.wso2.carbon.identity.oauth2.client.authentication.OAuthClientAuthnException

Extracts client id from incoming request and sends out.

Parameters:

httpServletRequest - Incoming HttpServletRequest.

bodyParams - Content of the request body.

oAuthClientAuthnContext - OAuth client authentication context

Returns:

Client Id.

Throws:

org.wso2.carbon.identity.oauth2.client.authentication.OAuthClientAuthnException - OAuthClientAuthenticationException.

getPriority

public int getPriority()

Returns the execution order of this sample authenticator.

Specified by:

getPriority in interface org.wso2.carbon.identity.core.handler.IdentityHandler

Overrides:

getPriority in class org.wso2.carbon.identity.core.handler.AbstractIdentityHandler

Returns:

getName

public String getName()

Returns the name of this client authenticator.

Specified by:

getName in interface org.wso2.carbon.identity.core.handler.IdentityHandler

Overrides:

getName in class org.wso2.carbon.identity.core.handler.AbstractIdentityHandler

Returns: