org.marre.wap.push.WapSLPush Maven / Gradle / Ivy

Go to download
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is "SMS Library for the Java platform".
 *
 * The Initial Developer of the Original Code is Markus Eriksson.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
package org.marre.wap.push;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;

import org.marre.wap.wbxml.WbxmlDocument;
import org.marre.wap.wbxml.WbxmlWriter;
import org.marre.xml.XmlAttribute;
import org.marre.xml.XmlWriter;

/**
 * Represents a WAP Service Loading Push message.
 * 
 * @author Markus
 * @version $Id$
 */
public class WapSLPush implements WbxmlDocument  , Serializable
{
    /**
	 * 
	 */
	private static final long serialVersionUID = 4910900065381822065L;
	/** WBXML content type */
    public static final String WBXML_CONTENT_TYPE = "application/vnd.wap.slc";
    /** XML content type */
    public static final String XML_CONTENT_TYPE = "text/vnd.wap.sl";

    /** Action, execute-low */
    public static final String ACTION_EXECUTE_LOW = "execute-low";
    /** Action, execute-high */
    public static final String ACTION_EXECUTE_HIGH = "execute-high";
    /** Action, execute-cache */
    public static final String ACTION_EXECUTE_CACHE = "execute-cache";
    
    /** WBXML tag tokens for wap sl push. */
    public static final String[] SL_TAG_TOKENS = {
            "sl", // 05
    };

    /** WBXML attr start tokens for wap sl push. */
    public static final String[] SL_ATTR_START_TOKENS = {
            "action=execute-low", // 05
            "action=execute-high", // 06
            "action=cache", // 07
            "href", // 08
            "href=http://", // 09
            "href=http://www.", // 0A
            "href=https://", // 0B
            "href=https://www.", // 0C
    };

    /** WBXML attr value tokens for wap sl push. */
    public static final String[] SL_ATTR_VALUE_TOKENS = {
            ".com/", // 85
            ".edu/", // 86
            ".net/", // 87
            ".org/", // 88
    };


    /** The uri. */
    protected String uri_;
    /** The action. */
    protected String action_;
    
    /**
     * Constructor.
     * 
     * @param uri
     */
    public WapSLPush(String uri)
    {
        uri_ = uri;
    }

    /**
     * Returns the URI.
     * 
     * @return
     */
    public String getUri()
    {
        return uri_;
    }

    /**
     * Sets the URI.
     * @param uri
     */
    public void setUri(String uri)
    {
        uri_ = uri;
    }

    /**
     * Retrieves the current set action.
     * 
     * @return Action or null if not set.
     */
    public String getAction()
    {
        return action_;
    }

    /**
     * Set the action. 
     * 
     * @param action Can be ACTION_EXECUTE_LOW, ACTION_EXECUTE_HIGH or ACTION_EXECUTE_CACHE.
     */
    public void setAction(String action)
    {
        if (! (ACTION_EXECUTE_CACHE.equals(action) || 
               ACTION_EXECUTE_HIGH.equals(action) ||
               ACTION_EXECUTE_LOW.equals(action)) ) {
            throw new IllegalArgumentException("Action can only be execute-high, execute-low or cache.");
        }
        action_ = action;
    }

    /**
     * Writes the xml document to the given writer.
     * 
     * @param writer
     */
    public void writeXmlTo(XmlWriter writer) throws IOException
    {
        writer.setDoctype("sl", "-//WAPFORUM//DTD SL 1.0//EN", "http://www.wapforum.org/DTD/sl.dtd");

        if (action_ == null) {
            writer.addEmptyElement("sl", new XmlAttribute[]{new XmlAttribute("href", uri_)});
        } else {
            writer.addEmptyElement("sl", new XmlAttribute[]{new XmlAttribute("href", uri_),
                                                            new XmlAttribute("action", action_)});
        }

        writer.flush();
    }

    /**
     * Returns a wbxml writer.
     * 
     * @param os The os to write to.
     * @return Wbxml writer.
     */
    public XmlWriter getWbxmlWriter(OutputStream os)
    {
        return new WbxmlWriter(os, WapSLPush.SL_TAG_TOKENS, WapSLPush.SL_ATTR_START_TOKENS, WapSLPush.SL_ATTR_VALUE_TOKENS);
    }

    /**
     * Returns the wbxml content type.
     * 
     * @return wbxml content type.
     */
    public String getWbxmlContentType()
    {
        return WBXML_CONTENT_TYPE;
    }

    /**
     * Returns the text content type.
     * 
     * @return Content type
     */
    public String getContentType()
    {
        return XML_CONTENT_TYPE;
    }
}