java.io.Serializable
public abstract class PortConfig
extends java.lang.Object
implements java.io.Serializable
Port configuration object encapsulates port information of the running application server.
LIMITATIONS:
getClusterHttpPorts() getClusterHttpSslPorts() getClusterMemberPorts(String Protocol)
This is because the node profile of the running server only knows port endpoint and transports of servers running in its node, except JNDI port where all member must use the same endpoint name "BOOTSTRAP_ADDRESS".
Workaround: if you can connect to "dmgr" MBean server, use JRF domain runtime mbean oracle.jrf.JRFServiceMBean to obtain remote server URL.
a) Create a file named jrf-port-config.properties and place it in the FMW server configuration directory in the DMGR's profile:
<dmgr profile directory>/config/cells/<cell name>/nodes/&l;tnode name>/servers/<server name>/fmwconfigIf you place it in other profiles, it will be removed when Wepshere next synchronizes profiles from the DMGR.
Example jrf-port-config.properties: frontend.http.host=webserver1.oracle.com frontend.http.port=8686 frontend.https.host=webserver1.oracle.com frontend.https.port=8787
c) start or restart the server
Note: On WebLogic, if the port is configured with 0 or blank "", JRF consider the port disabled and will return null Port instance.
WARNING: Do not hold on to this object since it may contain stale data if configuration changed. If you need current port info, get new object from oracle.jrf.ServerPlatformSupport.getPortConfig().
Modifier and Type | Method | Description |
---|---|---|
Port |
getClusterFrontEndHttpPort() |
Return front-end http port of the web server configured with the cluster, or null if the server is not member of the cluster or web server is not configured
Note: See Limitation 2 above in the class javadoc
|
Port |
getClusterFrontEndHttpSslPort() |
Return front-end https port of the web server configured with the cluster, or null if the server is not member of the cluster or web server is not configured
Note: See Limitation 2 above in the class javadoc
|
java.util.List<Port> |
getClusterHttpPorts() |
Return a list of http ports configured with each member in the cluster if the running server is a member of the cluster.
|
java.util.List<Port> |
getClusterHttpSslPorts() |
Return a list of https ports configured with each member in the cluster if the running server is a member of the cluster.
|
java.util.List<Port> |
getClusterMemberPorts(java.lang.String protocol) |
Return a list of the specified protocol ports configured with each member in the cluster if the running server is a member of the cluster.
|
Port |
getFrontEndHttpPort() |
Return the http port of the web server configured with the running server or null if not configured.
|
Port |
getFrontEndHttpSslPort() |
Return the https port of the web server configured with the running server or null if not configured.
|
Port |
getHttpPort() |
Return the http port associated with the running server, or null if disabled http.
|
Port |
getHttpPort(java.lang.String partitionName) |
Return the http port for the specified partition, associated with the current server,
or null if disabled http.
|
Port |
getHttpSslPort() |
Return the https port associated with the running server, or null if disabled https.
|
Port |
getHttpSslPort(java.lang.String partitionName) |
Return the https port for the specified partition, associated with the current server,
or null if disabled https.
|
java.lang.String |
getJndiProviderURL() |
Return the URL string for the default JNDI non-secure protocol.
|
java.lang.String |
getJndiProviderURL(java.lang.String partitionName) |
For a specified partition,
return the URL string for the default JNDI non-secure protocol.
|
java.lang.String |
getJndiSslProviderURL() |
Return the URL string for the default JNDI secure protocol, or null if SSL is not enabled.
|
java.lang.String |
getJndiSslProviderURL(java.lang.String partitionName) |
For a specified partition,
return the URL string for the default JNDI secure protocol, or null if SSL is not enabled.
|
Port |
getServerPort(java.lang.String protocol) |
Return port of the specified protocol configured with the running server, or null if the specified protocol or its port is not enabled or not found.
|
abstract java.lang.String[] |
getSupportedPortProtocols() |
Return supported protocols on the current platform.
|
abstract boolean |
isClustered() |
Return true if the running server is clustered on WebLogic platform.
|
public abstract java.lang.String[] getSupportedPortProtocols()
Return supported protocols on the current platform. e.g: WebLogic: {HTTP, HTTPS, WEBLOGIC_T3, WEBLOGIC_T3S, WEBLOGIC_IIOP, WEBLOGIC_IIOPS}
public Port getHttpPort()
public Port getHttpPort(java.lang.String partitionName)
public java.util.List<Port> getClusterHttpPorts()
Return a list of http ports configured with each member in the cluster if the running server is a member of the cluster. Return null if the running server is not clustered or http or its port not enabled or found on any member. This generic API can be used when other cluster member APIs are not applicable. Note: - If a member is not found in the result, http or its port is not found or enabled on the member. - Use oracle.jrf.Port.isLocal() if you need to determine the host of a port is the local host.
public Port getHttpSslPort()
public Port getHttpSslPort(java.lang.String partitionName)
public java.util.List<Port> getClusterHttpSslPorts()
Return a list of https ports configured with each member in the cluster if the running server is a member of the cluster. Return null if the running server is not clustered or https or its port not enabled or found on any member. This generic API can be used when other cluster member APIs are not applicable. Note: - If a member is not found in the result, https or its port is not found or enabled on the member. - Use oracle.jrf.Port.isLocal() if you need to determine the host of a port is the local host.
public Port getFrontEndHttpPort()
Return the http port of the web server configured with the running server or null if not configured. Note: See Limitation 2 above in the class javadoc
public Port getFrontEndHttpSslPort()
Return the https port of the web server configured with the running server or null if not configured. Note: See Limitation 2 above in the class javadoc
public Port getClusterFrontEndHttpPort()
Return front-end http port of the web server configured with the cluster, or null if the server is not member of the cluster or web server is not configured Note: See Limitation 2 above in the class javadoc
public Port getClusterFrontEndHttpSslPort()
Return front-end https port of the web server configured with the cluster, or null if the server is not member of the cluster or web server is not configured Note: See Limitation 2 above in the class javadoc
public java.util.List<Port> getClusterMemberPorts(java.lang.String protocol)
Return a list of the specified protocol ports configured with each member in the cluster if the running server is a member of the cluster. Return null if the running server is not clustered or the specified protocol or its port not enabled or found on any member. This generic API can be used when other cluster member port APIs are not applicable. Note: - If a member is not found in the result, the specified protocol or its port is not found or enabled on the member. - Use oracle.jrf.Port.isLocal() if you need to determine the host of a port is the local host.
protocol
- valid value that matches one of oracle.jrf.PortConfig.getSupportedPortProtocols()public Port getServerPort(java.lang.String protocol)
Return port of the specified protocol configured with the running server, or null if the specified protocol or its port is not enabled or not found. This generic API can be used when other server port APIs are not applicable.
protocol
- valid value that matches one of oracle.jrf.PortConfig.getSupportedPortProtocols()public java.lang.String getJndiProviderURL()
Return the URL string for the default JNDI non-secure protocol. This is used as value for Context.Provider_URL property to obtain JNDI initial context. Default non-secure JNDI protocols are prioritized in this order: WebLogic: { WEBLOGIC_T3, WEBLOGIC_IIOP } The result is built using this logic: - If server is not clustered, return the URL string built from result of the running server jndi port e.g: "t3://server1:7001" - If server is clustered, return comma separate list of multiple server and host. e.g: "t3://server1:7001,server2:7002" on WebLogic Note: if ClusterAddress is set in WebLogic, return URL string in this format "{default enabled JNDI protocol}://{cluster address}" e.g: "t3://dnscluster1.com:7001" on WebLogic, or "t3://server1:7001,server2:70012"
public java.lang.String getJndiProviderURL(java.lang.String partitionName)
public java.lang.String getJndiSslProviderURL()
Return the URL string for the default JNDI secure protocol, or null if SSL is not enabled. The result is used as value for Context.Provider_URL property to obtain JNDI initial context. Default secure JNDI protocols are prioritized in this order: WebLogic: { WEBLOGIC_T3S, WEBLOGIC_IIOPS } The result is built using this logic: - If server is not clustered, return the URL string built from result of getJndiSslPort() e.g: "t3s://server1:7001" on WebLogic - If server is clustered, return comma separate list of multiple server and host. e.g: "t3s://server1:7001,server2:7002" on WebLogic Note: if ClusterAddress is set in WLS, return URL string in this format "{default enabled JNDI SSL protocol}://{cluster address}" e.g: "t3s://dnscluster1.com:7002" on WebLogic or "t3s://server1:7001,server2:7002"
public java.lang.String getJndiSslProviderURL(java.lang.String partitionName)
public abstract boolean isClustered()
Return true if the running server is clustered on WebLogic platform.