WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

JCA adapter records

These records are JavaBeans, and they implement the “javax.resource.cci.Record” interface in the JCA version 1.5 specification. These records behave as information carriers between the Web service implementation and the adapter for communicating the attributes corresponding to respective adapter exposed functions.

For additional details about the JCA Adapter records, refer to the Java documentation.

SendMessageRequest
  • This record is used while sending the MT (Mobile Terminated) messages to mobile terminals.
  • This record is used when calling the SendMessage function in the adapter.
  • It is used while performing the Parlay X operations SendSms, SendSmsLogo, and SendSmsRingtone, and the WAP10 operation SendWAPPushSI.
  • The attributes for this record are:
    addresses
    The addresses to which the messages are being sent
    sourceAddress
    The source address
    senderName
    The name of the message sender
    message
    The contents of the message
    segmentNumber
    The unique number assigned to a particular segment in a multi-segmented messages
    numberOfSegments
    The total number of segments in the multi-segmented messages
    functionID
    The unique ID assigned to the function
    serviceTypeUsage
    How to use the serviceType attribute in the SMPP specification: for communicating charging information or for differentiating between SMS and WAP messages
    serviceType
    The service type
    billingCode
    The billing information to be set in the billing identification TLV
    chargeForFirstSegmentOnly
    Whether to charge only for the first segment or for all of the segments in the multi-segmented messages
    sourceAddressTon
    The Type Of Number to be used for the source address (refer to the SMPP 3.4 specification for more information)
    sourceAddressNpi
    The Number Plan Indicator to be used for the source address (refer to the SMPP 3.4 specification for more information)
    destinationTon
    The Type Of Number to be used for the destination address (refer to the SMPP 3.4 specification for more information)
    destinationNpi
    The Number Plan Indicator to be used for the destination address (refer to the SMPP 3.4 specification for more information)
    esmClass
    The message mode and message type
    protocolID
    The protocol ID
    priorityFlag
    The priority level of the message
    defaultMessageID
    The short message to send from a list of predefined ("canned") short messages stored on the MC (null if you are not using an MC canned message)
    replaceIfPresentFlag
    A flag indicating whether the submitted message should replace an existing message
    encoding
    The encoding scheme of the message
    operationName
    The name of the operation that generated the message
    maxMessageSize
    The maximum allowable size, in bytes, of an individual message as stipulated by the SMSC
    maxTargetSize
    The maximum number of targets allowed in a single message according to the protocol specification or network support
    confirmDelivery
    Whether confirmation of delivery is required for a short message that has already been sent
    sarRefNum
    The reference number for a particular concatenated short message
SendMessageResponse
  • This record is used by the adapter when it sends the response messages to the Web service implementation layer corresponding to the MT (Mobile Terminated) messages that are sent to the mobile terminals.
  • It is used while performing the Parlay X operations SendSms, SendSmsLogo, and SendSmsRingtone, and the WAP10 operation SendWAPPushSI.
  • The attributes for this record are:
    messageID
    The unique ID that is used while sending the request
    functionID
    The unique ID assigned to the function
    messageStatus
    The status of the message, based on the SMPP 3.4 specification: DELIVERED, EXPIRED, DELETED, UNDELIVERABLE, ACCEPTED, UNKNOWN or REJECTED
    failedMessageCount
    The number of messages that failed
    failedDestinationAddresses
    The number of addresses that failed
    commandStatus
    The status of the protocol-specific command that is being sent
    networkID
    The unique ID assigned to messages by the network element
    elementID
    Used by TWSS Web service implementations for internal tracking
BindToNERequest
  • This record is used while the Web service implementation layer sends a request to the JCA for establishing a connection with the network element.
  • This record is used when calling the BindToNE function in the adapter.
  • There is no corresponding Parlay X Web service operation for using this record.
  • The attributes for this record are:
    functionID
    The unique ID assigned to the function
    hostName
    The host name of the network entity (SMSC in SMS and WAPPush)
    portNumber
    The port number of the network entity
    systemID
    The unique ID used to represent the network entity
    password
    The password that corresponds to the systemID
    systemType
    (Optional) The type of system: VMS (Voice Mail System) or OTA (Over-The-Air activation system)
    messageType
    The type of the message: SyncSMS, ASyncSM, or StatusLessSMS
    bindType
    The type of connection to be established between the service implementation and the SMSC: Transmitter(Tx), Receiver(Rx), or Transceiver(Trx)
