weblogic.management.configuration
Interface NetworkChannelMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean

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

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

See Also:

ServerMBean.getListenPort(), ServerMBean.getAdministrationPort(), SSLMBean.getListenPort(), KernelMBean.getSSL(), NetworkAccessPointMBean, ServerMBean.getNetworkAccessPoints()

getName

String getName()

Deprecated. 

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

Specified by:

getName in interface ConfigurationMBean

Returns:

The name value

setName

void setName(String name)
             throws InvalidAttributeValueException,
                    ManagementException

Deprecated. 

Sets the name attribute of the NetworkChannelMBean object

Specified by:

setName in interface ConfigurationMBean

Parameters:

name - The new name value

Throws:

InvalidAttributeValueException

ManagementException

getDescription

String getDescription()

Deprecated. 

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

Returns:

The description value

Default Value:

null

setDescription

void setDescription(String description)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the description attribute of the NetworkChannelMBean object

Parameters:

description - The new description value

Throws:

InvalidAttributeValueException

getListenPort

int getListenPort()

Deprecated. 

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.

Returns:

The listenPort value

See Also:

NetworkChannelMBean.isListenPortEnabled(), NetworkChannelMBean.getSSLListenPort(), NetworkAccessPointMBean.getListenPort(), NetworkAccessPointMBean.getListenAddress(), NetworkAccessPointMBean.getExternalDNSName(), ServerMBean.getListenPort()

Default Value:

8001

Maximum Value:

65535

Minimum Value:

1

setListenPort

void setListenPort(int port)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the listenPort attribute of the NetworkChannelMBean object

Parameters:

port - The new listenPort value

Throws:

InvalidAttributeValueException

isListenPortEnabled

boolean isListenPortEnabled()

Deprecated. 

Whether or not plaintext port is enabled for the channel.

Returns:

The listenPortEnabled value

See Also:

NetworkChannelMBean.getListenPort(), ServerMBean.isListenPortEnabled()

Default Value:

false

setListenPortEnabled

void setListenPortEnabled(boolean enable)
                          throws InvalidAttributeValueException

Deprecated. 

Sets the listenPortEnabled attribute of the NetworkChannelMBean object

Parameters:

enable - The new listenPortEnabled value

Throws:

InvalidAttributeValueException

getSSLListenPort

int getSSLListenPort()

Deprecated. 

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.

Returns:

The sSLListenPort value

See Also:

NetworkChannelMBean.getSSLListenPort(), NetworkChannelMBean.isSSLListenPortEnabled(), SSLMBean.getListenPort(), KernelMBean.getSSL(), NetworkAccessPointMBean.getSSLListenPort(), NetworkAccessPointMBean.getListenAddress()

Default Value:

8002

Maximum Value:

65535

Minimum Value:

1

setSSLListenPort

void setSSLListenPort(int port)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the sSLListenPort attribute of the NetworkChannelMBean object

Parameters:

port - The new sSLListenPort value

Throws:

InvalidAttributeValueException

isSSLListenPortEnabled

boolean isSSLListenPortEnabled()

Deprecated. 

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.

Returns:

The sSLListenPortEnabled value

See Also:

SSLMBean.isListenPortEnabled(), KernelMBean.getSSL()

Default Value:

false

setSSLListenPortEnabled

void setSSLListenPortEnabled(boolean enable)
                             throws InvalidAttributeValueException

Deprecated. 

Sets the sSLListenPortEnabled attribute of the NetworkChannelMBean object

Parameters:

enable - The new sSLListenPortEnabled value

Throws:

InvalidAttributeValueException

getClusterAddress

String getClusterAddress()

Deprecated. 

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

Returns:

The clusterAddress value

See Also:

ClusterMBean.getClusterAddress()

Default Value:

null

setClusterAddress

void setClusterAddress(String address)
                       throws InvalidAttributeValueException

Deprecated. 

Sets the clusterAddress attribute of the NetworkChannelMBean object

Parameters:

address - The new clusterAddress value

Throws:

InvalidAttributeValueException

isT3Enabled

boolean isT3Enabled()

Deprecated. 

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

Returns:

The t3Enabled value

See Also:

NetworkChannelMBean, NetworkChannelMBean.isT3SEnabled()

Default Value:

false

setT3Enabled

void setT3Enabled(boolean enabled)
                  throws InvalidAttributeValueException

Deprecated. 

Sets the t3Enabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new t3Enabled value

Throws:

InvalidAttributeValueException

isT3SEnabled

boolean isT3SEnabled()

Deprecated. 

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

Returns:

The t3SEnabled value

See Also:

NetworkChannelMBean, NetworkChannelMBean.isT3Enabled()

Default Value:

false

setT3SEnabled

void setT3SEnabled(boolean enabled)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the t3SEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new t3SEnabled value

Throws:

InvalidAttributeValueException

isHTTPEnabled

boolean isHTTPEnabled()

Deprecated. 

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

Returns:

The hTTPEnabled value

See Also:

ServerMBean.isHttpdEnabled(), NetworkChannelMBean.isHTTPSEnabled(), NetworkChannelMBean.isTunnelingEnabled()

Default Value:

false

setHTTPEnabled

void setHTTPEnabled(boolean enabled)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the hTTPEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new hTTPEnabled value

Throws:

InvalidAttributeValueException

isHTTPSEnabled

boolean isHTTPSEnabled()

Deprecated. 

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

Returns:

The hTTPSEnabled value

See Also:

ServerMBean.isHttpdEnabled(), NetworkChannelMBean.isHTTPEnabled(), NetworkChannelMBean.isTunnelingEnabled()

Default Value:

false

setHTTPSEnabled

void setHTTPSEnabled(boolean enabled)
                     throws InvalidAttributeValueException

Deprecated. 

Sets the hTTPSEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new hTTPSEnabled value

Throws:

InvalidAttributeValueException

isCOMEnabled

boolean isCOMEnabled()

Deprecated. 

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

Returns:

The cOMEnabled value

See Also:

ServerMBean.isCOMEnabled()

Default Value:

false

setCOMEnabled

void setCOMEnabled(boolean enabled)
                   throws InvalidAttributeValueException

Deprecated. 

Sets the cOMEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new cOMEnabled value

Throws:

InvalidAttributeValueException

isOutgoingEnabled

boolean isOutgoingEnabled()

Deprecated. 

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

Returns:

The outgoingEnabled value

See Also:

NetworkChannelMBean

Default Value:

false

setOutgoingEnabled

void setOutgoingEnabled(boolean enabled)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the outgoingEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new outgoingEnabled value

Throws:

InvalidAttributeValueException

isBoundOutgoingEnabled

boolean isBoundOutgoingEnabled()

Deprecated. 

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

Returns:

The boundOutgoingEnabled value

Default Value:

false

getChannelWeight

int getChannelWeight()

Deprecated. 

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

Returns:

The channelWeight value

See Also:

NetworkChannelMBean

Default Value:

50

Maximum Value:

100

Minimum Value:

1

setChannelWeight

void setChannelWeight(int weight)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the channelWeight attribute of the NetworkChannelMBean object

Parameters:

weight - The new channelWeight value

Throws:

InvalidAttributeValueException

getAcceptBacklog

int getAcceptBacklog()

Deprecated. 

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.

Returns:

The acceptBacklog value

See Also:

NetworkAccessPointMBean.getAcceptBacklog(), ServerMBean.getAcceptBacklog()

Default Value:

50

Minimum Value:

0

setAcceptBacklog

void setAcceptBacklog(int count)
                      throws InvalidAttributeValueException

Deprecated. 

Sets the acceptBacklog attribute of the NetworkChannelMBean object

Parameters:

count - The new acceptBacklog value

Throws:

InvalidAttributeValueException

getLoginTimeoutMillis

int getLoginTimeoutMillis()

Deprecated. 

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.

Returns:

The loginTimeoutMillis value

See Also:

NetworkAccessPointMBean.getLoginTimeoutMillis(), ServerMBean.getLoginTimeoutMillis()

Default Value:

5000

Maximum Value:

100000

Minimum Value:

0

setLoginTimeoutMillis

void setLoginTimeoutMillis(int timeout)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the loginTimeoutMillis attribute of the NetworkChannelMBean object

Parameters:

timeout - The new loginTimeoutMillis value

Throws:

InvalidAttributeValueException

DistributedManagementException

getLoginTimeoutMillisSSL

int getLoginTimeoutMillisSSL()

Deprecated. 

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.

Returns:

The loginTimeoutMillisSSL value

See Also:

NetworkAccessPointMBean.getLoginTimeoutMillisSSL(), SSLMBean.getLoginTimeoutMillis()

Default Value:

25000

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setLoginTimeoutMillisSSL

void setLoginTimeoutMillisSSL(int millis)

