Package org.oa4mp.server.loader.oauth2.claims

Class BasicClaimsSourceImpl

java.lang.Object

org.oa4mp.server.loader.oauth2.claims.BasicClaimsSourceImpl

All Implemented Interfaces:

Serializable, ClaimSource

Direct Known Subclasses:

CodeClaimSource, FSClaimSource, HTTPHeaderClaimsSource, LDAPClaimsSource, QDLHeadersClaimsSource, TestClaimSource

public class BasicClaimsSourceImpl
extends Object
implements ClaimSource

The most basic implementation of a ClaimSource.

Extending this class

If you want to write your own custom Java claim source and invoke it, you must extend this class and over-right the realProcessing(JSONObject, HttpServletRequest, ServiceTransaction) method. Generally when claims are being gotten, the configuration that is created is passed along faithfully and you may access your custom parameters by invoking ClaimSourceConfiguration.getProperty(String). An example is in TestClaimSource.

Created by Jeff Gaynor
on 8/17/15 at 4:10 PM

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupHandler	groupHandler

Constructor Summary

Constructors

Constructor	Description
BasicClaimsSourceImpl()
BasicClaimsSourceImpl(OA2SE oa2SE)
BasicClaimsSourceImpl(org.qdl_lang.variables.QDLStem stem)
BasicClaimsSourceImpl(org.qdl_lang.variables.QDLStem stem, OA2SE oa2SE)

Method Summary

Modifier and Type	Method	Description
protected void	addToStem(org.qdl_lang.variables.QDLStem stem, String key, Object value)
void	fromQDL(org.qdl_lang.variables.QDLStem stem)	Deserialize this claim source from its QDL representation.
Collection<String>	getClaims()	returns a (unique) collection of claims.
ClaimSourceConfiguration	getConfiguration()
GroupHandler	getGroupHandler()
OA2SE	getOa2SE()	Optionally, the service environment may be injected into a scope handler to get configuration of components, e.g.
List<String>	getOmitList()	This is the list of claims from the headers to omit.
Collection<String>	getScopes()	A list of scopes that this source supports.
boolean	hasConfiguration()
boolean	isEnabled()
boolean	isRunOnlyAtAuthorization()	This should usually be false.
net.sf.json.JSONObject	process(net.sf.json.JSONObject claims, javax.servlet.http.HttpServletRequest request, ServiceTransaction transaction)	This also just returns the UserInfo object passed in.
net.sf.json.JSONObject	process(net.sf.json.JSONObject claims, ServiceTransaction transaction)	At the most basic level, this just returns the UserInfo object passed to it.
protected net.sf.json.JSONObject	realProcessing(net.sf.json.JSONObject claims, javax.servlet.http.HttpServletRequest request, ServiceTransaction transaction)	This is the actual place to put your code that only processes the claim source.
void	setConfiguration(ClaimSourceConfiguration configuration)	This passes in a JSONObject that is in turn used to configure the source.
void	setGroupHandler(GroupHandler groupHandler)
void	setOa2SE(OA2SE oa2SE)
void	setOmitList(List<String> omitList)
void	setScopes(Collection<String> scopes)	Set the scopes for this source.
org.qdl_lang.variables.QDLStem	toQDL()	Serialize this claim source to its QDL representation.

Methods inherited from class java.lang.Object

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

Field Detail

groupHandler

protected GroupHandler groupHandler

Constructor Detail

BasicClaimsSourceImpl

public BasicClaimsSourceImpl(OA2SE oa2SE)

BasicClaimsSourceImpl

public BasicClaimsSourceImpl()

BasicClaimsSourceImpl

public BasicClaimsSourceImpl(org.qdl_lang.variables.QDLStem stem)

BasicClaimsSourceImpl

public BasicClaimsSourceImpl(org.qdl_lang.variables.QDLStem stem,
                             OA2SE oa2SE)

Method Detail

getOmitList

public List<String> getOmitList()

