Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface NetworkAccessPointMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean
public interface NetworkAccessPointMBean
extends ConfigurationMBean

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.

See Also:
ServerTemplateMBean, ServerTemplateMBean.getNetworkAccessPoints()

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 int getAcceptBacklog()
          The number of backlogged, new TCP connection requests that this network channel allows.
 int getChannelWeight()
          A weight to give this channel when creating server-to-server connections.
 String getClusterAddress()
          The address this network channel uses to generate EJB handles and failover addresses for use in a cluster.
 int getCompleteMessageTimeout()
          The maximum amount of time this network channel waits for a complete message to be received.
 int getConnectTimeout()
          The amount of time that this network channel should wait to establish an outbound socket connection before timing out.
 String getCustomPrivateKeyAlias()
          The string alias used to store and retrieve the channel's private key in the keystore.
 String getCustomPrivateKeyPassPhrase()
          The passphrase used to retrieve the server's private key from the keystore.
 byte[] getCustomPrivateKeyPassPhraseEncrypted()
          The encrypted form of passphrase used to retrieve the server's private key from the keystore.
 int getIdleConnectionTimeout()
          The maximum amount of time (in seconds) that a connection is allowed to be idle before it is closed by this network channel.
 String getListenAddress()
          The IP address or DNS name this network channel uses to listen for incoming connections.
 int getListenPort()
          The default TCP port this network channel uses to listen for regular (non-SSL) incoming connections.
 int getLoginTimeoutMillis()
          The amount of time that this network channel should wait for a connection before timing out.
 int getMaxBackoffBetweenFailures()
          The maximum back off time between failures while accepting client connections.
 int getMaxConnectedClients()
          The maximum number of clients that can be connected on this network channel.
 int getMaxMessageSize()
          The maximum message size allowable in a message header.
 String getName()
          The name of this network channel.
 String getOutboundPrivateKeyAlias()
          The string alias used to store and retrieve the outbound private key in the keystore.
 String getOutboundPrivateKeyPassPhrase()
          The passphrase used to retrieve the outbound private key from the keystore.
 String getPrivateKeyAlias()
          The string alias used to store and retrieve the channel's private key in the keystore.
 String getPrivateKeyPassPhrase()
          The passphrase used to retrieve the server's private key from the keystore.
 String getProtocol()
          The protocol this network channel should use for connections.
 String getProxyAddress()
          The IP address or DNS name of the HTTP proxy to use for outbound connections on this channel.
 int getProxyPort()
          The port of the HTTP proxy to use for outbound connections on this channel.
 String getPublicAddress()
          The IP address or DNS name representing the external identity of this network channel.
 int getPublicPort()
          The externally published listen port for this network channel.
 boolean getTimeoutConnectionWithPendingResponses()
          Determines if connections with pending responses are allowed to timeout.
 int getTunnelingClientPingSecs()
          The interval (in seconds) at which this network channel should ping an HTTP-tunneled client to see if its still alive.
 int getTunnelingClientTimeoutSecs()
          The amount of time (in seconds) after which this network channel considers a missing HTTP-tunneled client to be dead.
 boolean getUseFastSerialization()
          Specifies whether to use non-standard object serialization for performance.
 boolean isChannelIdentityCustomized()
          Whether or not the channel's custom identity should be used.
 boolean isClientCertificateEnforced()
          Specifies whether clients must present digital certificates from a trusted certificate authority to WebLogic Server on this channel.
 boolean isEnabled()
          Specifies whether this channel should be started.
 boolean isHttpEnabledForThisProtocol()
          Specifies whether HTTP traffic should be allowed over this network channel.
 boolean isOutboundEnabled()
          Specifies whether new server-to-server connections may consider this network channel when initiating a connection.
 boolean isOutboundPrivateKeyEnabled()
          Specifies whether the identity specifed by NetworkAccessPointMBean.getCustomPrivateKeyAlias() should be used for outbound SSL connections on this channel.
 boolean isSDPEnabled()
          Enables Socket Direct Protocol (SDP) on this channel.
 boolean isTunnelingEnabled()
          Specifies whether tunneling via HTTP should be enabled for this network channel.
 boolean isTwoWaySSLEnabled()
          Specifies whether this network channel uses two way SSL.
 void setAcceptBacklog(int count)
          Sets the value of the AcceptBacklog attribute.
 void setChannelIdentityCustomized(boolean val)
          Sets the value of the ChannelIdentityCustomized attribute.
 void setChannelWeight(int weight)
          Sets the value of the ChannelWeight attribute.
 void setClientCertificateEnforced(boolean enforce)
          Sets the value of the ClientCertificateEnabled attribute.
 void setClusterAddress(String address)
          Sets the value of the ClusterAddress attribute.
 void setCompleteCOMMessageTimeout(int seconds)
          Sets the value of the CompleteCOMMessageTimeout attribute.
 void setCompleteHTTPMessageTimeout(int seconds)
          Sets the value of the CompleteHTTPMessageTimeout attribute.
 void setCompleteIIOPMessageTimeout(int seconds)
          Sets the value of the CompleteIIOPMessageTimeout attribute.
 void setCompleteMessageTimeout(int seconds)
          Sets the value of the CompleteMessageTimeout attribute.
 void setCompleteT3MessageTimeout(int seconds)
          Sets the value of the CompleteT3MessageTimeout attribute.
 void setConnectTimeout(int timeout)
          Sets the value of the ConnectTimeout attribute.
 void setCustomPrivateKeyAlias(String alias)
          Sets the value of the PrivateKeyAlias attribute.
 void setCustomPrivateKeyPassPhrase(String phrase)
          Sets the value of the PrivateKeyPassPhrase attribute.
 void setCustomPrivateKeyPassPhraseEncrypted(byte[] passwordEncrypted)
          Sets the encrypted value of the PrivateKeyPassPhrase attribute.
 void setEnabled(boolean enabled)
          Sets the value of the Enabled attribute.
 void setExternalDNSName(String externalDNSName)
          Sets the value of the ExternalDNSName attribute.
 void setHttpEnabledForThisProtocol(boolean enabled)
          Sets the value of the HttpEnabledForThisProtocol attribute.
 void setIdleConnectionTimeout(int seconds)
          Sets the value of the IdleConnectionTimeout attribute.
 void setIdleIIOPConnectionTimeout(int seconds)
          Sets the value of the IdleIIOPConnectionTimeout attribute.
 void setListenAddress(String address)
          Sets the value of the ListenAddress attribute.
 void setListenPort(int port)
          Sets the value of the ListenPort attribute.
 void setLoginTimeoutMillis(int timeout)
          Sets the value of the LoginTimeoutMillis attribute.
 void setLoginTimeoutMillisSSL(int millis)
          Sets the value of the LoginTimeoutMillisSSL attribute.
 void setMaxBackoffBetweenFailures(int milliSeconds)
          Sets the value of the MaxBackoffBetweenFailures attribute.
 void setMaxConnectedClients(int count)
          Sets the value of the MaxConnectedClients attribute.
 void setMaxMessageSize(int maxsize)
          Sets the value of the MaxMessageSize attribute.
 void setName(String name)
          Sets the value of the Name attribute.
 void setOutboundEnabled(boolean enabled)
          Sets the value of the OutboundEnabled attribute.
 void setOutboundPrivateKeyEnabled(boolean enabled)
          Sets the value of the OutboundPrivateKeyEnabled attribute.
 void setProtocol(String protocol)
          Sets the value of the Protocol attribute.
 void setProxyAddress(String address)
          Sets the value of the ProxyAddress attribute.
 void setProxyPort(int port)
          Sets the value of the ProxyPort attribute.
 void setPublicAddress(String address)
          Sets the value of the PublicAddress attribute.
 void setPublicPort(int port)
          Sets the value of the PublicPort attribute.
 void setSDPEnabled(boolean enable)
          Set whether the channel should be using SDP protocol.
 void setSSLListenPort(int port)
          Sets the value of the SLListenPort attribute.
 void setTimeoutConnectionWithPendingResponses(boolean timeout)
          Sets the value of the TimeoutConnectionWithPendingResponses attribute.
 void setTunnelingClientPingSecs(int secs)
          Sets the value of the TunnelingClientPingSecs attribute.
 void setTunnelingClientTimeoutSecs(int secs)
          Sets the value of the TunnelingClientTimeoutSecs attribute.
 void setTunnelingEnabled(boolean enabled)
          Sets the value of the TunnelingEnabled attribute.
 void setTwoWaySSLEnabled(boolean enabled)
          Sets the value of the TwoWaySSLEnabled attribute.
 void setUseFastSerialization(boolean enabled)
          Sets the value of the UseFastSerialization attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, unSet
 
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
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 

