org.apereo.cas.authentication.support

Class AbstractProtocolAttributeEncoder

java.lang.Object

org.apereo.cas.authentication.support.AbstractProtocolAttributeEncoder

All Implemented Interfaces:

ProtocolAttributeEncoder

Direct Known Subclasses:

DefaultCasProtocolAttributeEncoder

public abstract class AbstractProtocolAttributeEncoder
extends java.lang.Object
implements ProtocolAttributeEncoder

Abstract class to define common attribute encoding operations.

Since:

4.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ServicesManager	servicesManager The Services manager.

Constructor Summary

Constructors

Constructor and Description
AbstractProtocolAttributeEncoder(ServicesManager servicesManager) Instantiates a new attribute encoder with the default cipher as DefaultRegisteredServiceCipherExecutor.
AbstractProtocolAttributeEncoder(ServicesManager servicesManager, RegisteredServiceCipherExecutor cipherExecutor) Instantiates a new Abstract cas attribute encoder.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	encodeAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes, RegisteredService registeredService) Encodes attributes that are ready to be released.
protected abstract void	encodeAttributesInternal(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.String,java.lang.String> cachedAttributesToEncode, RegisteredServiceCipherExecutor cipher, RegisteredService registeredService) Initialize the cipher with the public key and then start to encrypt select attributes.
protected java.util.Map<java.lang.String,java.lang.String>	initialize(java.util.Map<java.lang.String,java.lang.Object> attributes) Initialize the encoding process.
void	setCipherExecutor(RegisteredServiceCipherExecutor cipherExecutor)

Methods inherited from class java.lang.Object

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

Field Detail

servicesManager

protected ServicesManager servicesManager

The Services manager.

Constructor Detail

AbstractProtocolAttributeEncoder

public AbstractProtocolAttributeEncoder(ServicesManager servicesManager)

Instantiates a new attribute encoder with the default cipher as DefaultRegisteredServiceCipherExecutor.

Parameters:

servicesManager - the services manager

AbstractProtocolAttributeEncoder

public AbstractProtocolAttributeEncoder(ServicesManager servicesManager,
                                        RegisteredServiceCipherExecutor cipherExecutor)

Instantiates a new Abstract cas attribute encoder.

Parameters:

servicesManager - the services manager

cipherExecutor - the cipher executor

Method Detail

encodeAttributes

public java.util.Map<java.lang.String,java.lang.Object> encodeAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                         RegisteredService registeredService)

Description copied from interface: ProtocolAttributeEncoder

Encodes attributes that are ready to be released. Typically, this method tries to ensure that the PGT and the credential password are correctly encrypted before they are released. Attributes should not be filtered and removed and it is assumed that all will be returned back to the service.

Specified by:

encodeAttributes in interface ProtocolAttributeEncoder

Parameters:

attributes - The attribute collection that is ready to be released

registeredService - the requesting service for which attributes are to be encoded

Returns:

collection of attributes after encryption ready for release.

encodeAttributesInternal

protected abstract void encodeAttributesInternal(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                 java.util.Map<java.lang.String,java.lang.String> cachedAttributesToEncode,
                                                 RegisteredServiceCipherExecutor cipher,
                                                 RegisteredService registeredService)

Initialize the cipher with the public key and then start to encrypt select attributes.

Parameters:

attributes - the attributes

cachedAttributesToEncode - the cached attributes to encode

cipher - the cipher object initialized per service public key

registeredService - the registered service

initialize

protected java.util.Map<java.lang.String,java.lang.String> initialize(java.util.Map<java.lang.String,java.lang.Object> attributes)

Initialize the encoding process. Removes the CasViewConstants.MODEL_ATTRIBUTE_NAME_PRINCIPAL_CREDENTIAL and CasViewConstants.MODEL_ATTRIBUTE_NAME_PROXY_GRANTING_TICKET from the authentication attributes originally and into a cache object, so it can later on be encrypted if needed.

Parameters:

attributes - the new encoded attributes

Returns:

a map of attributes that are to be encoded and encrypted

setCipherExecutor

public void setCipherExecutor(RegisteredServiceCipherExecutor cipherExecutor)