javax.xml.rpc

Interface Stub

Known Implementing Classes:
Stub

public interface Stub

The interface javax.xml.rpc.Stub is the common base interface for the stub classes. All generated stub classes are required to implement the javax.xml.rpc.Stub interface. An instance of a stub class represents a client side proxy or stub instance for the target service endpoint.

The javax.xml.rpc.Stub interface provides an extensible property mechanism for the dynamic configuration of a stub instance.

Version:
1.0

Field Summary

static String
ENDPOINT_ADDRESS_PROPERTY
Standard property: Target service endpoint address.
static String
PASSWORD_PROPERTY
Standard property: Password for authentication.
static String
SESSION_MAINTAIN_PROPERTY
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.
static String
USERNAME_PROPERTY
Standard property: User name for authentication.

Method Summary

Object
_getProperty(String name)
Gets the value of a specific configuration property.
Iterator
_getPropertyNames()
Returns an Iterator view of the names of the properties that can be configured on this stub instance.
void
_setProperty(String name, Object value)
Sets the name and value of a configuration property for this Stub instance.

Field Details

ENDPOINT_ADDRESS_PROPERTY

public static final String ENDPOINT_ADDRESS_PROPERTY
Standard property: Target service endpoint address. The URI scheme for the endpoint address specification must correspond to the protocol/transport binding for this stub class.

Type: java.lang.String


PASSWORD_PROPERTY

public static final String PASSWORD_PROPERTY
Standard property: Password for authentication.

Type: java.lang.String


SESSION_MAINTAIN_PROPERTY

public static final String SESSION_MAINTAIN_PROPERTY
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. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false.

Type: java.lang.Boolean


USERNAME_PROPERTY

public static final String USERNAME_PROPERTY
Standard property: User name for authentication.

Type: java.lang.String

Method Details

_getProperty

public Object _getProperty(String name)
Gets the value of a specific configuration property.
Parameters:
name - Name of the property whose value is to be retrieved
Returns:
Value of the configuration property

_getPropertyNames

public Iterator _getPropertyNames()
Returns an Iterator view of the names of the properties that can be configured on this stub instance.
Returns:
Iterator for the property names of the type java.lang.String

_setProperty

public void _setProperty(String name,
                         Object value)
Sets the name and value of a configuration property for this Stub instance. If the Stub instances contains a value of the same property, the old value is replaced.

Note that the _setProperty method may not perform validity check on a configured property value. An example is the standard property for the target service endpoint address that is not checked for validity in the _setProperty method. In this case, stub configuration errors are detected at the remote method invocation.

Parameters:
name - Name of the configuration property
value - Value of the property

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.