com.pcube.apps.engage.apply
Class RulePeer

java.lang.Object
  com.pcube.apps.engage.apply.RulePeer

public class RulePeer
extends java.lang.Object

a rule wrapper that maps the rule properties to rule's properties in the SML. Notice: some of the peer properties are read from the rule passed to the peer constructor, others like BWC index have to be set. The properties that have set methods (not read from rule) don't go through validation. BWC instance number: Multiple instances of a single BWC may exist in subscriber context. This allows to control different services separately but in the same fashion. Concurrent session counter: to enforce max number of concurrent session of services mapped to a rule the rule is assiged a session counter number.

Author:

rafis

Field Summary

static int	DEFAULT_CONDITIONAL_REDIRECT_COUNTER
static int	NO_POST_NOTIFICATION

Method Summary

com.pcube.apps.framework.newapply.FormatAdaptor	getAccessFormatAdaptor()
byte	getBlockReportActivation()
CoS	getCos()
QuotaBucketInterface	getDownQuotaBucket()
byte	getPostBreachAccessMode()
long	getPostBreachConcSessions()
long	getPostBreachDownstreamBW()
int	getPostBreachDownstreamTosId()
int	getPostBreachNotificationIdx()
long	getPostBreachUpstreamBW()
int	getPostBreachUpstreamTosId()
int	getPostConditionalRedirectCounter()
int	getPostConditionalRedirectIndex()
int	getPostDownBWCIdx()
int	getPostDownBWCInstanceNo()
int	getPostTrafficMirroringIndex()
int	getPostUpBWCIdx()
int	getPostUpBWCInstanceNo()
byte	getPreBreachAccessMode()
long	getPreBreachConcSessions()
long	getPreBreachDownstreamBW()
int	getPreBreachDownstreamTosId()
long	getPreBreachUpstreamBW()
int	getPreBreachUpstreamTosId()
int	getPreConditionalRedirectCounter()
int	getPreConditionalRedirectIndex()
int	getPreDownBWCIdx()
int	getPreDownBWCInstanceNo()
int	getPreTrafficMirroringIndex()
int	getPreUpBWCIdx()
int	getPreUpBWCInstanceNo()
int	getSessionCounterIdx() Concurrent session counter
QuotaBucketInterface	getSessionQuotaBucket()
QuotaBucketInterface	getUpQuotaBucket()
boolean	isNoChangeInPostBreach()
boolean	isPostBeachNotificationEnabled()
boolean	isRtSignalingRdrEnabled()
boolean	isTrUsageReportEnabled()
void	setPostBreachDownstreamTosId(int markerId)
void	setPostBreachUpstreamTosId(int markerId)
void	setPostConditionalRedirectCounter(int postConditionalRedirectCounter)
void	setPostConditionalRedirectIndex(int postConditionalRedirectIndex)
void	setPostTrafficMirroringIndex(int postTrafficMirroringIndex)
void	setPreBreachDownstreamTosId(int markerId)
void	setPreBreachUpstreamTosId(int markerId)
void	setPreConditionalRedirectCounter(int preConditionalRedirectCounter)
void	setPreConditionalRedirectIndex(int preConditionalRedirectIndex)
void	setPreTrafficMirroringIndex(int preTrafficMirroringIndex)

Methods inherited from class java.lang.Object

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

Field Detail

NO_POST_NOTIFICATION

public static final int NO_POST_NOTIFICATION

See Also:

Constant Field Values

DEFAULT_CONDITIONAL_REDIRECT_COUNTER

public static final int DEFAULT_CONDITIONAL_REDIRECT_COUNTER

See Also:

Constant Field Values

Method Detail

getCos

public CoS getCos()

Returns:

getDownQuotaBucket

public QuotaBucketInterface getDownQuotaBucket()

Returns:

getPostBreachAccessMode

public byte getPostBreachAccessMode()

Returns:

one of the below options. notice that the mode ACCESS_NO_CHANGE_IN_ACTIVE_ACTIONS is replaced with ADMIT and the other post pars get the pre-breach values.

See Also:

Rule.ACCESS_ADMIT, Rule.ACCESS_BLOCK, Rule.ACCESS_BLOCK_AND_REDIRECT

getPostBreachConcSessions

public long getPostBreachConcSessions()

Returns:

getPostBreachDownstreamBW

public long getPostBreachDownstreamBW()

Returns:

isNoChangeInPostBreach

public boolean isNoChangeInPostBreach()

Returns:

true if active actions don't change in post breach

getPostDownBWCIdx

public int getPostDownBWCIdx()

Returns:

the index in the global bwc pool of the post breach downstream BWC

getPostDownBWCInstanceNo

public int getPostDownBWCInstanceNo()

Returns:

the instance number of the post breach downstream BWC

getPostBreachNotificationIdx

