JavaEE API 8.0.1 · javax.xml.rpc.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.

Field Summary

Modifier and Type	Field and Description
public static final String	ENDPOINT_ADDRESS_PROPERTY Standard property: Target service endpoint address.
public static final String	PASSWORD_PROPERTY Standard property: Password for authentication.
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.
public static final String	USERNAME_PROPERTY Standard property: User name for authentication.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: Value of the configuration property _getProperty(String Name of the property whose value is to be retrieved name) Gets the value of a specific configuration property.
public Iterator<E>	Returns: Iterator for the property names of the type `java.lang.String` _getPropertyNames() Returns an `Iterato` view of the names of the properties that can be configured on this stub instance.
public void	_setProperty(String Name of the configuration property name, Object Value of the property value) Sets the name and value of a configuration property for this Stub instance.

Field Detail

ENDPOINT_ADDRESS_PROPERTY	back to summary
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

ENDPOINT_ADDRESS_PROPERTY

back to summary

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	back to summary
public static final String PASSWORD_PROPERTY Standard property: Password for authentication. Type: java.lang.String

PASSWORD_PROPERTY

back to summary

public static final String PASSWORD_PROPERTY

Standard property: Password for authentication.

Type: java.lang.String

SESSION_MAINTAIN_PROPERTY	back to summary
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

SESSION_MAINTAIN_PROPERTY

back to summary

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	back to summary
public static final String USERNAME_PROPERTY Standard property: User name for authentication. Type: java.lang.String

USERNAME_PROPERTY

back to summary

public static final String USERNAME_PROPERTY

Standard property: User name for authentication.

Type: java.lang.String

Method Detail

_getProperty	back to summary
public Object _getProperty(String name) Gets the value of a specific configuration property. Parameters name:String Name of the property whose value is to be retrieved Returns:Object Value of the configuration property Exceptions JAXRPCException: if an invalid or unsupported property name is passed.

_getProperty

back to summary

public Object _getProperty(String name)

Gets the value of a specific configuration property.

Parameters

name:String: Name of the property whose value is to be retrieved

Returns:Object

Value of the configuration property

Exceptions

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

_getPropertyNames back to summary

_getPropertyNames	back to summary
public Iterator<E> _getPropertyNames() Returns an `Iterato` view of the names of the properties that can be configured on this stub instance. Returns:Iterator<E> Iterator for the property names of the type `java.lang.String`

public Iterator<E> _getPropertyNames()

Returns an Iterato view of the names of the properties that can be configured on this stub instance.

Returns:Iterator<E>: Iterator for the property names of the type java.lang.String

_setProperty back to summary

_setProperty	back to summary
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:String Name of the configuration property value:Object Value of the property Exceptions JAXRPCException: If an optional standard property name is specified, however this Stub implementation class does not support the configuration of this property. If an invalid or unsupported property name is specified or if a value of mismatched property type is passed. If there is any error in the configuration of a valid property.

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:String: Name of the configuration property
value:Object: Value of the property

Exceptions

JAXRPCException:

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

public Interface Stub

Field Summary

Method Summary

Field Detail

Method Detail