Method Detail

getName

String getName()

The name of this network channel.

Specified by:
getName in interface ConfigurationMBean
Specified by:
getName in interface WebLogicMBean
Returns:
The name value
Default Value:
""

setName

void setName(String name)
             throws InvalidAttributeValueException

Sets the value of the Name attribute.

Specified by:
setName in interface ConfigurationMBean
Parameters:
name - The new name value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getName()

getProtocol

String getProtocol()

The protocol this network channel should use for connections.

Returns:
The protocol value
Default Value:
"t3"

setProtocol

void setProtocol(String protocol)
                 throws InvalidAttributeValueException

Sets the value of the Protocol attribute.

Parameters:
protocol - The new protocol value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getProtocol()

getListenAddress

String getListenAddress()

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.

Returns:
The listenAddress value
See Also:
ServerTemplateMBean.getListenAddress()

setListenAddress

void setListenAddress(String address)
                      throws InvalidAttributeValueException

Sets the value of the ListenAddress attribute.

Parameters:
address - The new listenAddress value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getListenAddress()

getPublicAddress

String getPublicAddress()

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.

Returns:
The publicAddress value
See Also:
NetworkAccessPointMBean.getExternalDNSName(), NetworkAccessPointMBean.getListenAddress(), ServerTemplateMBean.getListenAddress()