BindToNEResponse
  • This record is used while the JCA layer sends the response to the Web service implementation upon establishing the connection with the network element.
  • There is no corresponding Parlay X Web service operation for using this record.
  • The attribute for this record is:
    bindSucceed
    An indicator that the bind operation completed successfully
UnbindNERequest
  • This record is used while the Web service implementation layer sends a request to the JCA for closing already established connections with the network element.
  • This record is used when calling the UnbindNE function in the adapter.
  • The attribute for this record is:
    functionID
    The unique ID assigned to the function
UnbindNEResponse
  • This record is used while the JCA layer sends the response to Web service implementation when closing the existing connections with the network element.
  • This record is used when calling the UnbindNE function in the adapter.
  • The attributes for this record are:
    unbindSucceeded
    An indicator that the unbind operation completed successfully
    functionID
    The unique ID assigned to the function
MonitorHeartBeat
  • This record is used while sending the request message corresponding to the heartbeat monitoring operation.
  • The attribute for this record is:
    functionID
    The unique ID assigned to the function
MOMessageRequest
  • This record is used while the JCA layer forwards the mobile origination messages from the network element to the Web service implementation layer.
  • This record is used when calling the MOMessage function in the adapter.
  • The attributes for this record are:
    functionID
    The unique ID assigned to the function
    sourceAddress
    The source address
    sourceAddressTon
    The Type Of Number to be used for the source address (refer to the SMPP 3.4 specification for more information)
    sourceAddressNpi
    The Number Plan Indicator to be used for the source address (refer to the SMPP 3.4 specification for more information)
    destinationAddress
    The destination address
    destinationAddressTon
    The Type Of Number to be used for the destination address (refer to the SMPP 3.4 specification for more information)
    destinationAddressNpi
    The Number Plan Indicator to be used for the destination address (refer to the SMPP 3.4 specification for more information)
    moMessage
    The actual MO (mobile originated) message that is sent by the network entity
    messageType
    The type of the MO message, specified as one of the following:
    • DELIVERY_CONFIRMATION
    • DELIVERY_CONFIRMATION_ACK
    • MOBILE_ORIGINATED.
    MO messages of type DELIVERY_CONFIRMATION or DELIVERY_CONFIRMATION_ACK correspond to the delivery confirmation of already sent short messages. MO messages of type MOBILE_ORIGINATED correspond to already started notifications.
    messageState
    The final state of the MO message, based on the SMPP 3.4 specification: DELIVERED, EXPIRED, DELETED, UNDELIVERABLE, ACCEPTED, UNKNOWN or REJECTED
    receivedMessageID
    The message ID received along with the MO message
    networkErrorCode
    The network error code
    serviceType
    The service type
    protocolID
    The protocol ID
    priorityFlag
    The priority level of the short message
    registeredDelivery
    Whether the network entity requires an acknowledgement for the delivery of MO message
    encodingScheme
    The encoding scheme of the MO message
    messageLength
    The size/length of the MO message
QueryStatusRequest
  • This record is used while the Web service implementation layer queries the network element for the status of an already sent message.
  • This record is used when calling the QueryStatus function in the adapter.
  • The attributes for this record are:
    functionID
    The unique ID assigned to the function
    messageID
    The unique ID assigned to a short message by the network entity (SMSC), based on the SMPP 3.4 specification
    sourceAddress
    The source address
    sourceAddressTon
    The Type Of Number to be used for the source address (refer to the SMPP 3.4 specification for more information)
    sourceAddressNpi
    The Number Plan Indicator to be used for the source address (refer to the SMPP 3.4 specification for more information)
QueryStatusResponse
  • This record is used while the network element sends the status of the already sent message to the Web service implementation.
  • The attributes for this record are:
    messageID
    The unique ID that is used while sending the Query Message request
    messageStatus
    The status of the message, based on the SMPP 3.4 specification: DELIVERED, EXPIRED, DELETED, UNDELIVERABLE, ACCEPTED, UNKNOWN or REJECTED
    finalState
    The final state of the message
    errorCode
    Whether any issues are observed while querying the status of the message
ErrorMessage
  • This record is used while the Web service implementation layer sends an error message as a response
  • The attributes for this record are:
    functionID
    The unique ID assigned to the function
    errorMessage
    The error message returned by the network entity for any of the interactions with it



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.