com.opencloud.sentinel.charging

Interface ReservationChargingInstance

All Superinterfaces:

ChargingInstance

public interface ReservationChargingInstance
extends ChargingInstance

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReservationChargingInstance.CreditResultExecutionPhase

Nested classes/interfaces inherited from interface com.opencloud.sentinel.charging.ChargingInstance

ChargingInstance.ChargingType, ChargingInstance.Instruction, ChargingInstance.State

Method Summary

Methods

Modifier and Type	Method and Description
void	doCreditFinalisation(ReportingReason reason) Instructs the core to finalise the current charging session if a session is active, and call the feature if response-CCA arrives.
void	doCreditReservation(ReportingReason reason, ReservationChargingInstance.CreditResultExecutionPhase phase) Instructs the charging instance to initiate a credit reservation, send an update or perform a reauthorisation
void	doCreditReservation(ReservationChargingInstance.CreditResultExecutionPhase phase) Instructs the charging instance to initiate a credit reservation, send an update or perform a reauthorisation
void	enableReplication() Enables persistent state replication for the underlying Diameter Activity.
java.lang.String	getOwner() Gets the URI string of the node that currently owns this instance.
java.lang.String	getTrackingKey() Gets the tracking key of the charging session for this instance.
void	setOwner(java.lang.String ownerUri) Sets the URI string of the node that currently owns this instance.

Methods inherited from interface com.opencloud.sentinel.charging.ChargingInstance

clearInstruction, getChargingState, getChargingType, getName, getPendingChargingInstruction, getPendingReportingReason, getSessionCounters, isCreditCheckInProgress, isSuspended, resume, suspend

Method Detail

doCreditReservation

void doCreditReservation(ReportingReason reason,
                       ReservationChargingInstance.CreditResultExecutionPhase phase)
                         throws InstructionAlreadyPendingException,
                                ChargingInstanceAlreadyFinalisedException,
                                CreditCheckAlreadyInProgressException

Instructs the charging instance to initiate a credit reservation, send an update or perform a reauthorisation

Parameters:

reason - Reason for credit reservation.

phase - The phase in which the Post CC execution point should be raised

Throws:

InstructionAlreadyPendingException - if there is already an instruction pending

ChargingInstanceAlreadyFinalisedException - if the charging instance is already finalised.

CreditCheckAlreadyInProgressException

doCreditReservation

void doCreditReservation(ReservationChargingInstance.CreditResultExecutionPhase phase)
                         throws InstructionAlreadyPendingException,
                                ChargingInstanceAlreadyFinalisedException,
                                CreditCheckAlreadyInProgressException

Instructs the charging instance to initiate a credit reservation, send an update or perform a reauthorisation

Parameters:

phase - The phase in which the Post CC execution point should be raised

Throws:

InstructionAlreadyPendingException - if there is already an instruction pending

ChargingInstanceAlreadyFinalisedException - if the charging instance is already finalised.

CreditCheckAlreadyInProgressException - if there is already a credit check in progress

doCreditFinalisation

void doCreditFinalisation(ReportingReason reason)
                          throws InstructionAlreadyPendingException,
                                 ChargingInstanceAlreadyFinalisedException,
                                 CreditCheckAlreadyInProgressException

Instructs the core to finalise the current charging session if a session is active, and call the feature if response-CCA arrives.

Parameters:

reason - Reason for credit finalisation.

Throws:

InstructionAlreadyPendingException - if there is already an instruction pending

ChargingInstanceAlreadyFinalisedException - if the charging instance is already finalised.

CreditCheckAlreadyInProgressException - if there is already a credit check in progress.

getTrackingKey

java.lang.String getTrackingKey()

Gets the tracking key of the charging session for this instance.

Returns:

The tracking key of the charging session for this instance.

enableReplication

void enableReplication()

Enables persistent state replication for the underlying Diameter Activity. Once enabled, replication cannot be disabled so there is no corresponding disableReplication method.

getOwner

java.lang.String getOwner()

Gets the URI string of the node that currently owns this instance.

Returns:

The URI of the node that owns this instance (as a String).

setOwner

void setOwner(java.lang.String ownerUri)

Sets the URI string of the node that currently owns this instance.

Parameters:

ownerUri - The URI string for the new owner for this instance.