org.wso2.balana
Class AbstractObligation

java.lang.Object
  extended by org.wso2.balana.AbstractObligation
Direct Known Subclasses:
Obligation, ObligationExpression

public abstract class AbstractObligation
extends Object

Represents ObligationType in the XACML 2.0 and ObligationExpressionType in the XACML 2.0 policy schema. AbstractObligation class has been written to provide a unique interface for both XACML 2.0 and XACML 3.0


Field Summary
protected  int fulfillOn
          effect that will cause this obligation to be included in a response
protected  URI obligationId
          Identifier that uniquely identify the Obligation or ObligationExpression element
 
Constructor Summary
AbstractObligation()
           
 
Method Summary
abstract  void encode(StringBuilder builder)
          Encodes this ObligationResult into its XML form and writes this out to the provided StringBuilder
abstract  ObligationResult evaluate(EvaluationCtx ctx)
          Evaluates obligation and creates the results
 int getFulfillOn()
          Returns effect that will cause this obligation to be included in a response
 URI getId()
          Returns the id of this obligation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

obligationId

protected URI obligationId
Identifier that uniquely identify the Obligation or ObligationExpression element


fulfillOn

protected int fulfillOn
effect that will cause this obligation to be included in a response

Constructor Detail

AbstractObligation

public AbstractObligation()
Method Detail

evaluate

public abstract ObligationResult evaluate(EvaluationCtx ctx)
Evaluates obligation and creates the results

Parameters:
ctx - EvaluationCtx
Returns:
ObligationResult

getFulfillOn

public int getFulfillOn()
Returns effect that will cause this obligation to be included in a response

Returns:
the fulfillOn effect

getId

public URI getId()
Returns the id of this obligation

Returns:
the id

encode

public abstract void encode(StringBuilder builder)
Encodes this ObligationResult into its XML form and writes this out to the provided StringBuilder

Parameters:
builder - string stream into which the XML-encoded data is written


Copyright © 2015 WSO2. All rights reserved.