Customising Diameter and SS7 CDRs

package com.opencloud.sentinel.cdr;

message DiameterChargingCdr {

// ...

extensions 50 to max;

package com.acme.sentinel.cdr;

import "com/opencloud/sentinel/cdr/base-cdr-types.proto";

// Diameter Service CDR

message DiameterChargingCdr {

    optional string subscriber = 1;
    optional int64 initiatingRequestId = 2 [default = -1];
    optional com.opencloud.sentinel.cdr.Time eventInitiated = 3;
    optional com.opencloud.sentinel.cdr.Time sessionInitiated = 4;
    optional com.opencloud.sentinel.cdr.Time sessionEnded = 5;
    optional com.opencloud.sentinel.cdr.CdrSessionCounters sessionCounters = 6;

    repeated int32 ocsLatencySamples = 19 [packed=true];
    optional string clientSessionId = 20;
    repeated string ocsSessionIDs = 21;

    optional string sentinelSelectionKey = 22;

    optional ReleaseReason releaseReason = 23;

    extensions 50 to max;

    message ReleaseReason {

        optional string cause = 1;
        optional string description = 2;
    }

}

    /**
     * Add extensions to the generated CDR
     *
     * @param cdrBuilder the protobuf builder for the CDR
     * @param intiatingCCR the CCR that initiated the session
     * @param ss the sentinel session state
     * @param facilities facilities for tracing and so on
     */

    protected void addCdrExtensions(DiameterChargingCdr.Builder cdrBuilder, CreditControlRequest intiatingCCR, SentinelDiameterSessionState ss, MapperFacilities facilities) throws MapperException {

        // to be overridden by SDK defined mappers
        // get values to include from session state
        final String releaseCause = "extensionReleaseCause";
        final String releaseDescription = "extensionReleaseDescription";

        DiameterChargingCdr.ReleaseReason.Builder rrBuilder = DiameterChargingCdr.ReleaseReason.newBuilder();
        // construct ReleaseReason field for the CDR
        rrBuilder.setCause(releaseCause);
        rrBuilder.setDescription(releaseDescription);

        cdrBuilder.setReleaseReason(rrBuilder.build());

    }

/**
 * Copyright (c) 2014 Open Cloud Limited, a company incorporated in England and Wales (Registration Number 6000941) with its principal place of business at Edinburgh House, St John's Innovation Park, Cowley Road, Cambridge CB4 0DS.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *
 * 3  The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * 4  The source code may not be used to create, develop, use or distribute software for use on any platform other than the Open Cloud Rhino and Open Cloud Rhino Sentinel platforms or any successor products.
 *
 * 5  Full license terms may be found https://developer.opencloud.com/devportal/display/OCDEV/Feature+Source+License
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF SATISFACTORY QUALITY AND FITNESS FOR A PARTICULAR PURPOSE ARE EXCLUDED TO THE FULLEST EXTENT PERMITTED BY LAW.
 *
 * TO THE FULLEST EXTENT PERMISSIBLE BY LAW, THE AUTHOR SHALL NOT BE LIABLE FOR ANY LOSS OF REVENUE, LOSS OF PROFIT, LOSS OF FUTURE BUSINESS, LOSS OF DATA OR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, PUNITIVE OR OTHER LOSS OR DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE SOFTWARE, WHETHER ARISING IN CONTRACT, TORT (INCLUDING NEGLIGENCE) MISREPRESENTATION OR OTHERWISE AND REGARDLESS OF WHETHER OPEN CLOUD HAS BEEN ADVISED OF THE POSSIBILITY OF ANY SUCH LOSS OR DAMAGE. THE AUTHORS MAXIMUM AGGREGATE LIABILITY WHETHER IN CONTRACT, TORT (INCLUDING NEGLIGENCE) OR OTHERWISE, SHALL NOT EXCEED EUR100.
 *
 * NOTHING IN THIS LICENSE SHALL LIMIT THE LIABILITY OF THE AUTHOR FOR DEATH OR PERSONAL INJURY RESULTING FROM NEGLIGENCE, FRAUD OR FRAUDULENT MISREPRESENTATION.
 *
 * Visit Open Cloud Developer's Portal for how-to guides, examples, documentation, forums and more: http://developer.opencloud.com
 */
package com.opencloud.sentinel.cdr.mapper.impl;

import com.google.protobuf.Message;
import com.opencloud.sentinel.annotations.Mapping;
import com.opencloud.sentinel.annotations.SentinelMapper;
import com.opencloud.sentinel.cdr.SentinelSs7CdrFormat.Ss7CallCdr;
import com.opencloud.sentinel.common.SentinelSs7SessionState;
import com.opencloud.sentinel.mapper.MapperException;
import com.opencloud.sentinel.mapper.MapperFacilities;
import com.opencloud.sentinel.util.LongByteArray;
import com.opencloud.slee.resources.cgin.callcontrol.CCCallInformationReportArg;
import com.opencloud.slee.resources.cgin.cap_v1.CAP1InitialDPArg;
import com.opencloud.slee.resources.cgin.cap_v2.CAP2CallInformationReportArg;
import com.opencloud.slee.resources.cgin.cap_v2.CAP2InitialDPArg;
import com.opencloud.slee.resources.cgin.cap_v3.CAP3InitialDPArg;
import com.opencloud.slee.resources.cgin.cap_v4.CAP4InitialDPArg;
import com.opencloud.slee.resources.in.datatypes.cc.LegType.EncodedValue;

/**
 * Maps {@link com.opencloud.slee.resources.cgin.cap_v1.CAP1InitialDPArg}, {@link com.opencloud.slee.resources.cgin.cap_v2.CAP2InitialDPArg}, {@link com.opencloud.slee.resources.cgin.cap_v3.CAP3InitialDPArg} or {@link com.opencloud.slee.resources.cgin.cap_v4.CAP4InitialDPArg} to
 * a google protobuf {@link com.google.protobuf.Message}.
 */
@SentinelMapper(mappings = { @Mapping(name = "CAP1InitialDPArgToCdr", fromClass = CAP1InitialDPArg.class, toClass = Message.class),
        @Mapping(name = "CAP2InitialDPArgToCdr", fromClass = CAP2InitialDPArg.class, toClass = Message.class),
        @Mapping(name = "CAP3InitialDPArgToCdr", fromClass = CAP3InitialDPArg.class, toClass = Message.class),
        @Mapping(name = "CAP4InitialDPArgToCdr", fromClass = CAP4InitialDPArg.class, toClass = Message.class) })
public class CAP1InitialDPArgToCdr extends BaseCCInitialDPArgToCdr {

    @Override
    public Object map(Object arg, SentinelSs7SessionState sessionState, MapperFacilities facilities) throws MapperException {

        final Ss7CallCdr.Builder cdrBuilder = map(sessionState, facilities);

        final CAP1InitialDPArg idp = (CAP1InitialDPArg) arg;

        // This method on the super class fills in all builder fields which are common to both CS1 and CAP
        populateCommonCDRFields(idp, sessionState, facilities, cdrBuilder);

        //
        // CAP specific logic start here.
        //

        // Called Party Number
        switch (sessionState.getCallType()) {
        case MobileOriginating:
        case EmergencyCall:
        case NetworkInitiated:
            if (idp.hasCalledPartyBCDNumber())
                cdrBuilder.setCalledPartyNumber(idp.getCalledPartyBCDNumber().getAddress());
            break;
        default:
            if (idp.hasCalledPartyNumber())
                cdrBuilder.setCalledPartyNumber(idp.getCalledPartyNumber().getAddress());
        }

        // MSC address
        if (idp.hasMscAddress())
            cdrBuilder.setMscNumber(idp.getMscAddress().getAddress());

        // Tele or Bearer Service
        if (idp.hasExt_basicServiceCode() && idp.getExt_basicServiceCode().isExt_TeleserviceChosen())
            cdrBuilder.setTeleService(idp.getExt_basicServiceCode().getExt_Teleservice()[0]);

        if (idp.hasExt_basicServiceCode() && idp.getExt_basicServiceCode().isExt_BearerServiceChosen())
            cdrBuilder.setBearerService(idp.getExt_basicServiceCode().getExt_BearerService()[0]);

        // Event initiated time - time event emitted by client (in this case idp.TimeAndTimezone)
        if (idp instanceof CAP2InitialDPArg) {
            CAP2InitialDPArg cap2idp = (CAP2InitialDPArg) idp;
            if (cap2idp.hasTimeAndTimezone()) {
                cdrBuilder.setEventInitiated(getCdrTime(cap2idp.getTimeAndTimezone().toCalendar().getTimeInMillis(), cap2idp.getTimeAndTimezone().toCalendar().getTimeZone()));
            }
        }

        // Call reference number
        if (idp.hasCallReferenceNumber())
            cdrBuilder.setCallReferenceNumber(LongByteArray.getLongVal(idp.getCallReferenceNumber()));

        // add any extensions to the CDR
        addCdrExtensions(cdrBuilder, idp, sessionState, facilities);

        return cdrBuilder.build();
    }

    /**
     * Add extensions to the generated CDR
     *
     * @param cdrBuilder the protobuf builder for the CDR
     * @param idp the InitialDP that initiated the session
     * @param ss the sentinel session state
     * @param facilities facilities for tracing and so on
     */
    protected void addCdrExtensions(Ss7CallCdr.Builder cdrBuilder, CAP1InitialDPArg idp, SentinelSs7SessionState ss, MapperFacilities facilities) throws MapperException {
        // to be overridden by SDK defined mappers
    }

    @Override
    protected EncodedValue getLegType(CCCallInformationReportArg cirp) {
        if (cirp instanceof CAP2CallInformationReportArg)
            return ((CAP2CallInformationReportArg) cirp).getLegID().getReceivingSideID().getEncodedValue();
        // Assume called party leg for CS1 as the report is comparable to CAMEL's report for this leg
        return EncodedValue.CALLED_PARTY;
    }
}