NetworkChannelMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

Deprecated. 7.0.0.0 use NetworkAccessPointMBean

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.NetworkChannelMBean

For more information, see:

Factory Methods
Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


      Targets

      You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

             
      Privileges Read/Write
      TypeTargetMBean[]
      Relationship type: Reference.


      Attributes

      This section describes the following attributes:


      AcceptBacklog

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value50
      Minimum value0

      BoundOutgoingEnabled

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

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      CachingDisabled

      Private property that disables caching in proxies.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      ChannelWeight

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

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value50
      Minimum value1
      Maximum value100

      ClusterAddress

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

      For more information, see:

             
      Privileges Read/Write
      Typejava.lang.String

      COMEnabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      CompleteCOMMessageTimeout

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value60
      Minimum value0
      Maximum value480
      Secure value60

      CompleteHTTPMessageTimeout

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value60
      Minimum value0
      Maximum value480
      Secure value60

      CompleteT3MessageTimeout

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value60
      Minimum value0
      Maximum value480
      Secure value60

      DefaultIIOPPasswordEncrypted

      The encrypted password for the default IIOP user.

      To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

      For more information, see:

             
      Privileges Read/Write
      Typebyte[]
      Encryptedtrue

      DeploymentOrder

      A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

      For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

      Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

             
      Privileges Read/Write
      Typeint
      Default Value1000
      Minimum value0
      Maximum value2147483647

      Description

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

             
      Privileges Read/Write
      Typejava.lang.String

      HTTPEnabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      HTTPSEnabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean
      Secure valuetrue

      ListenPort

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value8001
      Minimum value1
      Maximum value65534

      ListenPortEnabled

      Whether or not plaintext port is enabled for the channel.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      LoginTimeoutMillis

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value5000
      Minimum value0
      Maximum value100000
      Secure value5000

      LoginTimeoutMillisSSL

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value25000
      Minimum value0
      Maximum value2147483647
      Secure value25000

      MaxCOMMessageSize

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value10000000
      Minimum value4096
      Maximum value2000000000
      Secure value10000000

      MaxHTTPMessageSize

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value10000000
      Minimum value4096
      Maximum value2000000000
      Secure value10000000

      MaxT3MessageSize

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value10000000
      Minimum value4096
      Maximum value2000000000
      Secure value10000000

      MBeanInfo

      Returns the MBean info for this MBean.

      Deprecated.

             
      Privileges Read only
      Typejavax.management.MBeanInfo
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Name

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

             
      Privileges Read/Write
      Typejava.lang.String

      Notes

      Optional information that you can include to describe this configuration.

      WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

      Note:

      If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

             
      Privileges Read/Write
      Typejava.lang.String

      ObjectName

      Returns the ObjectName under which this MBean is registered in the MBean server.

      Deprecated.

             
      Privileges Read only
      Typeweblogic.management.WebLogicObjectName
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      OutgoingEnabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean
      Secure valuetrue

      Parent

      Return the immediate parent for this MBean

             
      Privileges Read/Write
      Type

      Registered

      Returns false if the the MBean represented by this object has been unregistered.

      Deprecated.

             
      Privileges Read only
      Typeboolean
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      SSLListenPort

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value8002
      Minimum value1
      Maximum value65534

      SSLListenPortEnabled

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean
      Secure valuetrue

      T3Enabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      T3SEnabled

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

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      TunnelingClientPingSecs

      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.

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value45
      Minimum value1

      TunnelingClientTimeoutSecs

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

      For more information, see:

             
      Privileges Read/Write
      Typeint
      Default Value40
      Minimum value1
      Secure value40

      TunnelingEnabled

      Enables tunneling via http.

      For more information, see:

             
      Privileges Read/Write
      Typeboolean

      Type

      Returns the type of the MBean.

             
      Privileges Read only
      Typejava.lang.String
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


      Operations

      This section describes the following operations:


      addTarget

      You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

         
      Operation Name"addTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        The feature to be added to the Target attribute

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      freezeCurrentValue

      If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

      Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

      Note:

      To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

      Deprecated. 9.0.0.0

         
      Operation Name"freezeCurrentValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException
      • javax.management.MBeanException

      isSet

      Returns true if the specified attribute has been set explicitly in this MBean instance.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check

      SignatureString [] { "java.lang.String" }
      Returns boolean

      removeTarget

      Removes the value of the addTarget attribute.

      For more information, see:

         
      Operation Name"removeTarget"
      ParametersObject [] {  target }

      where:

      • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

        target

      SignatureString [] { "weblogic.management.configuration.TargetMBean" }
      Returns boolean
      Exceptions
      • javax.management.InvalidAttributeValueException
      • weblogic.management.DistributedManagementException

      restoreDefaultValue

      If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

      Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

      This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

      Deprecated. 9.0.0.0

         
      Operation Name"restoreDefaultValue"
      ParametersObject [] {  attributeName }

      where:

      • attributeName is an object of type java.lang.String that specifies:

        attributeName

      SignatureString [] { "java.lang.String" }
      Returns void
      Exceptions
      • javax.management.AttributeNotFoundException

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore

      SignatureString [] { "java.lang.String" }
      Returns void