NetworkAccessPointMBean

Overview

A server can specifiy additional network connections by using a NetworkAccessPointMBean. The NetworkAccessPointMBean is also used to set the listen address and external DNS name that a server uses for a particular channel.

Attributes

This section describes the following attributes:

AcceptBacklog

The number of backlogged, new TCP connection requests that this network channel allows. A value of -1 indicates that the network channel obtains its backlog configuration from the server's configuration.

For more information, see:

• ServerTemplateMBean#getAcceptBacklog

CachingDisabled

Private property that disables caching in proxies.

ChannelIdentityCustomized

Whether or not the channel's custom identity should be used. This setting only has an effect if the server is using a customized keystore. By default the channel's identity is inherited from the server's identity.

For more information, see:

• SSLMBean#getServerPrivateKeyAlias
• getCustomPrivateKeyAlias

ChannelWeight

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

ClientCertificateEnforced

Specifies whether clients must present digital certificates from a trusted certificate authority to WebLogic Server on this channel.

ClusterAddress

The address this network channel uses to generate EJB handles and failover addresses for use in a cluster. This value is determined according to the following order of precedence:

1. If the cluster address is specified via the NAPMBean, then that value is used

2. If this value is not specified, the value of PublicAddress is used.

3. If PublicAddress is not set, this value is derive from the ClusterAddress attribute of the ClusterMbean.

4. If ClusterMbean.clusterAddress is not set, this value is derive from the listen address of the NAPMbean.

For more information, see:

• getPublicAddress
• ClusterMBean#getClusterAddress

CompleteMessageTimeout

The maximum amount of time this network channel waits for a complete message to be received. A value of 0 disables network channel complete message timeout. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.

This timeout 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.

ConnectTimeout

The amount of time that this network channel should wait to establish an outbound socket connection before timing out. A value of 0 disables network channel connect timeout.

CustomPrivateKeyAlias

The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. A value of null indicates that the network channel uses the alias specified in the server's SSL configuration.

For more information, see:

• SSLMBean#getServerPrivateKeyAlias

CustomPrivateKeyPassPhrase

The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. A value of null indicates that the network channel uses the pass phrase specified in the server's SSL configuration.

For more information, see:

• SSLMBean#getServerPrivateKeyPassPhrase

CustomPrivateKeyPassPhraseEncrypted

The encrypted form of passphrase used to retrieve the server's private key from the keystore.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

Enabled

Specifies whether this channel should be started.

HttpEnabledForThisProtocol

Specifies whether HTTP traffic should be allowed over this network channel.

HTTP is generally required by binary protocols for downloading stubs and other resources.

Id

Return the unique id of this MBean instance

IdleConnectionTimeout

The maximum amount of time (in seconds) that a connection is allowed to be idle before it is closed by this network channel. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean.

This timeout helps guard against server deadlock through too many open connections.

ListenAddress

The IP address or DNS name this network channel uses to listen for incoming connections. A value of null indicates that the network channel should obtain this value from the server's configuration.

For more information, see:

• ServerTemplateMBean#getListenAddress

ListenPort

The default TCP port this network channel uses to listen for regular (non-SSL) incoming connections. A value of -1 indicates that the network channel should obtain this value from the server's configuration.

For more information, see:

• ServerTemplateMBean#getListenPort

LoginTimeoutMillis

The amount of time that this network channel should wait for a connection before timing out. A value of 0 disables network channel login timeout. A value of -1 indicates that the network channel obtains this timeout value from the server's configuration.

For more information, see:

• ServerTemplateMBean#getLoginTimeoutMillis

MaxBackoffBetweenFailures

The maximum back off time between failures while accepting client connections. -1 implies that this value is inherited from the server.

MaxConnectedClients

The maximum number of clients that can be connected on this network channel.

MaxMessageSize

The maximum message size allowable in a message header.

This maximum 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.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

Name

The name of this network channel.

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. 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.

ObjectName

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

Deprecated.

OutboundEnabled

Specifies whether new server-to-server connections may consider this network channel when initiating a connection. This is only relevant if the connection needs to be bound to the network channel's listen address. This will only work for binary protocols that support both outbound and inbound traffic.

When this feature is not enabled, connections are initiated using a local address selected by the underlying hardware.

The default is false.

Outbound channels are selected at runtime either by virtue of the fact of being the only outbound-enabled channel for the required protocol, or by name in weblogic.jndi.Environment#setProviderChannel.

The HTTP protocol is implicitly enabled for all the outbound channels, but you need to use the WLS client library (HTTP client) and set the channel on the connection.

For more information, see:

• HttpURLConnection#setSocketFactory

OutboundPrivateKeyAlias

The string alias used to store and retrieve the outbound private key in the keystore. This private key is associated with either a server or a client digital certificate. This attribute value is derived from other settings and cannot be physically set.

The returned value is determined as follows:

