javax.xml.rpc
Interface 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.

Since:

BlackBerry API 4.3.0

Field Summary
static String	ENDPOINT_ADDRESS_PROPERTY A string specifying the target service endpoint address.
static String	PASSWORD_PROPERTY A string specifying the password for authentication.
static String	SESSION_MAINTAIN_PROPERTY A boolean flag indicating whether or not a client wants to participate in a session with a service endpoint.
static String	USERNAME_PROPERTY A string specifying the user name for authentication.

Method Summary
Object	_getProperty(String name) Retrieves the value of a given property.
void	_setProperty(String name, Object value) Sets the value of a property configured on this stub instance.

Field Detail

USERNAME_PROPERTY

static final String USERNAME_PROPERTY

A string specifying the user name for authentication.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

PASSWORD_PROPERTY

static final String PASSWORD_PROPERTY

A string specifying the password for authentication.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

ENDPOINT_ADDRESS_PROPERTY

static final String ENDPOINT_ADDRESS_PROPERTY

A string specifying the target service endpoint address.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

SESSION_MAINTAIN_PROPERTY

static final String SESSION_MAINTAIN_PROPERTY

A boolean flag indicating whether or not a client wants to participate in a session with a service endpoint.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

Method Detail

_getProperty

Object _getProperty(String name)

Retrieves the value of a given property.

Parameters:

name - The name of the property.

Returns:

an Object storing the value of the given property name.

Throws:

JAXRPCException - if an invalid or unsupported property name is passed.

Since:

BlackBerry API 4.3.0

_setProperty

void _setProperty(String name,
                  Object value)

Sets the value of a property configured on this stub instance. Notet that the _setProperty method may not check validity of a configured property value. In this case, any stub configuration errors are detected at the remote method invocation.

Parameters:

name - The name of the configured property.

value - The value of the configured property.

Throws:

JAXRPCException - if

• an optional standard property name is specified; however, this Stub implementation class does not support the configuration of this property;
• an invalid or unsupported property name is specified or if a value of mismatched property type is passed.
• there is any error in the configuration of a valid property.

Since:

BlackBerry API 4.3.0