setPublicAddress

void setPublicAddress(String address)
                      throws InvalidAttributeValueException

Sets the value of the PublicAddress attribute.

Parameters:
address - The new publicAddress value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getPublicAddress()

getListenPort

int getListenPort()

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.

Returns:
The listenPort value
See Also:
ServerTemplateMBean.getListenPort()

setListenPort

void setListenPort(int port)
                   throws InvalidAttributeValueException

Sets the value of the ListenPort attribute.

Parameters:
port - The new listenPort value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getListenPort()

getPublicPort

int getPublicPort()

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.

Returns:
The publicPort value
See Also:
NetworkAccessPointMBean.getListenPort(), ServerTemplateMBean.getListenPort()

setPublicPort

void setPublicPort(int port)
                   throws InvalidAttributeValueException

Sets the value of the PublicPort attribute.

Parameters:
port - The new publicPort value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getPublicPort()

getProxyAddress

String getProxyAddress()

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.

Returns:
The proxyAddress value
Default Value:
null

setProxyAddress

void setProxyAddress(String address)
                     throws InvalidAttributeValueException

Sets the value of the ProxyAddress attribute.

Parameters:
address - The new proxyAddress value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getProxyAddress()

getProxyPort

int getProxyPort()

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.

Returns:
The proxyPort value
Default Value:
80

setProxyPort

void setProxyPort(int port)
                  throws InvalidAttributeValueException

Sets the value of the ProxyPort attribute.

Parameters:
port - The new proxyPort value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getProxyPort()

isHttpEnabledForThisProtocol

boolean isHttpEnabledForThisProtocol()

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

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