public int getPostBreachNotificationIdx()
                                 throws ApplyException

Returns:

the index in the notification array of the subscriber notification to activate when breach occures. returns NO_POST_NOTIFICATION if notifications are disabled.

Throws:

ApplyExcepion

ApplyException

getPostBreachUpstreamBW

public long getPostBreachUpstreamBW()

Returns:

getPostUpBWCIdx

public int getPostUpBWCIdx()

Returns:

the index in the global bwc pool of the post breach upstream BWC

getPostUpBWCInstanceNo

public int getPostUpBWCInstanceNo()

Returns:

the instance number of the post breach upstream BWC

getPreBreachAccessMode

public byte getPreBreachAccessMode()

Returns:

See Also:

Rule.ACCESS_ADMIT, Rule.ACCESS_BLOCK, Rule.ACCESS_BLOCK_AND_REDIRECT

getPreBreachConcSessions

public long getPreBreachConcSessions()

Returns:

getPreBreachDownstreamBW

public long getPreBreachDownstreamBW()

Returns:

getPreDownBWCIdx

public int getPreDownBWCIdx()

Returns:

the index in the global bwc pool of the pre breach downstream BWC

getPreDownBWCInstanceNo

public int getPreDownBWCInstanceNo()

Returns:

the instance number of the pre breach downstream BWC

getPreBreachUpstreamBW

public long getPreBreachUpstreamBW()

Returns:

getPreUpBWCIdx

public int getPreUpBWCIdx()

Returns:

the index in the global bwc pool of the pre breach upstream BWC

getPreUpBWCInstanceNo

public int getPreUpBWCInstanceNo()

Returns:

the instance number of the pre breach upstream BWC

getUpQuotaBucket

public QuotaBucketInterface getUpQuotaBucket()

Returns:

isPostBeachNotificationEnabled

public boolean isPostBeachNotificationEnabled()

Returns:

getSessionCounterIdx

public int getSessionCounterIdx()

Concurrent session counter

Returns:

Returns the sessionCounterIdx.

getBlockReportActivation

public byte getBlockReportActivation()

Returns:

if and when to generate block RDRs

See Also:

Rule.BLOCK_REPORT_DONT_GENERATE, Rule.BLOCK_REPORT_ON_ACCESS_BLOCK, Rule.BLOCK_REPORT_ON_BOTH_ACCESS_AND_CONC_SESSIONS, Rule.BLOCK_REPORT_ON_CONC_SESSION

isTrUsageReportEnabled

public boolean isTrUsageReportEnabled()

Returns:

true if transaction usage RDRs are enabled for this rule

isRtSignalingRdrEnabled

public boolean isRtSignalingRdrEnabled()

getSessionQuotaBucket

public QuotaBucketInterface getSessionQuotaBucket()

Returns:

setPostBreachDownstreamTosId

public void setPostBreachDownstreamTosId(int markerId)

setPostBreachUpstreamTosId

public void setPostBreachUpstreamTosId(int markerId)

setPreBreachDownstreamTosId

public void setPreBreachDownstreamTosId(int markerId)

setPreBreachUpstreamTosId

public void setPreBreachUpstreamTosId(int markerId)

getPostBreachDownstreamTosId

public int getPostBreachDownstreamTosId()

getPostBreachUpstreamTosId

public int getPostBreachUpstreamTosId()

getPreBreachDownstreamTosId

public int getPreBreachDownstreamTosId()

getPreBreachUpstreamTosId

public int getPreBreachUpstreamTosId()

setPreTrafficMirroringIndex

public void setPreTrafficMirroringIndex(int preTrafficMirroringIndex)

getPreTrafficMirroringIndex

public int getPreTrafficMirroringIndex()

setPostTrafficMirroringIndex

public void setPostTrafficMirroringIndex(int postTrafficMirroringIndex)

getPostTrafficMirroringIndex

public int getPostTrafficMirroringIndex()

setPreConditionalRedirectIndex

public void setPreConditionalRedirectIndex(int preConditionalRedirectIndex)

getPreConditionalRedirectIndex

public int getPreConditionalRedirectIndex()

setPostConditionalRedirectIndex

public void setPostConditionalRedirectIndex(int postConditionalRedirectIndex)

getPostConditionalRedirectIndex

public int getPostConditionalRedirectIndex()

getPreConditionalRedirectCounter

public int getPreConditionalRedirectCounter()

setPreConditionalRedirectCounter

public void setPreConditionalRedirectCounter(int preConditionalRedirectCounter)

getPostConditionalRedirectCounter

public int getPostConditionalRedirectCounter()

setPostConditionalRedirectCounter

public void setPostConditionalRedirectCounter(int postConditionalRedirectCounter)

getAccessFormatAdaptor

public com.pcube.apps.framework.newapply.FormatAdaptor getAccessFormatAdaptor()