Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## hr.tis.mgw.client.message
Interface MessageManager

All Known Implementing Classes:
  MessageManagerImpl

Deprecated. For mGw version 2 use MessageManager2.

public interface MessageManager

Central interface for sending messages and other related actions.

See Also:
  `MessageManager2`

Method Summary
`void` | `cancelMessageListenerRegistration(java.lang.String routeId)` Deprecated. Method for removing registered MessageListener.
`Attachment[]` | `getMessageAttachments(java.lang.String routeId, java.lang.String messageId)` Deprecated. Returns Attachments that message under specified ID contains.
`DeliveryStatusInfo[]` | `getMessageDeliveryStatus(java.lang.String routeId, java.lang.String messageId)` Deprecated. Returns delivery status of each destination for message specified by ID (returned by `sendMessage(String, Message, String, String[], Priority, String)` method).
`void` | `registerMessageListener(java.lang.String routeId, MessageListener listener)` Deprecated. Method for registering MessageListener that will asynchronously accept incoming messages and delivery reports from gateway.
`java.lang.String` | `sendMessage(java.lang.String routeId, Message message, java.lang.String serviceAddress, java.lang.String[] endUserAddresses, Priority priority, java.lang.String charging)` Deprecated. This method requests message sending to set of destination numbers, returning request identifier to identify the message.

Method Detail

### sendMessage

    public java.lang.String sendMessage(java.lang.String routeId,
                                        Message message,
                                        java.lang.String serviceAddress,
                                        java.lang.String[] endUserAddresses,
                                        Priority priority,
                                        java.lang.String charging)
                                 throws GatewayException,
                                        MessageTooLargeException,
                                        UnknownEndUserAddressException,
                                        NoRouteCredentialsException,
                                        java.rmi.RemoteException

  Deprecated.
  This method requests message sending to set of destination numbers, returning request identifier to identify the message. This message ID can subsequently be used to see message delivery status, when application gets notified about it.
  Message content is provided by Message implementation.

  Parameters:
    `routeId` - route identifier required for request authorization
    `message` - implementation of Message (SMS, MMS, etc.)
    `serviceAddress` - sender service address (MSISDN number or some other identifier)
    `endUserAddresses` - array of destination end user addresses (MSISDN number or some other identifier). Note that URI scheme can also be set as a part of endUserAddress, otherwise where no URI scheme is set, then 'tel:' is going to be used as a default URI scheme.
    `priority` - message priority
    `charging` - specifies operator-specific charging policy
  Returns:
    String identifying sending request (message ID)
  Throws:
    `GatewayException` - when gateway couldn't process request for some reason
    `MessageTooLargeException` - when message exceeded maximum length supported
    `UnknownEndUserAddressException` - when end user address was unknown
    `NoRouteCredentialsException` - when security credentials cannot be resolved for specified route
    `java.rmi.RemoteException` - when there was communication error with gateway

### getMessageDeliveryStatus

    public DeliveryStatusInfo[] getMessageDeliveryStatus(java.lang.String routeId,
                                                         java.lang.String messageId)
                                                  throws GatewayException,
                                                         UnknownMessageIdentifierException,
                                                         NoRouteCredentialsException,
                                                         java.rmi.RemoteException

  Deprecated.
  Returns delivery status of each destination for message specified by ID (returned by `sendMessage(String, Message, String, String[], Priority, String)` method).

  Parameters:
    `routeId` - route identifier required for request authorization
    `messageId` - message identifier
  Returns:
    array of DeliveryStatusInfo
  Throws:
    `GatewayException` - when gateway couldn't process request for some reason
    `UnknownMessageIdentifierException` - when message under specified ID isn't found in gateway
    `NoRouteCredentialsException` - when security credentials cannot be resolved for specified route
    `java.rmi.RemoteException` - when there was communication error with gateway

### getMessageAttachments

    public Attachment[] getMessageAttachments(java.lang.String routeId,
                                              java.lang.String messageId)
                                       throws GatewayException,
                                              UnknownMessageIdentifierException,
                                              NoRouteCredentialsException,
                                              java.rmi.RemoteException

  Deprecated.
  Returns Attachments that message under specified ID contains.

  Parameters:
    `routeId` - route identifier required for request authorization
    `messageId` - message identifier
  Returns:
    array of message Attachments
  Throws:
    `GatewayException` - when gateway couldn't process request for some reason
    `UnknownMessageIdentifierException` - when message under specified ID isn't found in gateway
    `NoRouteCredentialsException` - when security credentials cannot be resolved for specified route
    `java.rmi.RemoteException` - when there was communication error with gateway

### registerMessageListener

    public void registerMessageListener(java.lang.String routeId,
                                        MessageListener listener)

  Deprecated.
  Method for registering MessageListener that will asynchronously accept incoming messages and delivery reports from gateway. This method is only applicable for new Message Notification system used with MessageManager2. You can use this method but then you have to configure "web.xml" as shown is MessageManager2 examples and put "server-config.wsdd" in yours web application WEB-INF directory used with MessageManager2 examples. Note that Route ID corresponds with Registration Identifier used in MessageManager2.

  Parameters:
    `routeId` - route identifier required for registering message listener to specific route
    `listener` - MessageListener instance
  See Also:
    `MessageManager2.registerMessageListener(String, hr.tis.mgw.client.message.notification.MessageListener2)`

### cancelMessageListenerRegistration

    public void cancelMessageListenerRegistration(java.lang.String routeId)

  Deprecated.
  Method for removing registered MessageListener. This method is only applicable for new Message Notification system used with MessageManager2. Note that Route ID corresponds with Registration Identifier used in MessageManager2.

  Parameters:
    `routeId` - route identifier required for unregistering message listener from specific route
  See Also:
    `MessageManager2.cancelMessageListenerRegistration(String)`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2007, TIS.kis d.o.o. All Rights Reserved.