Returns:
The httpEnabledForThisProtocol value
Default Value:
true

setHttpEnabledForThisProtocol

void setHttpEnabledForThisProtocol(boolean enabled)
                                   throws InvalidAttributeValueException

Sets the value of the HttpEnabledForThisProtocol attribute.

Parameters:
enabled - The new httpEnabledForThisProtocol value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.isHttpEnabledForThisProtocol()

getAcceptBacklog

int getAcceptBacklog()

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.

Returns:
The acceptBacklog value
See Also:
ServerTemplateMBean.getAcceptBacklog()
Minimum Value:
0

setAcceptBacklog

void setAcceptBacklog(int count)
                      throws InvalidAttributeValueException

Sets the value of the AcceptBacklog attribute.

Parameters:
count - The new acceptBacklog value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getAcceptBacklog()

getMaxBackoffBetweenFailures

int getMaxBackoffBetweenFailures()

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

Minimum Value:
0

setMaxBackoffBetweenFailures

void setMaxBackoffBetweenFailures(int milliSeconds)
                                  throws InvalidAttributeValueException

Sets the value of the MaxBackoffBetweenFailures attribute.

Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getMaxBackoffBetweenFailures()

getLoginTimeoutMillis

int getLoginTimeoutMillis()

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.

Returns:
The loginTimeoutMillis value
See Also:
ServerTemplateMBean.getLoginTimeoutMillis()
Maximum Value:
100000
Minimum Value:
0

setLoginTimeoutMillis

void setLoginTimeoutMillis(int timeout)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Sets the value of the LoginTimeoutMillis attribute.

Parameters:
timeout - The new loginTimeoutMillis value
Throws:
InvalidAttributeValueException
DistributedManagementException

getTunnelingClientPingSecs

int getTunnelingClientPingSecs()

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

Returns:
The tunnelingClientPingSecs value
See Also:
ServerTemplateMBean.getTunnelingClientPingSecs(), NetworkAccessPointMBean.isTunnelingEnabled()
Minimum Value:
1

setTunnelingClientPingSecs

void setTunnelingClientPingSecs(int secs)
                                throws InvalidAttributeValueException

Sets the value of the TunnelingClientPingSecs attribute.

Parameters:
secs - The new tunnelingClientPingSecs value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getTunnelingClientPingSecs()

getTunnelingClientTimeoutSecs

int getTunnelingClientTimeoutSecs()

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

Returns:
The tunnelingClientTimeoutSecs value
See Also:
ServerTemplateMBean.getTunnelingClientTimeoutSecs(), NetworkAccessPointMBean.isTunnelingEnabled()
Minimum Value:
1

setTunnelingClientTimeoutSecs

void setTunnelingClientTimeoutSecs(int secs)
                                   throws InvalidAttributeValueException

Sets the value of the TunnelingClientTimeoutSecs attribute.

Parameters:
secs - The new tunnelingClientTimeoutSecs value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getTunnelingClientTimeoutSecs()

isTunnelingEnabled

boolean isTunnelingEnabled()

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

Returns:
The tunnelingEnabled value
Default Value:
false

setTunnelingEnabled

void setTunnelingEnabled(boolean enabled)
                         throws InvalidAttributeValueException

Sets the value of the TunnelingEnabled attribute.

Parameters:
enabled - The new tunnelingEnabled value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.isTunnelingEnabled()

getCompleteMessageTimeout

int getCompleteMessageTimeout()

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.

Returns:
The completeMessageTimeout value
Maximum Value:
480
Minimum Value:
0

setCompleteMessageTimeout

void setCompleteMessageTimeout(int seconds)
                               throws InvalidAttributeValueException,
                                      DistributedManagementException

Sets the value of the CompleteMessageTimeout attribute.

Parameters:
seconds - The new completeMessageTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getCompleteMessageTimeout()

getTimeoutConnectionWithPendingResponses

boolean getTimeoutConnectionWithPendingResponses()

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.

