oracle.communication.brm.charging.extensions.client

Interface PostChargingExtensionContext

All Superinterfaces:

BaseRatingExtensionContext, ExtensionContext, PostRatingChargingExtensionContext, SharingExtensionContext

public interface PostChargingExtensionContext
extends PostRatingChargingExtensionContext

Post charging extension hook invoked as a part of charging flow to execute the post charging custom extension code.

Since:

11.2.0.6

Method Summary

Modifier and Type	Method and Description
void	addCustomDataToResponse(java.util.Map<java.lang.String,java.lang.String> customDataMap) Adds custom name value pair to be passed in the response.
void	addExtendedRedirectAddress(java.lang.String redirectAddress) To add Extended redirection information i.e.
void	addExtendedRedirectType(java.lang.String redirectType) To add Extended redirection information i.e.
void	addExtendedRedirectValidity(java.lang.Long redirectValidity) To add Extended redirection information i.e.
java.util.Map<java.lang.String,ExtensionBalance>	getBalances() Gets the customer's Balances
java.util.Map<java.lang.String,ExtensionBillingUnit>	getBillingUnits() Gets the customer's billing unit
ExtensionServiceContext	getExtensionServiceContext() To get the extension service context
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,OverageDetailsImpl>>	getOverageDetailsMap() Gets the overage data in the response for this request.
java.util.List<ExtensionBalance>	getOwnerBalances() Get owner balances.
java.util.Map<java.lang.String,ExtensionProduct>	getProducts() Gets the customer's products
java.util.Map<java.lang.String,java.lang.String>	getResponseCustomData() Gets the custom data appended in the response for this request.
java.util.List<ExtensionProduct>	getSharedProducts() Get shared products.
void	markAsRejectResponse() If invoked this request will be rejected with Failure status in OnlineResponse.
void	sendCustomBrmOpCodeEventNotification(java.util.Map<java.lang.String,java.lang.String> customEventNotificationDataMap, java.lang.String opCode, java.lang.String externalReference) Method to set the custom data along with the opcode by the custom extension code to invoke the Custom Flist from the BRM gateway extension
void	sendCustomEventNotification(java.util.Map<java.lang.String,java.lang.String> customEventNotificationDataMap) Send custom data map via "CUSTOM_EVENT" through JMS similar to any other external notification.
void	sendGenericRarNotification(boolean flag) Send a "RAR_NOTIFICATION_EVENT" notification through JMS.
void	sendRarForSharedBalancesNotification(boolean flag)
void	sendRarNotification(boolean flag) Send a "RAR_NOTIFICATION_EVENT" notification through JMS.

Methods inherited from interface oracle.communication.brm.charging.extensions.client.PostRatingChargingExtensionContext

getBalance, getCustomer, getImpactedBalance, getProduct, getRatedQuantityPerRum, getRatingPeriods, getSharingCustomerIds, getSharingProductIds, getSubscriberPreferences, getTaxSupplierId

Methods inherited from interface oracle.communication.brm.charging.extensions.client.BaseRatingExtensionContext

getApplicableProduct, getBalance, getBillingUnit, getCustomer, getCustomRatedEventFields, getEventZone, getPayloadMutator, getProduct, getQuotaAttributes, getSharedProfiles, getSubscriberPreferences, getTerminatingCustomer, getTerminatingCustomerProduct, getTerminatingCustomerRatingProfiles, getTerminatingProductRatingProfiles, getUsageRequest, isInConsumedRating, isMidSessionCdrConditionMet, setQuotaAttribute, setQuotaHoldingTime, setVolumeQuotaThreshold

Methods inherited from interface oracle.communication.brm.charging.extensions.framework.ExtensionContext

getConfigurationBeanRepository, getExtensionsDataRepository, getLogger, getRequestOperationsList

Methods inherited from interface oracle.communication.brm.charging.extensions.client.SharingExtensionContext

getBillingUnit, getSharingBalanceIds, getSharingBillingUnitIds

Method Detail

addCustomDataToResponse