Deprecated. 

Sets the loginTimeoutMillisSSL attribute of the NetworkChannelMBean object

Parameters:

millis - The new loginTimeoutMillisSSL value

isTunnelingEnabled

boolean isTunnelingEnabled()

Deprecated. 

Enables tunneling via http.

Returns:

The tunnelingEnabled value

See Also:

ServerMBean.isTunnelingEnabled(), NetworkChannelMBean.isHTTPEnabled(), NetworkChannelMBean.isHTTPSEnabled()

Default Value:

false

setTunnelingEnabled

void setTunnelingEnabled(boolean enabled)
                         throws DistributedManagementException

Deprecated. 

Sets the tunnelingEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new tunnelingEnabled value

Throws:

DistributedManagementException

getTunnelingClientPingSecs

int getTunnelingClientPingSecs()

Deprecated. 

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.

Returns:

The tunnelingClientPingSecs value

See Also:

ServerMBean.getTunnelingClientPingSecs(), NetworkAccessPointMBean.getTunnelingClientPingSecs()

Default Value:

45

Minimum Value:

1

setTunnelingClientPingSecs

void setTunnelingClientPingSecs(int secs)
                                throws InvalidAttributeValueException

Deprecated. 

Sets the tunnelingClientPingSecs attribute of the NetworkChannelMBean object

Parameters:

secs - The new tunnelingClientPingSecs value

Throws:

InvalidAttributeValueException

getTunnelingClientTimeoutSecs

int getTunnelingClientTimeoutSecs()

Deprecated. 

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

Returns:

The tunnelingClientTimeoutSecs value

See Also:

ServerMBean.getTunnelingClientTimeoutSecs(), NetworkAccessPointMBean.getTunnelingClientTimeoutSecs()

Default Value:

40

Minimum Value:

1

setTunnelingClientTimeoutSecs

void setTunnelingClientTimeoutSecs(int secs)
                                   throws InvalidAttributeValueException

Deprecated. 

Sets the tunnelingClientTimeoutSecs attribute of the NetworkChannelMBean object

Parameters:

secs - The new tunnelingClientTimeoutSecs value

Throws:

InvalidAttributeValueException

getCompleteT3MessageTimeout

int getCompleteT3MessageTimeout()

Deprecated. 

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.

Returns:

The completeT3MessageTimeout value

See Also:

KernelMBean.getCompleteT3MessageTimeout(), NetworkAccessPointMBean.getCompleteT3MessageTimeout()

Default Value:

60

Maximum Value:

480

Minimum Value:

0

setCompleteT3MessageTimeout

void setCompleteT3MessageTimeout(int seconds)
                                 throws InvalidAttributeValueException,
                                        DistributedManagementException

Deprecated. 

Sets the completeT3MessageTimeout attribute of the NetworkChannelMBean object

Parameters:

seconds - The new completeT3MessageTimeout value

Throws:

InvalidAttributeValueException

DistributedManagementException

getCompleteHTTPMessageTimeout

int getCompleteHTTPMessageTimeout()

Deprecated. 

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.

Returns:

The completeHTTPMessageTimeout value

See Also:

KernelMBean.getCompleteHTTPMessageTimeout(), NetworkAccessPointMBean.getCompleteHTTPMessageTimeout()

Default Value:

60

Maximum Value:

480

Minimum Value:

0

setCompleteHTTPMessageTimeout

void setCompleteHTTPMessageTimeout(int seconds)
                                   throws InvalidAttributeValueException,
                                          DistributedManagementException

Deprecated. 

Sets the completeHTTPMessageTimeout attribute of the NetworkChannelMBean object

Parameters:

seconds - The new completeHTTPMessageTimeout value

Throws:

InvalidAttributeValueException

DistributedManagementException

getCompleteCOMMessageTimeout

int getCompleteCOMMessageTimeout()

Deprecated. 

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.

Returns:

The completeCOMMessageTimeout value

See Also:

KernelMBean.getCompleteCOMMessageTimeout(), NetworkAccessPointMBean.getCompleteCOMMessageTimeout()

Default Value:

60

Maximum Value:

480

Minimum Value:

0

setCompleteCOMMessageTimeout

void setCompleteCOMMessageTimeout(int seconds)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Deprecated. 

Sets the completeCOMMessageTimeout attribute of the NetworkChannelMBean object

Parameters:

seconds - The new completeCOMMessageTimeout value

Throws:

InvalidAttributeValueException

DistributedManagementException

getMaxT3MessageSize

int getMaxT3MessageSize()

Deprecated. 

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.

Returns:

The maxT3MessageSize value

See Also:

weblogic.management.configuration.NetworkAccessPointMBean#getMaxT3MessageSize, KernelMBean.getMaxT3MessageSize()

Default Value:

10000000

Maximum Value:

2000000000

Minimum Value:

4096

setMaxT3MessageSize

void setMaxT3MessageSize(int maxsize)
                         throws InvalidAttributeValueException,
                                DistributedManagementException

Deprecated. 

Sets the maxT3MessageSize attribute of the NetworkChannelMBean object

Parameters:

maxsize - The new maxT3MessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

getMaxHTTPMessageSize

int getMaxHTTPMessageSize()

Deprecated. 

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.

Returns:

The maxHTTPMessageSize value

See Also:

weblogic.management.configuration.NetworkAccessPointMBean#getMaxHTTPMessageSize, KernelMBean.getMaxHTTPMessageSize()

Default Value:

10000000

Maximum Value:

2000000000

Minimum Value:

4096

setMaxHTTPMessageSize

void setMaxHTTPMessageSize(int maxsize)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the maxHTTPMessageSize attribute of the NetworkChannelMBean object

Parameters:

maxsize - The new maxHTTPMessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

getMaxCOMMessageSize

int getMaxCOMMessageSize()

Deprecated. 

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.

Returns:

The maxCOMMessageSize value

See Also:

weblogic.management.configuration.NetworkAccessPointMBean#getMaxCOMMessageSize, KernelMBean.getMaxCOMMessageSize()

Default Value:

10000000

Maximum Value:

2000000000

Minimum Value:

4096

setMaxCOMMessageSize

void setMaxCOMMessageSize(int maxsize)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Deprecated. 

Sets the maxCOMMessageSize attribute of the NetworkChannelMBean object

Parameters:

maxsize - The new maxCOMMessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

setIIOPEnabled

void setIIOPEnabled(boolean enabled)
                    throws InvalidAttributeValueException

Deprecated. 

Sets the iIOPEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new iIOPEnabled value

Throws:

InvalidAttributeValueException

setIIOPSEnabled

void setIIOPSEnabled(boolean enabled)
                     throws InvalidAttributeValueException

Deprecated. 

Sets the iIOPSEnabled attribute of the NetworkChannelMBean object

Parameters:

enabled - The new iIOPSEnabled value

Throws:

InvalidAttributeValueException

setCompleteIIOPMessageTimeout

void setCompleteIIOPMessageTimeout(int seconds)
                                   throws InvalidAttributeValueException,
                                          DistributedManagementException

Deprecated. 

Sets the completeIIOPMessageTimeout attribute of the NetworkChannelMBean object

Parameters:

seconds - The new completeIIOPMessageTimeout value

Throws:

InvalidAttributeValueException

DistributedManagementException

setMaxIIOPMessageSize

void setMaxIIOPMessageSize(int maxsize)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Deprecated. 

Sets the maxIIOPMessageSize attribute of the NetworkChannelMBean object

Parameters:

maxsize - The new maxIIOPMessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

setIdleIIOPConnectionTimeout

void setIdleIIOPConnectionTimeout(int seconds)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Deprecated. 

Sets the idleIIOPConnectionTimeout attribute of the NetworkChannelMBean object

Parameters:

seconds - The new idleIIOPConnectionTimeout value

Throws:

InvalidAttributeValueException

DistributedManagementException

setDefaultIIOPUser

void setDefaultIIOPUser(String user)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the defaultIIOPUser attribute of the NetworkChannelMBean object

Parameters:

user - The new defaultIIOPUser value

Throws:

InvalidAttributeValueException

setDefaultIIOPPassword

void setDefaultIIOPPassword(String password)
                            throws InvalidAttributeValueException

Deprecated. 

Sets the defaultIIOPPassword attribute of the NetworkChannelMBean object

Parameters:

password - The new defaultIIOPPassword value

Throws:

InvalidAttributeValueException

setDefaultIIOPPasswordEncrypted

void setDefaultIIOPPasswordEncrypted(byte[] bytes)

Deprecated. 

Encrypts and sets the defaultIIOPPassword attribute.

Parameters:

bytes - The new DefaultIIOPPasswordEncrypted value as a byte array.

See Also:

NetworkChannelMBean.getDefaultIIOPPasswordEncrypted()