Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## weblogic.management.configuration
Interface NetworkChannelMBean

public interface NetworkChannelMBean
extends DeploymentMBean

This MBean defines a network channel. A network channel is used to configure additional ports for a server beyond its default listen ports. Network channels do not support IIOP.

A network channel can be targeted at multiple clusters and servers. Targeting a channel at a cluster targets it at every server that is a member of that cluster. A server can support multiple channels. A server can fine-tune its network channel settings by using a NetworkAccessPointMBean. The NetworkAccessPointMBean also servers to set the listen address and external DNS name that a server uses for a particular channel.

A server serves up to three default listen ports: ServerMBean ListenPort, ServerMBean AdministrationPort, and SSLMBean ListenPort. The default listen ports form implicit channel(s) of weight 50.

A network channel also defines the creation of server-to-server connections. If a server is initiating a new connection to another server, the highest weighted common (same named) channel that supports the desired protocol is used to determine which port to contact.

See Also:
  `ServerMBean.getListenPort()`, `ServerMBean.getAdministrationPort()`, `SSLMBean.getListenPort()`, `KernelMBean.getSSL()`, `NetworkAccessPointMBean`, `ServerMBean.getNetworkAccessPoints()`

Fields inherited from class weblogic.management.configuration.DeploymentMBean
`CACHING_STUB_SVUID, DEFAULT_ORDER, MAX_ORDER, MIN_ORDER`

Fields inherited from class weblogic.management.configuration.ConfigurationMBean
`CACHING_STUB_SVUID`

Method Summary
`int` | `getAcceptBacklog()` Allowed backlog of connection requests on the listen port(s).
`int` | `getChannelWeight()` A weight to give this channel when creating server-to-server connections.
`java.lang.String` | `getClusterAddress()` This channel's cluster address.
`int` | `getCompleteCOMMessageTimeout()` The maximum number of seconds spent waiting for a complete COM message to be received.
`int` | `getCompleteHTTPMessageTimeout()` The maximum number of seconds spent waiting for a complete HTTP message to be received.
`int` | `getCompleteT3MessageTimeout()` The maximum number of seconds spent waiting for a complete T3 message to be received.
`java.lang.String` | `getDescription()` Optional short description of this channel for console display purposes.
`int` | `getListenPort()` The plaintext (non-SSL) listen port for the channel.
`int` | `getLoginTimeoutMillis()` The login timeout for the server, in milliseconds.
`int` | `getLoginTimeoutMillisSSL()` Duration allowed for an SSL login sequence.
`int` | `getMaxCOMMessageSize()` The maximum COM message size allowable in a message header.
`int` | `getMaxHTTPMessageSize()` The maximum HTTP message size allowable in a message header.
`int` | `getMaxT3MessageSize()` The maximum T3 message size allowable in a message header.
`java.lang.String` | `getName()` The name of the channel.
`int` | `getSSLListenPort()` The SSL listen port for the channel.
`int` | `getTunnelingClientPingSecs()` Interval (in seconds) at which to ping an http-tunneled client to see if its still alive.
`int` | `getTunnelingClientTimeoutSecs()` Duration (in seconds) after which a missing http-tunneled client is considered dead.
`boolean` | `isBoundOutgoingEnabled()` Bind new outgoing server side T3 or T3S connections to the server channel's listen address.
`boolean` | `isCOMEnabled()` Indicates whether or not plaintext (non-SSL) COM traffic is enabled.
`boolean` | `isHTTPEnabled()` Whether or not plaintext (non-SSL) HTTP traffic is enabled.
`boolean` | `isHTTPSEnabled()` Whether or not secure (SSL) HTTP traffic is enabled.
`boolean` | `isListenPortEnabled()` Whether or not plaintext port is enabled for the channel.
`boolean` | `isOutgoingEnabled()` Whether or not new server-to-server connections may consider this channel when initiating.
`boolean` | `isSSLListenPortEnabled()` Whether or not SSL port is enabled for the channel.
`boolean` | `isT3Enabled()` Whether or not plaintext (non-SSL) T3 traffic is enabled.
`boolean` | `isT3SEnabled()` Whether or not secure T3 traffic is enabled.
`boolean` | `isTunnelingEnabled()` Enables tunneling via http.
`void` | `setAcceptBacklog(int count)`
`void` | `setChannelWeight(int weight)`
`void` | `setClusterAddress(java.lang.String address)`
`void` | `setCOMEnabled(boolean enabled)` Determines whether or not plaintext (non-SSL) COM traffic is enabled.
`void` | `setCompleteCOMMessageTimeout(int seconds)`
`void` | `setCompleteHTTPMessageTimeout(int seconds)`
`void` | `setCompleteIIOPMessageTimeout(int seconds)`
`void` | `setCompleteT3MessageTimeout(int seconds)`
`void` | `setDefaultIIOPPassword(java.lang.String password)`
`void` | `setDefaultIIOPUser(java.lang.String user)`
`void` | `setDescription(java.lang.String description)`
`void` | `setHTTPEnabled(boolean enabled)`
`void` | `setHTTPSEnabled(boolean enabled)`
`void` | `setIdleIIOPConnectionTimeout(int seconds)`
`void` | `setIIOPEnabled(boolean enabled)`
`void` | `setIIOPSEnabled(boolean enabled)`
`void` | `setListenPort(int port)`
`void` | `setListenPortEnabled(boolean enable)`
`void` | `setLoginTimeoutMillis(int timeout)`
`void` | `setLoginTimeoutMillisSSL(int millis)`
`void` | `setMaxCOMMessageSize(int maxsize)`
`void` | `setMaxHTTPMessageSize(int maxsize)`
`void` | `setMaxIIOPMessageSize(int maxsize)`
`void` | `setMaxT3MessageSize(int maxsize)`
`void` | `setName(java.lang.String name)`
`void` | `setOutgoingEnabled(boolean enabled)`
`void` | `setSSLListenPort(int port)`
`void` | `setSSLListenPortEnabled(boolean enable)`
`void` | `setT3Enabled(boolean enabled)`
`void` | `setT3SEnabled(boolean enabled)`
`void` | `setTunnelingClientPingSecs(int secs)`
`void` | `setTunnelingClientTimeoutSecs(int secs)`
`void` | `setTunnelingEnabled(boolean enabled)`

