Save This Page
Home » JBoss-5.1.0 » org » jboss » remoting » stream » [javadoc | source]
    1   /*
    2   * JBoss, Home of Professional Open Source
    3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
    4   * by the @authors tag. See the copyright.txt in the distribution for a
    5   * full listing of individual contributors.
    6   *
    7   * This is free software; you can redistribute it and/or modify it
    8   * under the terms of the GNU Lesser General Public License as
    9   * published by the Free Software Foundation; either version 2.1 of
   10   * the License, or (at your option) any later version.
   11   *
   12   * This software is distributed in the hope that it will be useful,
   13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   15   * Lesser General Public License for more details.
   16   *
   17   * You should have received a copy of the GNU Lesser General Public
   18   * License along with this software; if not, write to the Free
   19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   21   */
   22   
   23   package org.jboss.remoting.stream;
   24   
   25   import java.io.Serializable;
   26   
   27   /**
   28    * The StreamCallPayload is used when making calls from the server
   29    * to the client to read from the original input stream.
   30    * It will contain the method name being called from the server side (i.e. available(), read(), etc.)
   31    * along with any parameters for the respective method.
   32    *
   33    * @author <a href="mailto:tom.elrod@jboss.com">Tom Elrod</a>
   34    */
   35   public class StreamCallPayload implements Serializable
   36   {
   37      static final long serialVersionUID = 3243358524048714566L;
   38   
   39      private String method = null;
   40      private Object[] paramArray = null;
   41   
   42      /**
   43       * Constructor which requires the name of the method to call on the
   44       * the original stream.
   45       *
   46       * @param methodCallName
   47       */
   48      public StreamCallPayload(String methodCallName)
   49      {
   50         this.method = methodCallName;
   51      }
   52   
   53      /**
   54       * Gets the method to call on the original stream.
   55       *
   56       * @return
   57       */
   58      public String getMethod()
   59      {
   60         return method;
   61      }
   62   
   63      /**
   64       * Sets the params for the method to call on the
   65       * stream.  For example, the Integer for markSupported(int supported).
   66       *
   67       * @param params
   68       */
   69      public void setParams(Object[] params)
   70      {
   71         this.paramArray = params;
   72      }
   73   
   74      /**
   75       * Gets the params for the method to call on the stream.
   76       *
   77       * @return
   78       */
   79      public Object[] getParams()
   80      {
   81         return this.paramArray;
   82      }
   83   }

Save This Page
Home » JBoss-5.1.0 » org » jboss » remoting » stream » [javadoc | source]