Web Dynpro API Documentation

com.sap.tc.webdynpro.clientserver.portal
Class WDPortalUtils

java.lang.Object
  |
  +--com.sap.tc.webdynpro.clientserver.portal.WDPortalUtils

public class WDPortalUtils
extends java.lang.Object

WDPortalUtils contains some helper functions for the portal environment.


Inner Class Summary
static interface WDPortalUtils.IWDPortalUtils
           
 
Method Summary
static java.lang.Object getServiceReference(java.lang.String serviceName)
          Returns a instance of the specified portal service or NULL if this service could not be found.
static java.lang.Object getServiceReference(java.lang.String serviceName, java.util.Hashtable environment)
          Returns a instance of the specified portal service or NULL if this service could not be found.
static boolean isRunningInPortal()
          Checks whether or not the Web Dynpro application is running the the portal environment or not.
static java.lang.Object lookup(java.lang.String serviceName)
          Returns a reference to the specified portal service or NULL if this service could not be found.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isRunningInPortal

public static boolean isRunningInPortal()
Checks whether or not the Web Dynpro application is running the the portal environment or not.
Returns:
TRUE if the Web Dynpro application is running in the portal environment and FALSE otherwise.

lookup

public static java.lang.Object lookup(java.lang.String serviceName)
Returns a reference to the specified portal service or NULL if this service could not be found.
Parameters:
serviceName - the name of the portal service
Returns:
a reference to the specified portal service of NULL if this servcie could not be found.

getServiceReference

public static java.lang.Object getServiceReference(java.lang.String serviceName)
Returns a instance of the specified portal service or NULL if this service could not be found. For the JNDI lookup to get a service instance the used environment contains one key Context.INITIAL_CONTEXT_FACTORY with value "com.sapportals.portal.prt.registry.PortalRegistryFactory".
Parameters:
serviceName - the full-qualfied name of the portal service
Returns:
a instance of the specified portal service of NULL if this service could not be found.

getServiceReference

public static java.lang.Object getServiceReference(java.lang.String serviceName,
                                                   java.util.Hashtable environment)
Returns a instance of the specified portal service or NULL if this service could not be found.
Parameters:
serviceName - the full-qualfied name of the portal service
environment - the used environment for the JNDI lookup to get the instance of the specified portal service
Returns:
a instance of the specified portal service of NULL if this service could not be found.

Web Dynpro API Documentation

Copyright © 2004 SAP AG. Automatically generated Thu Mar 3 2005, 22:15