void addCustomDataToResponse(java.util.Map<java.lang.String,java.lang.String> customDataMap)

Adds custom name value pair to be passed in the response.

Parameters:

customDataMap - custom name value pair to be passed in the response

getResponseCustomData

java.util.Map<java.lang.String,java.lang.String> getResponseCustomData()

Gets the custom data appended in the response for this request.

Returns:

the custom data appended in the response for this request.

sendCustomEventNotification

void sendCustomEventNotification(java.util.Map<java.lang.String,java.lang.String> customEventNotificationDataMap)

Send custom data map via "CUSTOM_EVENT" through JMS similar to any other external notification. NOTE: If all request needs the custom data to be enriched then it preferable to add it directly to response instead of sending it via notification. Sending "CUSTOM_EVENT" data asynchronously is limited to scalability external notification framework.

Parameters:

customEventNotificationDataMap - data that will be sent asynchronously via external notification

markAsRejectResponse

void markAsRejectResponse()

If invoked this request will be rejected with Failure status in OnlineResponse.

getExtensionServiceContext

ExtensionServiceContext getExtensionServiceContext()

To get the extension service context

addExtendedRedirectType

void addExtendedRedirectType(java.lang.String redirectType)

To add Extended redirection information i.e. redirectType in customDataMap

Parameters:

redirectType - Type of redirection address (viz. URL, IPV4 or IPV6 address)

addExtendedRedirectAddress

void addExtendedRedirectAddress(java.lang.String redirectAddress)

To add Extended redirection information i.e. redirectAddress in customDataMap

Parameters:

redirectAddress - Redirect address which operator will provide (viz."http://vha.com.au/redirect/1", "http://orange.fr/redirect/1" etc)

sendRarNotification

void sendRarNotification(boolean flag)

Send a "RAR_NOTIFICATION_EVENT" notification through JMS.

Specified by:

sendRarNotification in interface PostRatingChargingExtensionContext

sendGenericRarNotification

void sendGenericRarNotification(boolean flag)

Send a "RAR_NOTIFICATION_EVENT" notification through JMS.

Specified by:

sendGenericRarNotification in interface PostRatingChargingExtensionContext

sendRarForSharedBalancesNotification

void sendRarForSharedBalancesNotification(boolean flag)

Specified by:

sendRarForSharedBalancesNotification in interface PostRatingChargingExtensionContext

addExtendedRedirectValidity

void addExtendedRedirectValidity(java.lang.Long redirectValidity)

To add Extended redirection information i.e. redirectValidity in customDataMap

Parameters:

redirectValidity - When the redirect occurs this needs to be set - it should be a configurable attribute

getProducts

java.util.Map<java.lang.String,ExtensionProduct> getProducts()

Gets the customer's products

Returns:

products keyed on product Id

getBalances

java.util.Map<java.lang.String,ExtensionBalance> getBalances()

Gets the customer's Balances

Returns:

balances keyed on balance Id

getBillingUnits

java.util.Map<java.lang.String,ExtensionBillingUnit> getBillingUnits()

Gets the customer's billing unit

Returns:

billing unit keyed on billing unit id

sendCustomBrmOpCodeEventNotification

void sendCustomBrmOpCodeEventNotification(java.util.Map<java.lang.String,java.lang.String> customEventNotificationDataMap,
                                          java.lang.String opCode,
                                          java.lang.String externalReference)

Method to set the custom data along with the opcode by the custom extension code to invoke the Custom Flist from the BRM gateway extension

Parameters:

customEventNotificationDataMap - Map that holds the custom data from the extension

opCode - Op Code which needs to be called

externalReference - externalReference

getOverageDetailsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,OverageDetailsImpl>> getOverageDetailsMap()

Gets the overage data in the response for this request.

Returns:

the overage data in the response for this request.

getOwnerBalances

java.util.List<ExtensionBalance> getOwnerBalances()

Get owner balances.

Returns:

the owner balances.

getSharedProducts

java.util.List<ExtensionProduct> getSharedProducts()

Get shared products.

Returns:

the shared products.