Save This Page
Home » xml-commons-external-1.4.01-src » javax » xml » rpc » [javadoc | source]
    1   /*
    2    * JBoss, Home of Professional Open Source.
    3    * Copyright 2006, Red Hat Middleware LLC, and individual contributors
    4    * as indicated by the @author tags. See the copyright.txt file in the
    5    * distribution for a 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   package javax.xml.rpc;
   23   
   24   import java.util.Iterator;
   25   
   26   /**
   27    * The interface javax.xml.rpc.Stub is the common base interface for the stub classes.
   28    * All generated stub classes are required to implement the javax.xml.rpc.Stub interface.
   29    * An instance of a stub class represents a client side proxy or stub instance for the target service endpoint.
   30    *
   31    * The javax.xml.rpc.Stub interface provides an extensible property mechanism for the dynamic configuration of a stub instance.
   32    *
   33    * @author Scott.Stark@jboss.org
   34    * @author Thomas.Diesler@jboss.org
   35    */
   36   public interface Stub
   37   {
   38      /** Standard property: User name for authentication. */
   39      public static final String USERNAME_PROPERTY = "javax.xml.rpc.security.auth.username";
   40      /**  Standard property: Password for authentication. */
   41      public static final String PASSWORD_PROPERTY = "javax.xml.rpc.security.auth.password";
   42      /** Standard property: Target service endpoint address.  */
   43      public static final String ENDPOINT_ADDRESS_PROPERTY = "javax.xml.rpc.service.endpoint.address";
   44      /** Standard property: This boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint. */
   45      public static final String SESSION_MAINTAIN_PROPERTY = "javax.xml.rpc.session.maintain";
   46   
   47      /** Sets the name and value of a configuration property for this Stub instance.
   48       *
   49       * If the Stub instances contains a value of the same property, the old value is replaced.
   50       * Note that the _setProperty method may not perform validity check on a configured property value.
   51       * An example is the standard property for the target service endpoint address that is not checked for validity in
   52       * the _setProperty method. In this case, stub configuration errors are detected at the remote method invocation.
   53       *
   54       * @param name Name of the configuration property
   55       * @param value Value of the property
   56       * @throws  JAXRPCException
   57       *    If an optional standard property name is specified, however this Stub implementation class does not support the configuration of this property.
   58       *    If an invalid or unsupported property name is specified or if a value of mismatched property type is passed.
   59       *    If there is any error in the configuration of a valid property.
   60       */
   61      public void _setProperty(String name, Object value);
   62   
   63      /** Gets the value of a specific configuration property.
   64       * @param name Name of the property whose value is to be retrieved
   65       * @return Value of the configuration property
   66       * @throws  JAXRPCException if an invalid or unsupported property name is passed.
   67       */
   68      public Object _getProperty(String name);
   69   
   70      /** Returns an Iterato view of the names of the properties that can be configured on this stub instance.
   71       * @return Iterator for the property names of the type java.lang.String
   72       */
   73      public Iterator _getPropertyNames();
   74   }

Save This Page
Home » xml-commons-external-1.4.01-src » javax » xml » rpc » [javadoc | source]