/*
    * Copyright (c) 2004 Peter Antman, Mogul  <peter.antman@mogul.com>
    *
    * $Id: ServiceMessage.java,v 1.1.1.1 2004/05/19 12:22:46 pra Exp $
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    * License as published by the Free Software Foundation; either
    * version 2 of the License, or (at your option) any later version
   * 
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Lesser General Public License for more details.
   * 
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  package org.backsource.amsterdam.service;
  
  import java.io.InputStream;
  
  import org.backsource.amsterdam.metadata.ContentMapEntry;
  /***
    * Is the message sent through the system, should be constructed
   * by the ProtocolHandler.
  
     The content of a ServiceMessage may be manipulated on the way
     down the invoker chain (eg from SGML to XML), but the message 
     object in itself may not be changed to a new one.
  
     FIXME - shoild not an url be part of this?
   *
   *
   * @author <a href="mailto:pra@mogul.com">Peter Antman</a>
   * @version $Revision: 1.1.1.1 $
   */
  
  public class ServiceMessage {
     private ContentMapEntry entry;
     private String url;
     private boolean hasStream = false;
     private boolean isBinary = true;//You never bo, do you
     private String message;
     private String mime;
     private InputStream is;
     private String response;
     private Object objectMessage;
     private boolean hasObjectMessage = false;
     private String name = null;
  
     // FIXME, do we need the URL or even the ContentEntry?
     public ServiceMessage(ContentMapEntry entry,
                           String url,
                           String mime, 
                           String message) {
        this.entry = entry;
        this.url = url;
        this.name = url;
        this.mime = mime;
        this.message = message;
        isBinary = false;
        hasStream = false; //Just in case
  	
     }
  
     // FIME - should it be possible to construct messages without a ContentMapEntry?
     public ServiceMessage(
                           String url,
                           String mime, 
                           String message) {
        this(null,url,mime,message);
     }
      
     public ServiceMessage(
                           String url,
                           String mime, 
                           InputStream is) {
        this(null,url,mime,is);
     }
      
     public ServiceMessage(ContentMapEntry entry,
                           String url,
                           String mime, 
                           InputStream is) {
        this.entry = entry;
        this.url = url;
        this.name = url;
        this.is = is;
        hasStream = true;
        //isBinary = MimeHelper.isBinary(mime);
     }
  
     public ServiceMessage(Object message) {
        this.objectMessage = message;
        hasObjectMessage = true;
     }
     public ContentMapEntry getContentMapEntry() {
       return entry;
    }
 
    public void setContentMapEntry(ContentMapEntry entry) {
       this.entry = entry;
    }
     
    public String getUrl() {
       return url;
    }
   
    public void setUrl(String url) {
       this.url = url;
    }
   
    public String getName() {
       return name;
    }
   
    public void setName(String name) {
       this.name = name;
    }
 
    /***
     * Check if message body is carried inside a stream
     * If it is use getStream() else use getMessage()
     */
    public boolean hasStream() {
       return hasStream;
    }
 
    protected void hasStream(boolean hasStream) {
       this.hasStream = hasStream;
    }
 
    /***
     * Check if message body is binary
     */
    public boolean isBinary() {
       return isBinary;
    }
 
    protected void isBinary(boolean isBinary) {
       this.isBinary = isBinary;
    }
 
    /***
     * Get mime type
     */
    public String getMime() {
       return mime;
    }
  
    public void setMime(String mime) {
       this.mime = mime;
    }
 
    /***
     * Get a stream to the underlying message. The creator
     * of the stream <i>may not</i> count on that the message has
     * reached the final destination when it is closed.
     */
    public InputStream getStream() {
       return is;
    }
     
    /***
     * Set an InputStream, overwriting the previus one, if you
     * do this, see to it that the original one was closed first.
     *
     * May be set to null, hasStream will then be set to false
     */
    public void setInputStream(InputStream is) {
       this.is = is;
       if (is != null) {
          hasStream = true;
          hasObjectMessage = false;
       }else
          hasStream = false;
    }
 
    /***
     * Get the message. Only if its text, and currently only if
     * it was set
     */ 
    public String getMessage() {
       return message;//Or should be convert from is to string
       //if that the only one available
    }
 
    /***
     * Set a message, overwrite the prevous one.
     */
     
    public void setMessage(String message) {
       this.message = message;
       isBinary = false;
       hasStream = false;
       hasObjectMessage = false;
    }
 
 
    public void setObjectMessage(Object message) {
       this.objectMessage = message;
       hasObjectMessage = true;
    }
 
    public Object getObjectMessage() {
       return objectMessage;
    }
 
    public boolean hasObjectMessage() {
       return hasObjectMessage;
    }
 
    /***
     * Get any response message
     */
    public String getResponse() {
       return response;
    }
 
    /***
     * A publisher (or some other party in the chain) may fill in
     * a response note (in xml). It is up to the application
     * assembler to see to it that the parts agree on a format if
     * this feature is used.
     */
    public void setResponse(String response) {
       this.response = response;
    }
 
     
    
 }// ServiceMessage