Methods inherited from interface weblogic.management.configuration.DeploymentMBean
`addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets`

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
`addLinkMbeanAttribute, getNotes, isPersistenceEnabled, setNotes`

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Method Detail

### getName

    public java.lang.String getName()

  The name of the channel. The name must not start with ".WL".

  Legal Value: (value != null) && (value.trim().length() > 0) && !value.startsWith(".WL") && !value.equals("Default") && !value.equals("Administrator")

### setName

    public void setName(java.lang.String name)
                 throws javax.management.InvalidAttributeValueException,
                        ManagementException

### getDescription

    public java.lang.String getDescription()

  Optional short description of this channel for console display purposes. For long descriptions, use the "Notes" field.

  Default Value: null

### setDescription

    public void setDescription(java.lang.String description)
                        throws javax.management.InvalidAttributeValueException

### getListenPort

    public int getListenPort()

  The plaintext (non-SSL) listen port for the channel. Individual servers may override this value, but may not enable the port if disabled here and may not disable the port if enabled here. Individual servers may override this value using a NetworkAccessPointMBean.

  Default Value: 8001
  Legal Minimum Value: 1
  Legal Maximum Value: 65534
  See Also:
    `isListenPortEnabled()`, `getSSLListenPort()`, `NetworkAccessPointMBean.getListenPort()`, `NetworkAccessPointMBean.getListenAddress()`, `NetworkAccessPointMBean.getExternalDNSName()`, `ServerMBean.getListenPort()`

### setListenPort

    public void setListenPort(int port)
                       throws javax.management.InvalidAttributeValueException

### isListenPortEnabled

    public boolean isListenPortEnabled()

  Whether or not plaintext port is enabled for the channel.

  Default Value: false
  Secure Value: false
  See Also:
    `getListenPort()`, `ServerMBean.isListenPortEnabled()`

### setListenPortEnabled

    public void setListenPortEnabled(boolean enable)
                              throws javax.management.InvalidAttributeValueException

### getSSLListenPort

    public int getSSLListenPort()

  The SSL listen port for the channel. Individual server's may override this value, but may not enable the port if disabled here and may not disable the port if enabled here. SSL must be configured and enabled for this port to work. Individual servers may override this value using a NetworkAccessPointMBean.

  Default Value: 8002
  Legal Minimum Value: 1
  Legal Maximum Value: 65534
  See Also:
    `getSSLListenPort()`, `isSSLListenPortEnabled()`, `SSLMBean.getListenPort()`, `KernelMBean.getSSL()`, `NetworkAccessPointMBean.getSSLListenPort()`, `NetworkAccessPointMBean.getListenAddress()`