This is the list of claims from the headers to omit. In other words, this module will reject these out of hand and never return them in a claims object. This is extremely useful in not having existing claims being over-written (which can happen if something like mod_auth_openidc is acting as an intermediary and adding spurious claims.)

Returns:

setOmitList

public void setOmitList(List<String> omitList)

setConfiguration

public void setConfiguration(ClaimSourceConfiguration configuration)

Description copied from interface: ClaimSource

This passes in a JSONObject that is in turn used to configure the source. It is up to the implementaton to make sense of this.

Specified by:

setConfiguration in interface ClaimSource

getConfiguration

public ClaimSourceConfiguration getConfiguration()

Specified by:

getConfiguration in interface ClaimSource

hasConfiguration

public boolean hasConfiguration()

Specified by:

hasConfiguration in interface ClaimSource

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ClaimSource

getOa2SE

public OA2SE getOa2SE()

Optionally, the service environment may be injected into a scope handler to get configuration of components, e.g.

Returns:

setOa2SE

public void setOa2SE(OA2SE oa2SE)

getScopes

public Collection<String> getScopes()

Description copied from interface: ClaimSource

A list of scopes that this source supports. Any scope that is not recognized by this source should be rejected.

Specified by:

getScopes in interface ClaimSource

Returns:

process

public net.sf.json.JSONObject process(net.sf.json.JSONObject claims,
                                      ServiceTransaction transaction)
                               throws UnsupportedScopeException

At the most basic level, this just returns the UserInfo object passed to it. Override as you deem fit.

Specified by:

process in interface ClaimSource

Parameters:

claims -

transaction -

Returns:

Throws:

UnsupportedScopeException

process

public net.sf.json.JSONObject process(net.sf.json.JSONObject claims,
                                      javax.servlet.http.HttpServletRequest request,
                                      ServiceTransaction transaction)
                               throws UnsupportedScopeException

This also just returns the UserInfo object passed in. This has some legacy code. If you are writing a custom claim source, you really only need to invoke realProcessing(JSONObject, HttpServletRequest, ServiceTransaction) at the right time.

Specified by:

process in interface ClaimSource

Parameters:

claims -

request -

transaction -

Returns:

Throws:

UnsupportedScopeException

getGroupHandler

public GroupHandler getGroupHandler()

setGroupHandler

public void setGroupHandler(GroupHandler groupHandler)

realProcessing

protected net.sf.json.JSONObject realProcessing(net.sf.json.JSONObject claims,
                                                javax.servlet.http.HttpServletRequest request,
                                                ServiceTransaction transaction)
                                         throws UnsupportedScopeException

This is the actual place to put your code that only processes the claim source. The process(JSONObject, HttpServletRequest, ServiceTransaction) calls wrap this and invoke the pre/post processor for you. Your code should take whatever metadata is for the user and add it to the claims object.

Parameters:

claims -

request -

transaction -

Returns:

Throws:

UnsupportedScopeException

setScopes

public void setScopes(Collection<String> scopes)

Description copied from interface: ClaimSource

Set the scopes for this source.

Specified by:

setScopes in interface ClaimSource

getClaims

public Collection<String> getClaims()

returns a (unique) collection of claims.

Specified by:

getClaims in interface ClaimSource

Returns:

isRunOnlyAtAuthorization

public boolean isRunOnlyAtAuthorization()

This should usually be false. It is true only for those sources that can ONLY run at authorization, such as HTTPHeaderClaimsSource, where the information is simply not available in later phases.

Specified by:

isRunOnlyAtAuthorization in interface ClaimSource

Returns:

fromQDL

public void fromQDL(org.qdl_lang.variables.QDLStem stem)

Description copied from interface: ClaimSource

Deserialize this claim source from its QDL representation.

Specified by:

fromQDL in interface ClaimSource

toQDL

public org.qdl_lang.variables.QDLStem toQDL()

Description copied from interface: ClaimSource

Serialize this claim source to its QDL representation.

Specified by:

toQDL in interface ClaimSource

Returns:

addToStem

protected void addToStem(org.qdl_lang.variables.QDLStem stem,
                         String key,
                         Object value)