org.codice.ddf.security.claims.attributequery.common

Class AttributeQueryClaimsHandler

java.lang.Object

org.codice.ddf.security.claims.attributequery.common.AttributeQueryClaimsHandler

All Implemented Interfaces:

org.apache.cxf.sts.claims.ClaimsHandler

public class AttributeQueryClaimsHandler
extends Object
implements org.apache.cxf.sts.claims.ClaimsHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	destination
protected static String	ERROR_RETRIEVING_ATTRIBUTES
protected String	externalAttributeStoreUrl
protected String	issuer
protected SimpleSign	simpleSign

Constructor Summary

Constructors

Constructor and Description
AttributeQueryClaimsHandler()

Method Summary

Modifier and Type	Method and Description
protected AttributeQueryClient	createAttributeQueryClient(SimpleSign simpleSign, String externalAttributeStoreUrl, String issuer, String destination) Creates a client to interface with an external attribute store via an AttributeQuery request.
protected org.apache.cxf.sts.claims.ProcessedClaimCollection	createClaims(org.apache.cxf.sts.claims.ProcessedClaimCollection claimsCollection, org.opensaml.saml.saml2.core.Assertion assertion) Creates claims from the extracted attributes.
protected Dispatch<StreamSource>	createDispatcher(Service service) Creates a dispatcher for dispatching requests.
protected Service	createService() Creates a dynamic service from the provided wsdl location.
protected org.apache.cxf.sts.claims.ProcessedClaim	createSingleValuedClaim(String claimType, String claimValue) Creates a single valued claim.
protected org.apache.cxf.sts.claims.ProcessedClaimCollection	getAttributes(String nameId) Gets the attributes for the supplied user from the external attribute store.
protected String	getNameId(Principal principal) Retrieve the name from the principal.
List<URI>	getSupportedClaimTypes() Gets the supported claim types.
org.apache.cxf.sts.claims.ProcessedClaimCollection	retrieveClaimValues(org.apache.cxf.rt.security.claims.ClaimCollection claims, org.apache.cxf.sts.claims.ClaimsParameters parameters) Retrieves claims from the external attribute store.
void	setAttributeMapLocation(String attributeMapLocation)
void	setDestination(String destination)
void	setEncryptionProperties(Object encryptionProperties)
void	setExternalAttributeStoreUrl(String externalAttributeStoreUrl)
void	setIssuer(String issuer)
void	setPortName(String portName)
void	setServiceName(String serviceName)
void	setSignatureProperties(Object signatureProperties)
void	setSimpleSign(SimpleSign simpleSign)
void	setSupportedClaims(List<String> supportedClaims)
void	setWsdlLocation(String wsdlLocation)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_RETRIEVING_ATTRIBUTES

protected static final String ERROR_RETRIEVING_ATTRIBUTES

See Also:

Constant Field Values

simpleSign

protected SimpleSign simpleSign

externalAttributeStoreUrl

protected String externalAttributeStoreUrl

issuer

protected String issuer

destination

protected String destination

Constructor Detail

AttributeQueryClaimsHandler

public AttributeQueryClaimsHandler()

Method Detail

getSupportedClaimTypes

public List<URI> getSupportedClaimTypes()

Gets the supported claim types.

Specified by:

getSupportedClaimTypes in interface org.apache.cxf.sts.claims.ClaimsHandler

Returns:

List of supported claims.

retrieveClaimValues

public org.apache.cxf.sts.claims.ProcessedClaimCollection retrieveClaimValues(org.apache.cxf.rt.security.claims.ClaimCollection claims,
                                                                              org.apache.cxf.sts.claims.ClaimsParameters parameters)

Retrieves claims from the external attribute store.

Specified by:

retrieveClaimValues in interface org.apache.cxf.sts.claims.ClaimsHandler

Parameters:

claims - The collection of claims.

Returns:

The collection of claims or an empty collection if there are no security claims.

Throws:

URISyntaxException

getNameId

protected String getNameId(Principal principal)

Retrieve the name from the principal.

Parameters:

principal - of the user.

Returns:

CN of the user.

getAttributes

protected org.apache.cxf.sts.claims.ProcessedClaimCollection getAttributes(String nameId)
                                                                    throws URISyntaxException

Gets the attributes for the supplied user from the external attribute store. Returns null if the AttributeQueryClient is null.

Parameters:

nameId - used for the request.

Returns:

The collection of attributes retrieved from the external attribute store.

Throws:

URISyntaxException

createClaims

protected org.apache.cxf.sts.claims.ProcessedClaimCollection createClaims(org.apache.cxf.sts.claims.ProcessedClaimCollection claimsCollection,
                                                                          org.opensaml.saml.saml2.core.Assertion assertion)
                                                                   throws URISyntaxException

Creates claims from the extracted attributes.

Parameters:

claimsCollection - The collection of claims.

assertion - Assertion from the response.

Returns:

The collection of claims.

Throws:

URISyntaxException

createSingleValuedClaim

protected org.apache.cxf.sts.claims.ProcessedClaim createSingleValuedClaim(String claimType,
                                                                           String claimValue)
                                                                    throws URISyntaxException

Creates a single valued claim.

Parameters:

claimType - The claim type.

claimValue - The claim value.

Returns:

The claim.

Throws:

URISyntaxException

createAttributeQueryClient

protected AttributeQueryClient createAttributeQueryClient(SimpleSign simpleSign,
                                                          String externalAttributeStoreUrl,
                                                          String issuer,
                                                          String destination)

Creates a client to interface with an external attribute store via an AttributeQuery request.

Parameters:

simpleSign - to create signature for request

externalAttributeStoreUrl - endpoint of external web service

issuer - of request

destination - of request

Returns:

AttributeQueryClient

createService

protected Service createService()

Creates a dynamic service from the provided wsdl location.

createDispatcher

protected Dispatch<StreamSource> createDispatcher(Service service)

Creates a dispatcher for dispatching requests.

setSignatureProperties

public void setSignatureProperties(Object signatureProperties)

setEncryptionProperties

public void setEncryptionProperties(Object encryptionProperties)

setWsdlLocation

public void setWsdlLocation(String wsdlLocation)

setServiceName

public void setServiceName(String serviceName)

setPortName

public void setPortName(String portName)

setSimpleSign

public void setSimpleSign(SimpleSign simpleSign)

setExternalAttributeStoreUrl

public void setExternalAttributeStoreUrl(String externalAttributeStoreUrl)

setIssuer

public void setIssuer(String issuer)

setDestination

public void setDestination(String destination)

setAttributeMapLocation

public void setAttributeMapLocation(String attributeMapLocation)

setSupportedClaims

public void setSupportedClaims(List<String> supportedClaims)