Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


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.


Method Summary
abstract  String getMulticastAddress()
          The IP address that this topic uses to transmit messages to multicast consumers.
abstract  int getMulticastPort()
          The IP port that this topic uses to transmit messages to multicast consumers.
abstract  int getMulticastTimeToLive()
          The number of routers that a message traverses en route to a consumer.
abstract  TemplateBean getTemplateBean()
          Finds the template bean for this destination.
abstract  void setMulticastAddress(String address)
          Sets the value of the MulticastAddress attribute.
abstract  void setMulticastPort(int port)
          Sets the value of the MulticastPort attribute.
abstract  void setMulticastTimeToLive(int timeToLive)
          Sets the value of the MulticastTimeToLive attribute.

 

Method Detail

getMulticastAddress

String getMulticastAddress()

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

Returns:
The multicastAddress 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

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()

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

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()

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

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09