001: /*
002: *
003: *
004: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: */
026:
027: package com.sun.tck.wma;
028:
029: import com.sun.tck.wma.Message;
030: import java.util.Date;
031:
032: /**
033: * Implements a SMS message for the SMS message connection. This class
034: * contains methods for manipulating message objects and their contents.
035: * Messages can be composed of data and an address. MessageObject contains
036: * methods that can get and set the data and the address parts of a message
037: * separately. The data part can be either
038: * text or binary format. The address part has the format:
039: * <p>
040: * <code>sms://[<em>phone_number</em>:][<em>port_number</em>]</code>
041: * <p>
042: * and represents the address of a port that can accept or
043: * receive SMS messages.
044: *<p>
045: * <code>MessageObject</code>s are instantiated when they are received from the
046: * {@link com.sun.tck.wma.MessageConnection MessageConnection}
047: * or by using the {@link MessageConnection#newMessage(String type)
048: * MessageConnection.newMessage} message factory. Instances are freed when they
049: * are garbage-collected or when they go out of scope.
050: */
051: public abstract class MessageObject implements Message {
052:
053: /** High-level message type. */
054: protected String msgType;
055:
056: /** High-level message address. */
057: protected String msgAddress;
058:
059: /** The time stamp for a message that was sent. */
060: protected long sentAt;
061:
062: /**
063: * Creates a Message Object without a buffer.
064: *
065: * @param type The message type: TEXT, BINARY or MULTIPART.
066: * @param address The destination address of the message.
067: */
068: public MessageObject(String type, String address) {
069: msgType = type;
070: msgAddress = address;
071: }
072:
073: /**
074: * Gets the address from the message object as a <code>String</code>. If no
075: * address is found in the message, this method returns <code>null</code>.
076: * If the method is applied to an inbound message, the source address is
077: * returned. If it is applied to an outbound message, the destination
078: * address is returned.
079: * <p>
080: * The following code sample retrieves the address from a received message.
081: * <pre>
082: * ...
083: * Message msg = conn.receive();
084: * String addr = msg.getAddress();
085: * ...
086: * </pre>
087: * ...
088: * @return The address in string form, or <code>null</code> if no
089: * address was set.
090: *
091: * @see #setAddress
092: */
093: public String getAddress() {
094: return msgAddress;
095: }
096:
097: /**
098: * Sets the address part of the message object. The address is a
099: * <code>String</code> and must be in the format:
100: * <code>protocol://<em>phone_number</em>:[<em>port</em>]</code>
101: * The following code sample assigns an address to the <code>Message</code>
102: * object.
103: * <pre>
104: * ...
105: * String addr = "protocol://+123456789";
106: * Message msg = newMessage(MessageConnection.TEXT_MESSAGE);
107: * msg.setAddress(addr);
108: * ...
109: * </pre>
110: *
111: * @param addr The address of the target device.
112: *
113: * @throws IllegalArgumentException if the address is not valid.
114: *
115: * @see #getAddress
116: */
117: public abstract void setAddress(String addr);
118:
119: /**
120: * (May be deleted) Set message address, copying the address
121: * from another message.
122: *
123: * @param reference the message who's address will be copied as
124: * the new target address for this message.
125: *
126: * @exception IllegalArgumentException if the address is not valid
127: *
128: * @see #getAddress
129: */
130: public void setAddress(Message reference) {
131: setAddress(reference.getAddress());
132: }
133:
134: /**
135: * Returns the timestamp indicating when this message has been
136: * sent.
137: *
138: * @return Date indicating the timestamp in the message or
139: * <code>null</code> if the timestamp is not set.
140: *
141: * @see #setTimeStamp
142: */
143: public abstract java.util.Date getTimestamp();
144:
145: /**
146: * Sets the timestamp for inbound SMS messages.
147: *
148: * @param timestamp the date indicating the timestamp in the message
149: *
150: * @see #getTimeStamp
151: */
152: public void setTimeStamp(long timestamp) {
153: sentAt = timestamp;
154: }
155:
156: }
|