• If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from CustomPrivateKeyAlias is returned.

• Otherwise, the value from SSLMBean#getOutboundPrivateKeyAlias is returned from the ServerMBean for the channel.

For more information, see:

• isOutboundPrivateKeyEnabled
• isChannelIdentityCustomized
• getCustomPrivateKeyAlias
• SSLMBean#getOutboundPrivateKeyAlias

OutboundPrivateKeyEnabled

Specifies whether the identity specifed by CustomPrivateKeyAlias should be used for outbound SSL connections on this channel. In normal circumstances the outbound identity is determined by the caller's environment.

OutboundPrivateKeyPassPhrase

The passphrase used to retrieve the outbound private key from the keystore. This passphrase is assigned to the private key when it is generated. This attribute value is derived from other settings and cannot be physically set.

The returned value is determined as follows:

• If isOutboundPrivateKeyEnabled and isChannelIdentityCustomized return true, the value from CustomPrivateKeyPassPhrase is returned.

• Otherwise, the value from SSLMBean#getOutboundPrivateKeyPassPhrase is returned from the ServerMBean for the channel.

For more information, see:

• isOutboundPrivateKeyEnabled
• isChannelIdentityCustomized
• getCustomPrivateKeyPassPhrase
• SSLMBean#getOutboundPrivateKeyPassPhrase

Parent

Return the immediate parent for this MBean

PrivateKeyAlias

The string alias used to store and retrieve the channel's private key in the keystore. This private key is associated with the server's digital certificate. This value is derived from other settings on the channel and cannot be physically set.

For more information, see:

• SSLMBean#getServerPrivateKeyAlias
• getCustomPrivateKeyAlias

PrivateKeyPassPhrase

The passphrase used to retrieve the server's private key from the keystore. This passphrase is assigned to the private key when it is generated. This value is derived from other settings on the channel and cannot be physically set.

For more information, see:

• SSLMBean#getServerPrivateKeyPassPhrase
• getCustomPrivateKeyPassPhrase

Protocol

The protocol this network channel should use for connections.

ProxyAddress

The IP address or DNS name of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.

This option is only effective when OutboundEnabled is set on the channel.

ProxyPort

The port of the HTTP proxy to use for outbound connections on this channel. The HTTP proxy must support the CONNECT tunneling command.

This option is only effective when OutboundEnabled and ProxyHost are set on the channel.

PublicAddress

The IP address or DNS name representing the external identity of this network channel. A value of null indicates that the network channel's Listen Address is also its external address. If the Listen Address is null,the network channel obtains its external identity from the server's configuration.

This is required for the configurations which need to cross a firewall doing Network Address Translation.

For more information, see:

• getExternalDNSName
• getListenAddress
• ServerTemplateMBean#getListenAddress

PublicPort

The externally published listen port for this network channel. A value of -1 indicates that the network channel's Listen Port is also its public listen port. If the Listen Port is -1,the network channel obtains its public listen port from the server's configuration.

For more information, see:

• getListenPort
• ServerTemplateMBean#getListenPort

Registered

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

Deprecated.

SDPEnabled

Enables Socket Direct Protocol (SDP) on this channel. Enable this attribute when configuring session replication enhancements for Managed Servers in a WebLogic cluster for Oracle Exalogic.

TimeoutConnectionWithPendingResponses

Determines if connections with pending responses are allowed to timeout. It defaults to false. If set to true, the connection will be timed out for this channel if it exceeds the idleConnectionTimeout value.

Note: This setting only applies to IIOP connections.

TunnelingClientPingSecs

The interval (in seconds) at which this network channel should ping an HTTP-tunneled client to see if its still alive. A value of -1 indicates that the network channel obtains this interval from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)

For more information, see:

• ServerTemplateMBean#getTunnelingClientPingSecs
• isTunnelingEnabled

TunnelingClientTimeoutSecs

The amount of time (in seconds) after which this network channel considers a missing HTTP-tunneled client to be dead. A value of -1 indicates that the network channel obtains this timeout value from the ServerTemplateMBean. (Requires you to enable tunneling for the network channel.)

For more information, see:

• ServerTemplateMBean#getTunnelingClientTimeoutSecs
• isTunnelingEnabled

TunnelingEnabled

Specifies whether tunneling via HTTP should be enabled for this network channel. This value is not inherited from the server's configuration.

TwoWaySSLEnabled

Specifies whether this network channel uses two way SSL.

Type

Returns the type of the MBean.

UseFastSerialization

Specifies whether to use non-standard object serialization for performance. This option works in different ways for different protocols. In particular under IIOP this option uses Java serialization rather than RMI-IIOP serialization. In general using non-standard serialization is not suitable for interop scenarios and may imply some feature loss.

Operations

This section describes the following operations:

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

getInheritedProperties

return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

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

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

unSet

Restore the given property to its default value.