### setSSLListenPort

    public void setSSLListenPort(int port)
                          throws javax.management.InvalidAttributeValueException

### isSSLListenPortEnabled

    public boolean isSSLListenPortEnabled()

  Whether or not SSL port is enabled for the channel. SSL must be configured and enabled in addition to this setting for the SSL port to work.

  Default Value: false
  Secure Value: true
  See Also:
    `SSLMBean.isListenPortEnabled()`, `KernelMBean.getSSL()`

### setSSLListenPortEnabled

    public void setSSLListenPortEnabled(boolean enable)
                                 throws javax.management.InvalidAttributeValueException

### getClusterAddress

    public java.lang.String getClusterAddress()

  This channel's cluster address. If this is not set, the cluster address from the cluster configuration is used in its place.

  Default Value: null
  See Also:
    `ClusterMBean.getClusterAddress()`

### setClusterAddress

    public void setClusterAddress(java.lang.String address)
                           throws javax.management.InvalidAttributeValueException

### isT3Enabled

    public boolean isT3Enabled()

  Whether or not plaintext (non-SSL) T3 traffic is enabled. Note that it is not possible to disable T3 traffic on the default channel(s).

  Default Value: false
  Secure Value: false
  See Also:
    `NetworkChannelMBean`, `isT3SEnabled()`

### setT3Enabled

    public void setT3Enabled(boolean enabled)
                      throws javax.management.InvalidAttributeValueException

### isT3SEnabled

    public boolean isT3SEnabled()

  Whether or not secure T3 traffic is enabled. Note that it is not possible to disable T3 traffic on the default channel(s).

  Default Value: false
  Secure Value: false
  See Also:
    `NetworkChannelMBean`, `isT3Enabled()`

### setT3SEnabled

    public void setT3SEnabled(boolean enabled)
                       throws javax.management.InvalidAttributeValueException

### isHTTPEnabled

    public boolean isHTTPEnabled()

  Whether or not plaintext (non-SSL) HTTP traffic is enabled.

  Default Value: false
  Secure Value: false
  See Also:
    `ServerMBean.isHttpdEnabled()`, `isHTTPSEnabled()`, `isTunnelingEnabled()`

### setHTTPEnabled

    public void setHTTPEnabled(boolean enabled)
                        throws javax.management.InvalidAttributeValueException

### isHTTPSEnabled

    public boolean isHTTPSEnabled()

  Whether or not secure (SSL) HTTP traffic is enabled.

  Default Value: false
  Secure Value: true
  See Also:
    `ServerMBean.isHttpdEnabled()`, `isHTTPEnabled()`, `isTunnelingEnabled()`

### setHTTPSEnabled

    public void setHTTPSEnabled(boolean enabled)
                         throws javax.management.InvalidAttributeValueException

### isCOMEnabled

    public boolean isCOMEnabled()

  Indicates whether or not plaintext (non-SSL) COM traffic is enabled.

  See Also:
    `ServerMBean.isCOMEnabled()`

### setCOMEnabled

    public void setCOMEnabled(boolean enabled)
                       throws javax.management.InvalidAttributeValueException

  Determines whether or not plaintext (non-SSL) COM traffic is enabled.

  Default Value: false
  Secure Value: false

### isOutgoingEnabled

    public boolean isOutgoingEnabled()

  Whether or not new server-to-server connections may consider this channel when initiating.

  Default Value: true
  Secure Value: true
  See Also:
    `NetworkChannelMBean`

### setOutgoingEnabled

    public void setOutgoingEnabled(boolean enabled)
                            throws javax.management.InvalidAttributeValueException

### isBoundOutgoingEnabled

    public boolean isBoundOutgoingEnabled()

  Bind new outgoing server side T3 or T3S connections to the server channel's listen address. Other protocols ignore this field. This field is ignored for connections initiated via URLs, it takes effect if and only if the connection was initiated by accessing a remote reference (such as an EJB or RMI stub.)

  Default Value: false

### getChannelWeight

    public int getChannelWeight()

  A weight to give this channel when creating server-to-server connections.

  Default Value: 50
  Legal Minimum Value: 1
  Legal Maximum Value: 100
  See Also:
    `NetworkChannelMBean`

### setChannelWeight

    public void setChannelWeight(int weight)
                          throws javax.management.InvalidAttributeValueException

