weblogic.j2ee.descriptor.wl
Interface MulticastParamsBean

All Superinterfaces:

SettableBean

public interface MulticastParamsBean
extends SettableBean

Topics with certain quality of service allowments can receive a signifigant performance boost by using multicast to receive messages rather than using a connection oriented protocol like TCP. These parameters can be configured with the bean returned

Access limited to the following security roles:

Deployer

getMulticastAddress

String getMulticastAddress()

The IP address that this topic uses to transmit messages to multicast consumers.

Returns:

The multicastAddress value

Default Value:

""

setMulticastAddress

void setMulticastAddress(String address)
                         throws IllegalArgumentException

Sets the value of the MulticastAddress attribute.

Parameters:

address - The multicast address to use with this topic

Throws:

IllegalArgumentException - if the argument is not a well-formed IP address.

See Also:

MulticastParamsBean.getMulticastAddress()

getMulticastPort

int getMulticastPort()

The IP port that this topic uses to transmit messages to multicast consumers.

Returns:

The IP port that will be used for multicast transmissions

Default Value:

6001

setMulticastPort

void setMulticastPort(int port)
                      throws IllegalArgumentException

Sets the value of the MulticastPort attribute.

Parameters:

port - The IP multicast port to be used with this topic

Throws:

IllegalArgumentException

See Also:

MulticastParamsBean.getMulticastPort()

Maximum Value:

65535

Minimum Value:

1

getMulticastTimeToLive

int getMulticastTimeToLive()

The number of routers that a message traverses en route to a consumer. A value of 1 limits the message to one subnet (which prevents it from traversing any routers).

This value is independent of the JMSExpirationTime value.

Returns:

The multicastTTL value

Default Value:

1

setMulticastTimeToLive

void setMulticastTimeToLive(int timeToLive)
                            throws IllegalArgumentException

Sets the value of the MulticastTimeToLive attribute.

Parameters:

timeToLive - The multicast TTL value to be used with this topic

Throws:

IllegalArgumentException

See Also:

MulticastParamsBean.getMulticastTimeToLive()

Maximum Value:

255

Minimum Value:

0

getTemplateBean

TemplateBean getTemplateBean()

Finds the template bean for this destination.

Returns:

The template bean that will be used for this destination, or null if this threshold bean is from a template or a template could not be found for this destination