Returns:
Whether or not to timeout connections with pending responses
Default Value:
false

setTimeoutConnectionWithPendingResponses

void setTimeoutConnectionWithPendingResponses(boolean timeout)
                                              throws InvalidAttributeValueException,
                                                     DistributedManagementException

Sets the value of the TimeoutConnectionWithPendingResponses attribute.

Parameters:
timeout - Whether or not to timeout connections with pending responses
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getTimeoutConnectionWithPendingResponses()

getIdleConnectionTimeout

int getIdleConnectionTimeout()

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.

Returns:
The idleConnectionTimeout value
Minimum Value:
0

setIdleConnectionTimeout

void setIdleConnectionTimeout(int seconds)
                              throws InvalidAttributeValueException,
                                     DistributedManagementException

Sets the value of the IdleConnectionTimeout attribute.

Parameters:
seconds - The new idleConnectionTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getIdleConnectionTimeout()

getConnectTimeout

int getConnectTimeout()

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.

Returns:
The connectTimeout value
Maximum Value:
240
Minimum Value:
0

setConnectTimeout

void setConnectTimeout(int timeout)
                       throws InvalidAttributeValueException,
                              DistributedManagementException

Sets the value of the ConnectTimeout attribute.

Parameters:
timeout - The new connectTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException

getMaxMessageSize

int getMaxMessageSize()

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.

Returns:
The maxMessageSize value
Maximum Value:
100000000
Minimum Value:
4096

setMaxMessageSize

void setMaxMessageSize(int maxsize)
                       throws InvalidAttributeValueException,
                              DistributedManagementException

Sets the value of the MaxMessageSize attribute.

Parameters:
maxsize - The new maxMessageSize value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getMaxMessageSize()

isOutboundEnabled

boolean isOutboundEnabled()

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.

Returns:
The OutboundEnabled value
See Also:
HttpURLConnection.setSocketFactory(javax.net.SocketFactory)

setOutboundEnabled

void setOutboundEnabled(boolean enabled)
                        throws InvalidAttributeValueException

Sets the value of the OutboundEnabled attribute.

Parameters:
enabled - The new outboundEnabled value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.isOutboundEnabled()

getChannelWeight

int getChannelWeight()

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

Returns:
The channelWeight value
Default Value:
50
Maximum Value:
100
Minimum Value:
1

setChannelWeight

void setChannelWeight(int weight)
                      throws InvalidAttributeValueException

Sets the value of the ChannelWeight attribute.

Parameters:
weight - The new channelWeight value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getChannelWeight()

getClusterAddress

String getClusterAddress()

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.

    5. Returns:
    The clusterAddress value
    See Also:
    NetworkAccessPointMBean.getPublicAddress(), ClusterMBean.getClusterAddress()

setClusterAddress

void setClusterAddress(String address)
                       throws InvalidAttributeValueException

Sets the value of the ClusterAddress attribute.

Parameters:
address - The new clusterAddress value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getClusterAddress()

isEnabled

boolean isEnabled()

Specifies whether this channel should be started.

Returns:
The enabled value
Default Value:
true

setEnabled

void setEnabled(boolean enabled)
                throws InvalidAttributeValueException

Sets the value of the Enabled attribute.

Parameters:
enabled - The new enabled value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.isEnabled()

getMaxConnectedClients

int getMaxConnectedClients()

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

Returns:
The max connected count value
Default Value:
java.lang.Integer.MAX_VALUE

setMaxConnectedClients

void setMaxConnectedClients(int count)
                            throws InvalidAttributeValueException

Sets the value of the MaxConnectedClients attribute.

Parameters:
count - The new count value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getMaxConnectedClients()

isTwoWaySSLEnabled

boolean isTwoWaySSLEnabled()

Specifies whether this network channel uses two way SSL.

Returns:
The TwoWaySSLEnabled value
Default Value:
false

setTwoWaySSLEnabled

void setTwoWaySSLEnabled(boolean enabled)