### getAcceptBacklog

    public int getAcceptBacklog()

  Allowed backlog of connection requests on the listen port(s). Individual servers may override this value using a NetworkAccessPointMBean. Setting the backlog to 0 may prevent accepting any incoming connection on some of the OS.

  Default Value: 50
  Legal Minimum Value: 0
  See Also:
    `NetworkAccessPointMBean.getAcceptBacklog()`, `ServerMBean.getAcceptBacklog()`

### setAcceptBacklog

    public void setAcceptBacklog(int count)
                          throws javax.management.InvalidAttributeValueException

### getLoginTimeoutMillis

    public int getLoginTimeoutMillis()

  The login timeout for the server, in milliseconds. This value must be equal to or greater than 0. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  Default Value: 5000
  Legal Minimum Value: 0
  Legal Maximum Value: 100000
  Secure Value: 5000
  See Also:
    `NetworkAccessPointMBean.getLoginTimeoutMillis()`, `ServerMBean.getLoginTimeoutMillis()`

### setLoginTimeoutMillis

    public void setLoginTimeoutMillis(int timeout)
                               throws javax.management.InvalidAttributeValueException,
                                      DistributedManagementException

### getLoginTimeoutMillisSSL

    public int getLoginTimeoutMillisSSL()

  Duration allowed for an SSL login sequence. If the duration is exceeded, the login is timed out. 0 to disable. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 25000
  Legal Minimum Value: 0
  Legal Maximum Value: java.lang.Integer.MAX_VALUE
  Secure Value: 25000
  See Also:
    `NetworkAccessPointMBean.getLoginTimeoutMillisSSL()`, `SSLMBean.getLoginTimeoutMillis()`

### setLoginTimeoutMillisSSL

    public void setLoginTimeoutMillisSSL(int millis)

### isTunnelingEnabled

    public boolean isTunnelingEnabled()

  Enables tunneling via http.

  A dynamic MBean attribute
  Default Value: false
  Secure Value: false
  See Also:
    `ServerMBean.isTunnelingEnabled()`, `isHTTPEnabled()`, `isHTTPSEnabled()`

### setTunnelingEnabled

    public void setTunnelingEnabled(boolean enabled)
                             throws DistributedManagementException

### getTunnelingClientPingSecs

    public int getTunnelingClientPingSecs()

  Interval (in seconds) at which to ping an http-tunneled client to see if its still alive. Individual servers may override this value using a NetworkAccessPointMBean.

  Default Value: 45
  Legal Value: (value > 0)
  See Also:
    `ServerMBean.getTunnelingClientPingSecs()`, `NetworkAccessPointMBean.getTunnelingClientPingSecs()`

### setTunnelingClientPingSecs

    public void setTunnelingClientPingSecs(int secs)
                                    throws javax.management.InvalidAttributeValueException

### getTunnelingClientTimeoutSecs

    public int getTunnelingClientTimeoutSecs()

  Duration (in seconds) after which a missing http-tunneled client is considered dead. Individual servers may override this value using a NetworkAccessPointMBean.

  Default Value: 40
  Legal Value: (value > 0)
  Secure Value: 40
  See Also:
    `ServerMBean.getTunnelingClientTimeoutSecs()`, `NetworkAccessPointMBean.getTunnelingClientTimeoutSecs()`

### setTunnelingClientTimeoutSecs

    public void setTunnelingClientTimeoutSecs(int secs)
                                       throws javax.management.InvalidAttributeValueException

### getCompleteT3MessageTimeout

    public int getCompleteT3MessageTimeout()

  The maximum number of seconds spent waiting for a complete T3 message to be received. This attribute helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 60
  Legal Minimum Value: 0
  Legal Maximum Value: 480
  Secure Value: 60
  See Also:
    `KernelMBean.getCompleteT3MessageTimeout()`, `NetworkAccessPointMBean.getCompleteT3MessageTimeout()`

### setCompleteT3MessageTimeout

    public void setCompleteT3MessageTimeout(int seconds)
                                     throws javax.management.InvalidAttributeValueException,
                                            DistributedManagementException

### getCompleteHTTPMessageTimeout

    public int getCompleteHTTPMessageTimeout()

  The maximum number of seconds spent waiting for a complete HTTP message to be received. This attribute helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 60
  Legal Minimum Value: 0
  Legal Maximum Value: 480
  Secure Value: 60
  See Also:
    `KernelMBean.getCompleteHTTPMessageTimeout()`, `NetworkAccessPointMBean.getCompleteHTTPMessageTimeout()`

