oracle.adf.share.platform

Class AdfNoServerPlatformSupport

java.lang.Object

oracle.adf.share.platform.AdfAbstractSupport

oracle.adf.share.platform.AdfServerPlatformSupport

oracle.adf.share.platform.AdfNoServerPlatformSupport

public class AdfNoServerPlatformSupport
extends AdfServerPlatformSupport

This class will be used when caller is from none JEE env, instead of directly throw UnknownPlatformException in support factory, it deplayed the throwing quite later until those method got called.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.share.platform.AdfAbstractSupport

AdfAbstractSupport.PLATFORM_TYPE

Field Summary

Fields inherited from class oracle.adf.share.platform.AdfServerPlatformSupport

CLUSTER_UNKNOWN, CREDENTIAL_STORE_PROVIDER_DEFAULT, CREDENTIAL_STORE_PROVIDER_NO_STORE, logger

Constructor Summary

Constructors

Constructor and Description
AdfNoServerPlatformSupport()

Method Summary

Modifier and Type	Method and Description
void	addContextData(java.lang.String loggerName, java.lang.String actionName, java.util.HashMap<java.lang.String,java.lang.String> contextData)
void	addMessageToRequest(java.lang.String loggerName, java.util.logging.Level level, java.lang.String actionName, java.util.Map<java.lang.String,java.lang.String> contextData, java.lang.String MessageTag, java.lang.String methodName, java.lang.Throwable thrown)
void	begin(java.lang.String loggerName, java.lang.String actionName, java.util.HashMap<java.lang.String,java.lang.String> contextData)
void	beginNode(java.lang.String loggerName, java.util.logging.Level level, java.lang.String actionName, java.util.Map<java.lang.String,java.lang.String> contextData, java.lang.String methodName)
void	endNode(java.lang.String loggerName, java.util.logging.Level level, java.lang.String actionName)
java.lang.String	getAdminServerName() Return the name of the AdminServer for the current Domain.
oracle.jrf.Application	getApplication() Return the Application instance which contains the deployment and runtime application names, and application version if applicable.
oracle.jrf.ApplicationIdentifier	getApplicationIdentifier() Return the ApplicationIdentifier instance which contains the deployment and runtime application names, and application version if applicable.
byte[]	getCheckSum(java.lang.String algorithm, byte[] data) This method will provide a cross platform checksum calculation support.
java.lang.String	getClusterName() Return cluster name of the running server.
java.lang.String	getCommonComponentsHome() Return the path to Common Components home directory.
java.lang.Object	getConcretePlatformSupport() This abstract method will let each concrete sub platform support class to provide either JRF sever platform support or others.
java.lang.String	getDomainConfigDirectory() Return the FMW domain/cell config directory.
java.lang.String	getDomainName() Return the domain name in WebLogic server and cell name in WebSphere server
java.lang.String	getPlatformName() Return the application's running server platform name, e.g.
oracle.jrf.PortConfig	getPortConfig() Return the port configuration object of the running server.
oracle.jrf.PortConfig	getPortConfig(java.lang.String serverId) Return the port configuration object of a specific server in the same WebLogic domain or WAS cell as the running server.
java.lang.String	getServerConfigDirectory() Return the FMW server config directory.
java.lang.String	getServerConfigDirectory(java.lang.String domainName, java.lang.String serverName) Return config directory of a specified server under a specified domain/cell
java.lang.String	getServerLogPath() Return the Absolute path to the log directory associated with this Server instance
java.lang.String	getServerName() Return the name of the current Server.
java.lang.String[]	getSupportedPlatformNames() Deprecated.
boolean	isAdminServer() Return true if the current Server is the AdminServer
boolean	isExalogicOptimizationsEnabled() Returns true if the underlying platform has optimizations for Exalogic turned on.
static boolean	isJEE()
void	LogRelativeADFRequest(java.lang.String loggerName, java.lang.String ecid)
void	setSupplementalAttributes()

Methods inherited from class oracle.adf.share.platform.AdfServerPlatformSupport

getCredentialStoreProviderClassName, getJtaTransactionXidClassName, getNativeDBConnection, getSystemProperty, isGlassFish, isJBoss, isTomcat, isWebLogic, isWebLogicCore, isWebLogicJRF, isWebSphere, isWebSphereAS, isWebSphereND

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdfNoServerPlatformSupport

public AdfNoServerPlatformSupport()

Method Detail

getClusterName

public java.lang.String getClusterName()
                                throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return cluster name of the running server. If the running server is clustered, return the cluster name. If the running server is not clustered, return null. If it cannot determined server is clustered when running on a particular platform, return ServerPlatformSupport.CLUSTER_UNKNOWN

   Usage:
     String clusterName = platform.getClusterName();
     boolean isServerClustered = clusterName != null && clusterName != ServerPlatformSupport.CLUSTER_UNKNOWN;
  

Overrides:

getClusterName in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException - - when there is problem accessing runtime mbeans

getConcretePlatformSupport

public java.lang.Object getConcretePlatformSupport()
                                            throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

This abstract method will let each concrete sub platform support class to provide either JRF sever platform support or others.

Specified by:

getConcretePlatformSupport in class AdfServerPlatformSupport

Returns:

Object need to be downcast to concrete class type

Throws:

oracle.jrf.PortabilityLayerException

getCheckSum

public byte[] getCheckSum(java.lang.String algorithm,
                          byte[] data)
                   throws java.lang.Exception

Description copied from class: AdfServerPlatformSupport

This method will provide a cross platform checksum calculation support. For WLS/WAS platform, the underneath checksum runtime will be provided by OPSS; for Glassfish or Tomcat platform, we will use JDK security API for checksum calculation. Each concrete platform support class need to override the default impl as needed

Overrides:

getCheckSum in class AdfServerPlatformSupport

Parameters:

algorithm - checksum algorithm string such as "MD5", "SHA1", "SHA-256", etc. By default, "MD5" will be used if null string passed in

data - byte[] data value

Returns:

byte array from checksum calculation

Throws:

java.lang.Exception

getPlatformName

public java.lang.String getPlatformName()

Description copied from class: AdfServerPlatformSupport

Return the application's running server platform name, e.g. weblogic, websphere, jboss.

Overrides:

getPlatformName in class AdfServerPlatformSupport

getApplicationIdentifier

public oracle.jrf.ApplicationIdentifier getApplicationIdentifier()
                                                          throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the ApplicationIdentifier instance which contains the deployment and runtime application names, and application version if applicable.

Overrides:

getApplicationIdentifier in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

See Also:

ApplicationIdentifier

getApplication

public oracle.jrf.Application getApplication()
                                      throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the Application instance which contains the deployment and runtime application names, and application version if applicable.

Overrides:

getApplication in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

See Also:

Application

getSupportedPlatformNames

@Deprecated
public java.lang.String[] getSupportedPlatformNames()

Deprecated.

Description copied from class: AdfServerPlatformSupport

Return the array of application server platform names being supported by the portability layer. Besides what JRF supports: "weblogic", "websphere", "jboss", we will add "glassfish" at very end of the array.

Overrides:

getSupportedPlatformNames in class AdfServerPlatformSupport

getAdminServerName

public java.lang.String getAdminServerName()
                                    throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the name of the AdminServer for the current Domain.

Overrides:

getAdminServerName in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getServerName

public java.lang.String getServerName()
                               throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the name of the current Server.

Overrides:

getServerName in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getServerLogPath

public java.lang.String getServerLogPath()
                                  throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the Absolute path to the log directory associated with this Server instance

Overrides:

getServerLogPath in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

isAdminServer

public boolean isAdminServer()
                      throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return true if the current Server is the AdminServer

Overrides:

isAdminServer in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

isJEE

public static boolean isJEE()

getServerConfigDirectory

public java.lang.String getServerConfigDirectory(java.lang.String domainName,
                                                 java.lang.String serverName)
                                          throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return config directory of a specified server under a specified domain/cell

Overrides:

getServerConfigDirectory in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getDomainConfigDirectory

public java.lang.String getDomainConfigDirectory()
                                          throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the FMW domain/cell config directory.

Overrides:

getDomainConfigDirectory in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getServerConfigDirectory

public java.lang.String getServerConfigDirectory()
                                          throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the FMW server config directory.

Overrides:

getServerConfigDirectory in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getDomainName

public java.lang.String getDomainName()
                               throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the domain name in WebLogic server and cell name in WebSphere server

Overrides:

getDomainName in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getPortConfig

public oracle.jrf.PortConfig getPortConfig()
                                    throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

 Return the port configuration object of the running server.  This method is optimized by caching the result and automatically refreshed 
 the cache when change to the port configuration is detected.
 
 Note: On WAS platform, the result is built from parsing local configurations.  WAS ND user is required to synchronize 
 the local node to obtain configurations from the master repository, if changes were made to related configurations.
 

Overrides:

getPortConfig in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

getPortConfig

public oracle.jrf.PortConfig getPortConfig(java.lang.String serverId)
                                    throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

 Return the port configuration object of a specific server in the same WebLogic domain or WAS cell as the running server.  
 The return instance is not cached.  This is used to obtain port configuration of a server that differs from the running server.
  
 Not supported on single server platforms: JBoss and WAS AS.
 
 LIMITATION: 
 On WAS platform, if the running server is not "dmgr" or not in the same node as the specifying server, JRF can only discover 
 the specifying server JNDI port/url using local configuration files of the running server.  Only  getJndiProviderURL() and 
 and getJndiSslProviderURL() can be relied up on the returned PortConfig instance in this case.  If you can connect to MBean 
 server on the "dmgr", use JRF domain runtime MBean, ObjectName "oracle.jrf:name=JRFService,type=oracle.jrf.JRFServiceMBean", 
 to obtain server URLs, see oracle.jrf.JRFServiceMBean.
 
 Note: On WAS platform, the result is built from parsing local configurations.  WAS ND user is required  to synchronize 
 the local node to obtain configurations from the master repository, if changes were made to related configurations.
 

Overrides:

getPortConfig in class AdfServerPlatformSupport

Parameters:

serverId - - server name on WebLogic. On WAS ND, it is the containment path of the server (i.e: "/Cell:cell1/Node:node1/Server:server1").

Throws:

oracle.jrf.PortabilityLayerException - - when used on JBoss or WAS AS.

getCommonComponentsHome

public java.lang.String getCommonComponentsHome()
                                         throws oracle.jrf.PortabilityLayerException

Description copied from class: AdfServerPlatformSupport

Return the path to Common Components home directory.

Overrides:

getCommonComponentsHome in class AdfServerPlatformSupport

Throws:

oracle.jrf.PortabilityLayerException

isExalogicOptimizationsEnabled

public boolean isExalogicOptimizationsEnabled()

Description copied from class: AdfServerPlatformSupport

Returns true if the underlying platform has optimizations for Exalogic turned on. Can only ever be true for a WLS platform.

Overrides:

isExalogicOptimizationsEnabled in class AdfServerPlatformSupport

setSupplementalAttributes

public void setSupplementalAttributes()

Overrides:

setSupplementalAttributes in class AdfServerPlatformSupport

begin

public void begin(java.lang.String loggerName,
                  java.lang.String actionName,
                  java.util.HashMap<java.lang.String,java.lang.String> contextData)

Overrides:

begin in class AdfServerPlatformSupport

beginNode

public void beginNode(java.lang.String loggerName,
                      java.util.logging.Level level,
                      java.lang.String actionName,
                      java.util.Map<java.lang.String,java.lang.String> contextData,
                      java.lang.String methodName)

Overrides:

beginNode in class AdfServerPlatformSupport

addContextData

public void addContextData(java.lang.String loggerName,
                           java.lang.String actionName,
                           java.util.HashMap<java.lang.String,java.lang.String> contextData)

Overrides:

addContextData in class AdfServerPlatformSupport

addMessageToRequest

public void addMessageToRequest(java.lang.String loggerName,
                                java.util.logging.Level level,
                                java.lang.String actionName,
                                java.util.Map<java.lang.String,java.lang.String> contextData,
                                java.lang.String MessageTag,
                                java.lang.String methodName,
                                java.lang.Throwable thrown)

Overrides:

addMessageToRequest in class AdfServerPlatformSupport

endNode

public void endNode(java.lang.String loggerName,
                    java.util.logging.Level level,
                    java.lang.String actionName)

Overrides:

endNode in class AdfServerPlatformSupport

LogRelativeADFRequest

public void LogRelativeADFRequest(java.lang.String loggerName,
                                  java.lang.String ecid)

Overrides:

LogRelativeADFRequest in class AdfServerPlatformSupport