Sets the value of the TwoWaySSLEnabled attribute.

Parameters:
enabled - The new twoWaySSLEnabled value
See Also:
NetworkAccessPointMBean.isTwoWaySSLEnabled()

isChannelIdentityCustomized

boolean isChannelIdentityCustomized()

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.

Returns:
The ChannelIdentityCustomzied value
See Also:
SSLMBean.getServerPrivateKeyAlias(), NetworkAccessPointMBean.getCustomPrivateKeyAlias()
Default Value:
false

setChannelIdentityCustomized

void setChannelIdentityCustomized(boolean val)

Sets the value of the ChannelIdentityCustomized attribute.

Parameters:
val - The new ChannelIdentityCustomzied value
See Also:
NetworkAccessPointMBean.isChannelIdentityCustomized()

getCustomPrivateKeyAlias

String getCustomPrivateKeyAlias()

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.

Returns:
The CustomPrivateKeyAlias value
See Also:
SSLMBean.getServerPrivateKeyAlias()

setCustomPrivateKeyAlias

void setCustomPrivateKeyAlias(String alias)

Sets the value of the PrivateKeyAlias attribute.

Parameters:
alias - The new PrivateKeyAlias value
See Also:
NetworkAccessPointMBean.getCustomPrivateKeyAlias()

getPrivateKeyAlias

String getPrivateKeyAlias()

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.

Returns:
The PrivateKeyAlias value
See Also:
SSLMBean.getServerPrivateKeyAlias(), NetworkAccessPointMBean.getCustomPrivateKeyAlias()

getCustomPrivateKeyPassPhrase

String getCustomPrivateKeyPassPhrase()

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.

Returns:
The CustomPrivateKeyPassPhrase value
See Also:
SSLMBean.getServerPrivateKeyPassPhrase()
Default Value:
null

setCustomPrivateKeyPassPhrase

void setCustomPrivateKeyPassPhrase(String phrase)

Sets the value of the PrivateKeyPassPhrase attribute.

Parameters:
phrase - The new PrivateKeyPassPhrase value
See Also:
NetworkAccessPointMBean.getCustomPrivateKeyPassPhrase()

getPrivateKeyPassPhrase

String getPrivateKeyPassPhrase()

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.

Returns:
The PrivateKeyPassPhrase value
See Also:
SSLMBean.getServerPrivateKeyPassPhrase(), NetworkAccessPointMBean.getCustomPrivateKeyPassPhrase()

getCustomPrivateKeyPassPhraseEncrypted

byte[] getCustomPrivateKeyPassPhraseEncrypted()

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

setCustomPrivateKeyPassPhraseEncrypted

void setCustomPrivateKeyPassPhraseEncrypted(byte[] passwordEncrypted)

Sets the encrypted value of the PrivateKeyPassPhrase attribute.

Parameters:
passwordEncrypted -

isClientCertificateEnforced

boolean isClientCertificateEnforced()

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

Returns:
The ClientCertificateEnforced value
Default Value:
false

setClientCertificateEnforced

void setClientCertificateEnforced(boolean enforce)

Sets the value of the ClientCertificateEnabled attribute.

Parameters:
enforce - The new ClientCertificateEnforced value
See Also:
NetworkAccessPointMBean.isClientCertificateEnforced()

isOutboundPrivateKeyEnabled

boolean isOutboundPrivateKeyEnabled()

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

Returns:
The OutboundPrivateKeyEnabled value

setOutboundPrivateKeyEnabled

void setOutboundPrivateKeyEnabled(boolean enabled)
                                  throws InvalidAttributeValueException

Sets the value of the OutboundPrivateKeyEnabled attribute.

Parameters:
enabled - The new outboundEnabled value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.isOutboundEnabled()

getUseFastSerialization

boolean getUseFastSerialization()

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.

Returns:
The UseFastSerialization value

setUseFastSerialization