### setCompleteHTTPMessageTimeout

    public void setCompleteHTTPMessageTimeout(int seconds)
                                       throws javax.management.InvalidAttributeValueException,
                                              DistributedManagementException

### getCompleteCOMMessageTimeout

    public int getCompleteCOMMessageTimeout()

  The maximum number of seconds spent waiting for a complete COM message to be received. This attribute helps guard against denial of service attacks in which a caller indicates that they will be sending a message of a certain size which they never finish sending. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 60
  Legal Minimum Value: 0
  Legal Maximum Value: 480
  Secure Value: 60
  See Also:
    `KernelMBean.getCompleteCOMMessageTimeout()`, `NetworkAccessPointMBean.getCompleteCOMMessageTimeout()`

### setCompleteCOMMessageTimeout

    public void setCompleteCOMMessageTimeout(int seconds)
                                      throws javax.management.InvalidAttributeValueException,
                                             DistributedManagementException

### getMaxT3MessageSize

    public int getMaxT3MessageSize()

  The maximum T3 message size allowable in a message header. This attribute attempts to prevent a denial of service attack whereby a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 10000000
  Legal Minimum Value: 4096
  Legal Maximum Value: 2000000000
  Secure Value: 10000000
  See Also:
    `weblogic.management.configuration.NetworkAccessPointMBean#getMaxT3MessageSize`, `KernelMBean.getMaxT3MessageSize()`

### setMaxT3MessageSize

    public void setMaxT3MessageSize(int maxsize)
                             throws javax.management.InvalidAttributeValueException,
                                    DistributedManagementException

### getMaxHTTPMessageSize

    public int getMaxHTTPMessageSize()

  The maximum HTTP message size allowable in a message header. This attribute attempts to prevent a denial of service attack whereby a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 10000000
  Legal Minimum Value: 4096
  Legal Maximum Value: 2000000000
  Secure Value: 10000000
  See Also:
    `weblogic.management.configuration.NetworkAccessPointMBean#getMaxHTTPMessageSize`, `KernelMBean.getMaxHTTPMessageSize()`

### setMaxHTTPMessageSize

    public void setMaxHTTPMessageSize(int maxsize)
                               throws javax.management.InvalidAttributeValueException,
                                      DistributedManagementException

### getMaxCOMMessageSize

    public int getMaxCOMMessageSize()

  The maximum COM message size allowable in a message header. This attribute attempts to prevent a denial of service attack whereby a caller attempts to force the server to allocate more memory than is available thereby keeping the server from responding quickly to other requests. Individual servers may override this value using a NetworkAccessPointMBean.

  A dynamic MBean attribute
  A configurable MBean attribute
  Default Value: 10000000
  Legal Minimum Value: 4096
  Legal Maximum Value: 2000000000
  Secure Value: 10000000
  See Also:
    `weblogic.management.configuration.NetworkAccessPointMBean#getMaxCOMMessageSize`, `KernelMBean.getMaxCOMMessageSize()`

### setMaxCOMMessageSize

    public void setMaxCOMMessageSize(int maxsize)
                              throws javax.management.InvalidAttributeValueException,
                                     DistributedManagementException

### setIIOPEnabled

    public void setIIOPEnabled(boolean enabled)
                        throws javax.management.InvalidAttributeValueException

### setIIOPSEnabled

    public void setIIOPSEnabled(boolean enabled)
                         throws javax.management.InvalidAttributeValueException

### setCompleteIIOPMessageTimeout

    public void setCompleteIIOPMessageTimeout(int seconds)
                                       throws javax.management.InvalidAttributeValueException,
                                              DistributedManagementException

### setMaxIIOPMessageSize

    public void setMaxIIOPMessageSize(int maxsize)
                               throws javax.management.InvalidAttributeValueException,
                                      DistributedManagementException

### setIdleIIOPConnectionTimeout

    public void setIdleIIOPConnectionTimeout(int seconds)
                                      throws javax.management.InvalidAttributeValueException,
                                             DistributedManagementException

### setDefaultIIOPUser

    public void setDefaultIIOPUser(java.lang.String user)
                            throws javax.management.InvalidAttributeValueException

### setDefaultIIOPPassword

    public void setDefaultIIOPPassword(java.lang.String password)
                                throws javax.management.InvalidAttributeValueException

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://e-docs.bea.com/wls/docs70
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.
WebLogic Server 7.0 API Reference