oracle.communication.brm.charging.sdk

Class AbstractSampleProgram

java.lang.Object

oracle.communication.brm.charging.sdk.AbstractSampleProgram

Direct Known Subclasses:

SampleAccountingOnOff, SampleAuthenticationQuery, SampleBalanceQueryRequestLauncher, SampleDataSession, SampleDebitRefundSession, SampleExternalTopUpRequestLauncher, SampleGenericSameSession, SampleGenericSession, SampleGenericSessionWithUsageDirection, SampleGprsSession, SampleIncrementalUsageRequestLauncher, SamplePolicySessionRequestLauncher, SamplePriceEnquiry, SampleQueryLauncher, SampleSpendingLimitReportRequestLauncher, SampleStartUpdateAccountingRequestLauncher, SampleSubscribeNotificationRequestLauncher, SampleSubscriberPreferenceUpdateRequestLauncher, SampleUserDataRequestLauncher, SampleVoiceSession

public abstract class AbstractSampleProgram
extends java.lang.Object

Abstract class that sample programs should extend

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractSampleProgram.SampleResponseConsumer<T extends Response<?>> Response consumer for the requests send by the AbstractSampleProgram

Constructor Summary

Constructors

Constructor and Description
AbstractSampleProgram() Constructor takes care of retrieving spring beans

Method Summary

Modifier and Type	Method and Description
Payload	createDefaultPayLoad(UsageRequestBuilder usageRequestBuilder, java.lang.String version, java.lang.String productType, java.lang.String eventType, Usage requestType, java.lang.String calledIdStr) Creates default payload for usage request based on required blocks.
BatchRequestService	getBatchRequestService() Get the BatchRequestService
org.springframework.context.support.ClassPathXmlApplicationContext	getContext() Get the Spring context
oracle.communication.brm.charging.messages.update.ExternalTopUpUpdateRequestBuilderFactory	getExternalTopUpUpdateRequestBuilderFactory() Get the ExternalTopUpUpdateRequestBuilderFactory
static Logger	getLogger()
ManagementRequestBuilderFactory	getManagementRequestBuilderFactory() Get the Management RequestBuilderFactory
int	getNResponsesReceived() Get the number of responses received so far
PolicyRequestBuilderFactory	getPolicyRequestBuilderFactory() Get the PolicyRequestBuilderFactory
QueryRequestBuilderFactory	getQueryRequestBuilderFactory() Get the Query RequestBuilderFactory
java.util.List<Response>	getResponsesReceived() Get the responses received so far
ServiceSpecRepository	getServiceSpecRepository() Get the ServiceSpecRepository, needed for building requests
static java.lang.String	getStackTrace(java.lang.Throwable aThrowable) Stack trace formatting
oracle.communication.brm.charging.statemanager.StateManager	getStateManager() Get the StateManager
oracle.communication.brm.charging.messages.update.UpdateRequestBuilderFactory	getUpdateRequestBuilderFactory() Get the Update RequestBuilderFactory
UsageRequestBuilderFactory	getUsageRequestBuilderFactory() Get the Usage RequestBuilderFactory
void	resetResponsesReceived() Clear the list of responses received
protected void	run() Main run method that should be called in the main of all sample programs
protected abstract void	runSample() To be implemented by each sample program for specific scenario
void	sendAsynchronousRequest(Request request, boolean resubmit) Send a single request
Response	sendRequest(Request request, boolean resubmit) Send a single request, wait for a response and return this response.
protected <T extends Request> void	sendRequests(java.util.List<T> requests, boolean resubmit, long delay) Sends an array of requests, with a delay between them, waits for the responses to arrive
UpdateResponse	sendUpdateRequest(Request request, boolean resubmit) Send an update request synchronously
java.util.List<UpdateResponse>	sendUpdateRequests(java.util.List<UpdateRequest> requests, boolean resubmit) Submit a batch of update requests synchronously
void	waitForResponses(int nResponses) Wait until nResponses have been received

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSampleProgram

public AbstractSampleProgram()

Constructor takes care of retrieving spring beans

Method Detail

getStateManager

public oracle.communication.brm.charging.statemanager.StateManager getStateManager()

Get the StateManager

Returns:

the StateManager

getUsageRequestBuilderFactory

public UsageRequestBuilderFactory getUsageRequestBuilderFactory()

Get the Usage RequestBuilderFactory

Returns:

the Usage RequestBuilderFactory

getUpdateRequestBuilderFactory

public oracle.communication.brm.charging.messages.update.UpdateRequestBuilderFactory getUpdateRequestBuilderFactory()

Get the Update RequestBuilderFactory

Returns:

the Update RequestBuilderFactory

getExternalTopUpUpdateRequestBuilderFactory

public oracle.communication.brm.charging.messages.update.ExternalTopUpUpdateRequestBuilderFactory getExternalTopUpUpdateRequestBuilderFactory()

Get the ExternalTopUpUpdateRequestBuilderFactory

Returns:

the ExternalTopUpUpdateRequestBuilderFactory

getQueryRequestBuilderFactory

public QueryRequestBuilderFactory getQueryRequestBuilderFactory()

Get the Query RequestBuilderFactory

Returns:

the Query RequestBuilderFactory

getManagementRequestBuilderFactory

public ManagementRequestBuilderFactory getManagementRequestBuilderFactory()

Get the Management RequestBuilderFactory

Returns:

the Management RequestBuilderFactory

getPolicyRequestBuilderFactory

public PolicyRequestBuilderFactory getPolicyRequestBuilderFactory()

Get the PolicyRequestBuilderFactory

Returns:

the PolicyRequestBuilderFactory

getBatchRequestService

public BatchRequestService getBatchRequestService()

Get the BatchRequestService

Returns:

the BatchRequestService

getContext

public org.springframework.context.support.ClassPathXmlApplicationContext getContext()

Get the Spring context

Returns:

the Spring context

getServiceSpecRepository

public ServiceSpecRepository getServiceSpecRepository()

Get the ServiceSpecRepository, needed for building requests

Returns:

ServiceSpecRepository, needed for building requests

getResponsesReceived

public java.util.List<Response> getResponsesReceived()

Get the responses received so far

Returns:

the responses received so far

getNResponsesReceived

public int getNResponsesReceived()

Get the number of responses received so far

Returns:

the number of responses received so far

resetResponsesReceived

public void resetResponsesReceived()

Clear the list of responses received

sendRequests

protected <T extends Request> void sendRequests(java.util.List<T> requests,
                                                boolean resubmit,
                                                long delay)
                                         throws MessagesException,
                                                SystemHealthException,
                                                java.lang.InterruptedException,
                                                java.util.concurrent.ExecutionException,
                                                java.util.concurrent.TimeoutException,
                                                UserNotFoundException

Sends an array of requests, with a delay between them, waits for the responses to arrive

Type Parameters:

T - request of a specific type

Parameters:

requests - array of requests to send

resubmit - to resubmit or not

delay - delay im ms to wait between 2 asynchronous requests

Throws:

MessagesUsageException - if something goes wrong

MessagesException - something wrong with the message

SystemHealthException - unknown exception

java.lang.InterruptedException - process is interrupted

java.util.concurrent.ExecutionException - something wrong with the execution of the request

java.util.concurrent.TimeoutException - process takes too long

UserNotFoundException

waitForResponses

public void waitForResponses(int nResponses)

Wait until nResponses have been received

Parameters:

nResponses - number of responses that must be received before the method returns

sendAsynchronousRequest

public void sendAsynchronousRequest(Request request,
                                    boolean resubmit)
                             throws MessagesException,
                                    SystemHealthException,
                                    UserNotFoundException

Send a single request

Parameters:

request - request to send (should be of type UsageRequest, UpdateRequest or QueryRequest)

resubmit - to resubmit or not

Throws:

MessagesException - something wrong with the message

SystemHealthException - other exception

UserNotFoundException

sendRequest

public Response sendRequest(Request request,
                            boolean resubmit)
                     throws MessagesException,
                            SystemHealthException,
                            java.lang.InterruptedException,
                            java.util.concurrent.ExecutionException,
                            java.util.concurrent.TimeoutException,
                            UserNotFoundException

Send a single request, wait for a response and return this response. This resets the list of responses received so far.

Parameters:

request - request to send

resubmit - to resubmit or not

Returns:

the first response coming back after the request was sent

Throws:

MessagesException - something wrong with the message

SystemHealthException - unknown exception

java.lang.InterruptedException - process is interrupted

java.util.concurrent.ExecutionException - something wrong with the execution of the request

java.util.concurrent.TimeoutException - process takes too long

UserNotFoundException

sendUpdateRequest

public UpdateResponse sendUpdateRequest(Request request,
                                        boolean resubmit)
                                 throws MessagesException,
                                        java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException,
                                        java.util.concurrent.TimeoutException,
                                        UserNotFoundException

Send an update request synchronously

Parameters:

request - update request

resubmit - flag

Returns:

update response

Throws:

MessagesException - something wrong with the message

java.lang.InterruptedException - process is interrupted

java.util.concurrent.ExecutionException - something wrong with the execution of the request

java.util.concurrent.TimeoutException - process takes too long

UserNotFoundException

sendUpdateRequests

public java.util.List<UpdateResponse> sendUpdateRequests(java.util.List<UpdateRequest> requests,
                                                         boolean resubmit)
                                                  throws MessagesException,
                                                         java.lang.InterruptedException,
                                                         java.util.concurrent.ExecutionException,
                                                         java.util.concurrent.TimeoutException,
                                                         UserNotFoundException

Submit a batch of update requests synchronously

Parameters:

requests - update requests

resubmit - resubmit flag

Returns:

list of update responses

Throws:

MessagesException - if envelope creation goes wrong

java.lang.InterruptedException - process is interrupted

java.util.concurrent.ExecutionException - something wrong with the execution of the request

java.util.concurrent.TimeoutException - process takes too long

UserNotFoundException

runSample

protected abstract void runSample()
                           throws java.lang.Exception

To be implemented by each sample program for specific scenario

Throws:

java.lang.Exception - if something goes wrong in the scenario!

run

protected final void run()

Main run method that should be called in the main of all sample programs

getLogger

public static Logger getLogger()

createDefaultPayLoad

public Payload createDefaultPayLoad(UsageRequestBuilder usageRequestBuilder,
                                    java.lang.String version,
                                    java.lang.String productType,
                                    java.lang.String eventType,
                                    Usage requestType,
                                    java.lang.String calledIdStr)

Creates default payload for usage request based on required blocks.

Parameters:

usageRequestBuilder, - String version, String productType, UsageRequestBuilder

Returns:

payload instance

getStackTrace

public static java.lang.String getStackTrace(java.lang.Throwable aThrowable)

Stack trace formatting

Parameters:

aThrowable - Exception

Returns:

the stack trace as a String