org.wso2.balana.combine

Class CombiningAlgorithm

java.lang.Object

org.wso2.balana.combine.CombiningAlgorithm

Direct Known Subclasses:

PolicyCombiningAlgorithm, RuleCombiningAlgorithm

public abstract class CombiningAlgorithm
extends Object

The base type for all combining algorithms. It provides one method that must be implemented.

Since:

1.0

Author:

Seth Proctor

Constructor Summary

Constructors

Constructor and Description
CombiningAlgorithm(URI identifier) Constructor that takes the algorithm's identifier.

Method Summary

Modifier and Type	Method and Description
abstract AbstractResult	combine(EvaluationCtx context, List parameters, List inputs) Combines the results of the inputs based on the context to produce some unified result.
URI	getIdentifier() Returns the identifier for this algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombiningAlgorithm

public CombiningAlgorithm(URI identifier)

Constructor that takes the algorithm's identifier.

Parameters:

identifier - the algorithm's identifier

Method Detail

combine

public abstract AbstractResult combine(EvaluationCtx context,
                                       List parameters,
                                       List inputs)

Combines the results of the inputs based on the context to produce some unified result. This is the one function of a combining algorithm.

Parameters:

context - the representation of the request

parameters - a (possibly empty) non-null List of CombinerParameters provided for general use (for all pre-2.0 policies this must be empty)

inputs - a List of CombinerElementss to evaluate and combine

Returns:

a single unified result based on the combining logic

getIdentifier

public URI getIdentifier()

Returns the identifier for this algorithm.

Returns:

the algorithm's identifier