oracle.adf.share.platform.glassfish

Class GlassFishAdfServerPlatformSupport

java.lang.Object

oracle.adf.share.platform.AdfAbstractSupport

oracle.adf.share.platform.AdfServerPlatformSupport

oracle.adf.share.platform.glassfish.GlassFishAdfServerPlatformSupport

public class GlassFishAdfServerPlatformSupport
extends AdfServerPlatformSupport

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
GlassFishAdfServerPlatformSupport()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdminServerName() Return the name of the AdminServer for the current Domain.
oracle.jrf.Application	getApplication() We don't provide application version information since GlassFish does not have efficent way to retrieve it from container.
oracle.jrf.ApplicationIdentifier	getApplicationIdentifier() Deprecated.
byte[]	getCheckSum(java.lang.String algorithm, byte[] data) This method will provide a cross platform checksum calculation support.
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	getCredentialStoreProviderClassName() Each platform may have it's own preference for a credential store.
java.lang.String	getDomainConfigDirectory() Return the FMW domain/cell config directory.
java.lang.String	getDomainName() Based on GlassFish domain structure, the domain path always ends with the domain name, so we use File seperator as delimter, and get the last array element as domain name we are looking for.
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.
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 void	setApplicationNameOverride(java.lang.String appName) Deprecated.

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

addContextData, addMessageToRequest, begin, beginNode, endNode, getClusterName, getJtaTransactionXidClassName, getNativeDBConnection, getSupportedPlatformNames, getSystemProperty, isGlassFish, isJBoss, isJEE, isTomcat, isWebLogic, isWebLogicCore, isWebLogicJRF, isWebSphere, isWebSphereAS, isWebSphereND, LogRelativeADFRequest, setSupplementalAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

GlassFishAdfServerPlatformSupport

public GlassFishAdfServerPlatformSupport()

Method Detail

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

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

setApplicationNameOverride

@Concealed
public static void setApplicationNameOverride(java.lang.String appName)

Deprecated.

bug14631409 During Glassfish shutdown the normal way of getting the applicationName is invalid, so allow our lifecycle listener to pass us an override.

Parameters:

appName - Name to use instead of standard implementation. Pass a null to unset override.

For internal use only. Application developers should not use this

Framework internal use only. Applications *must* not call.

getApplicationIdentifier

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

Deprecated.

We don't provide application version information since GlassFish does not have efficent way to retrieve it from container. We use null, just like JRF treat WAS and JBOSS

Overrides:

getApplicationIdentifier in class AdfServerPlatformSupport

Returns:

Throws:

oracle.jrf.PortabilityLayerException

See Also:

ApplicationIdentifier

getApplication

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

We don't provide application version information since GlassFish does not have efficent way to retrieve it from container. We use null, just like JRF treat WAS and JBOSS

Overrides:

getApplication in class AdfServerPlatformSupport

Returns:

Throws:

oracle.jrf.PortabilityLayerException

See Also:

Application

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

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

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

Based on GlassFish domain structure, the domain path always ends with the domain name, so we use File seperator as delimter, and get the last array element as domain name we are looking for. But for user created domain, we can not rely on this system variable to get its value.

Overrides:

getDomainName in class AdfServerPlatformSupport

Returns:

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

getCredentialStoreProviderClassName

public java.lang.String getCredentialStoreProviderClassName()

Description copied from class: AdfServerPlatformSupport

Each platform may have it's own preference for a credential store.

Overrides:

getCredentialStoreProviderClassName in class AdfServerPlatformSupport

Returns:

the class name for this platform.