void setUseFastSerialization(boolean enabled)
                             throws InvalidAttributeValueException

Sets the value of the UseFastSerialization attribute.

Parameters:
enabled - The new UseFastSerialization value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getUseFastSerialization()

setIdleIIOPConnectionTimeout

void setIdleIIOPConnectionTimeout(int seconds)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Sets the value of the IdleIIOPConnectionTimeout attribute.

Parameters:
seconds - The new idleIIOPConnectionTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getIdleIIOPConnectionTimeout()

setSSLListenPort

void setSSLListenPort(int port)
                      throws InvalidAttributeValueException

Sets the value of the SLListenPort attribute.

Parameters:
port - The new sSLListenPort value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getSSLListenPort()

setExternalDNSName

void setExternalDNSName(String externalDNSName)
                        throws InvalidAttributeValueException

Sets the value of the ExternalDNSName attribute.

Parameters:
externalDNSName - The new externalDNSName value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getExternalDNSName()

setLoginTimeoutMillisSSL

void setLoginTimeoutMillisSSL(int millis)
                              throws InvalidAttributeValueException

Sets the value of the LoginTimeoutMillisSSL attribute.

Parameters:
millis - The new loginTimeoutMillisSSL value
Throws:
InvalidAttributeValueException
See Also:
NetworkAccessPointMBean.getLoginTimeoutMillisSSL()

setCompleteT3MessageTimeout

void setCompleteT3MessageTimeout(int seconds)
                                 throws InvalidAttributeValueException,
                                        DistributedManagementException

Sets the value of the CompleteT3MessageTimeout attribute.

Parameters:
seconds - The new completeT3MessageTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getCompleteT3MessageTimeout()

setCompleteHTTPMessageTimeout

void setCompleteHTTPMessageTimeout(int seconds)
                                   throws InvalidAttributeValueException,
                                          DistributedManagementException

Sets the value of the CompleteHTTPMessageTimeout attribute.

Parameters:
seconds - The new completeHTTPMessageTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getCompleteHTTPMessageTimeout()

setCompleteCOMMessageTimeout

void setCompleteCOMMessageTimeout(int seconds)
                                  throws InvalidAttributeValueException,
                                         DistributedManagementException

Sets the value of the CompleteCOMMessageTimeout attribute.

Parameters:
seconds - The new completeCOMMessageTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getCompleteCOMMessageTimeout()

setCompleteIIOPMessageTimeout

void setCompleteIIOPMessageTimeout(int seconds)
                                   throws InvalidAttributeValueException,
                                          DistributedManagementException

Sets the value of the CompleteIIOPMessageTimeout attribute.

Parameters:
seconds - The new completeIIOPMessageTimeout value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
NetworkAccessPointMBean.getCompleteIIOPMessageTimeout()

isSDPEnabled

boolean isSDPEnabled()
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.

Default Value:
false

setSDPEnabled

void setSDPEnabled(boolean enable)
Set whether the channel should be using SDP protocol.

Default Value:
false

getOutboundPrivateKeyAlias

String getOutboundPrivateKeyAlias()

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:

Returns:
The OutboundPrivateKeyAlias value
See Also:
NetworkAccessPointMBean.isOutboundPrivateKeyEnabled(), NetworkAccessPointMBean.isChannelIdentityCustomized(), NetworkAccessPointMBean.getCustomPrivateKeyAlias(), SSLMBean.getOutboundPrivateKeyAlias()
Default Value:
null

getOutboundPrivateKeyPassPhrase

String getOutboundPrivateKeyPassPhrase()

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:

See Also:
NetworkAccessPointMBean.isOutboundPrivateKeyEnabled(), NetworkAccessPointMBean.isChannelIdentityCustomized(), NetworkAccessPointMBean.getCustomPrivateKeyPassPhrase(), SSLMBean.getOutboundPrivateKeyPassPhrase()
Default Value:
null
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Copyright 1996, 2013, 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.1.2)

Part Number E27170-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD