com.sapportals.portal.prt.runtime

Interface IPortalRuntimeResources

public interface IPortalRuntimeResources

The IPortalRuntimeResources interface is used to provide access to certain resources maintained by the runtime implementation through the Portal Runtime API.

Nested Class Summary

static class

IPortalRuntimeResources.LocationType Handles Location types

Field Summary

static IPortalRuntimeResources.LocationType	LT_PRIVATE_DEPLOYMENT Location type for the private home path
static IPortalRuntimeResources.LocationType	LT_PRIVATE_RESOURCES Location type for private resources
static IPortalRuntimeResources.LocationType	LT_PRIVATE_SERVICES Location type for private resources for services
static IPortalRuntimeResources.LocationType	LT_PRT_CLASSES Location type for the portal classpath
static IPortalRuntimeResources.LocationType	LT_PRT_LIBS Location type for the portal lib path
static IPortalRuntimeResources.LocationType	LT_PUBLIC_DEPLOYMENT Location type for the public home path
static IPortalRuntimeResources.LocationType	LT_PUBLIC_RESOURCES Location type for public resources
static IPortalRuntimeResources.LocationType	LT_PUBLIC_SERVICES Location type for public resources for services
static IPortalRuntimeResources.LocationType	LT_SYSTEM_CONTENT Location type for PRT content (for demo purposes only!)
static IPortalRuntimeResources.LocationType	LT_SYSTEM_DEPLOYMENT Location type for system deployment
static IPortalRuntimeResources.LocationType	LT_SYSTEM_DEPLOYMENT_PCD Location type for the PCD original content
static IPortalRuntimeResources.LocationType	LT_SYSTEM_DEPLOYMENT_TEMP Location type for temporary files during the deployment
static IPortalRuntimeResources.LocationType	LT_SYSTEM_HOME Home path to system resources
static IPortalRuntimeResources.LocationType	LT_SYSTEM_RESOURCES Location type for system resources

Method Summary

IPortalComponent	getDefaultPersonalizationDelegate() Gets the runtime wide defined default personalization delegate
File	getLocation(IPortalRuntimeResources.LocationType locationType) Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources
String	getPath(IPortalRuntimeResources.LocationType locationType) Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources
ResourceBundle	getPortalBundle(Locale locale) Gets a ResourceBundle that was defined for the whole Runtime.
IResource	getResource(String resourceType, File file) Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources
IService	getService(String serviceName) Gets a service by its name.
IService	getService(String serviceName, IServiceConfiguration aServiceConfiguration) Deprecated. Note: do not use anymore
IService	getService(String serviceName, IServiceId aServiceID) Deprecated. Note: do not use anymore

Field Detail

LT_PUBLIC_DEPLOYMENT

static final IPortalRuntimeResources.LocationType LT_PUBLIC_DEPLOYMENT

Location type for the public home path

LT_PRIVATE_DEPLOYMENT

static final IPortalRuntimeResources.LocationType LT_PRIVATE_DEPLOYMENT

Location type for the private home path

LT_PUBLIC_RESOURCES

static final IPortalRuntimeResources.LocationType LT_PUBLIC_RESOURCES

Location type for public resources

LT_PRIVATE_RESOURCES

static final IPortalRuntimeResources.LocationType LT_PRIVATE_RESOURCES

Location type for private resources

LT_PUBLIC_SERVICES

static final IPortalRuntimeResources.LocationType LT_PUBLIC_SERVICES

Location type for public resources for services

LT_PRIVATE_SERVICES

static final IPortalRuntimeResources.LocationType LT_PRIVATE_SERVICES

Location type for private resources for services

LT_SYSTEM_HOME

static final IPortalRuntimeResources.LocationType LT_SYSTEM_HOME

Home path to system resources

LT_SYSTEM_RESOURCES

static final IPortalRuntimeResources.LocationType LT_SYSTEM_RESOURCES

Location type for system resources

LT_SYSTEM_DEPLOYMENT

static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT

Location type for system deployment

LT_SYSTEM_DEPLOYMENT_PCD

static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT_PCD

Location type for the PCD original content

LT_SYSTEM_DEPLOYMENT_TEMP

static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT_TEMP

Location type for temporary files during the deployment

LT_SYSTEM_CONTENT

static final IPortalRuntimeResources.LocationType LT_SYSTEM_CONTENT

Location type for PRT content (for demo purposes only!)

LT_PRT_LIBS

static final IPortalRuntimeResources.LocationType LT_PRT_LIBS

Location type for the portal lib path

LT_PRT_CLASSES

static final IPortalRuntimeResources.LocationType LT_PRT_CLASSES

Location type for the portal classpath

Method Detail

getPortalBundle

ResourceBundle getPortalBundle(Locale locale)

Gets a ResourceBundle that was defined for the whole Runtime.

Parameters:

locale - The Locale to fetch the ResourceBundle for.

Returns:

A ResourceBundle that was defined for the whole Runtime according to the specified Locale

getDefaultPersonalizationDelegate

IPortalComponent getDefaultPersonalizationDelegate()

Gets the runtime wide defined default personalization delegate

Returns:

A default personalization delegate

getService

IService getService(String serviceName)

Gets a service by its name.

Parameters:

serviceName - the fully qualified service name or its alias

Returns:

a service instance or throws a ServiceException

See Also:

IService

getService

IService getService(String serviceName,
                    IServiceId aServiceID)

Deprecated. Note: do not use anymore

Gets a Service of a specific name and a given ID.

Parameters:

serviceName - name of the Service to access

aServiceID - the ID of the service to get

Returns:

a service instance or throws a ServiceException

See Also:

IService, IServiceId

getService

IService getService(String serviceName,
                    IServiceConfiguration aServiceConfiguration)

Deprecated. Note: do not use anymore

gets a service with a name and a service configuration.

Parameters:

serviceName - the name of the Service.

aServiceConfiguration - the configuration of the Servive

Returns:

a service instance or throws a ServiceException

See Also:

IService, IServiceConfiguration

getResource

IResource getResource(String resourceType,
                      File file)

Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources

Returns a IResource object to the file specified.

Parameters:

resourceType - the resource type

file - the File object associated to this resource

Returns:

an IResource object

See Also:

IResource

getPath

String getPath(IPortalRuntimeResources.LocationType locationType)

Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources

Retrieves the full path to the location type specified.

Returns:

a String denoting the full path to the location type specified.

getLocation

File getLocation(IPortalRuntimeResources.LocationType locationType)

Deprecated. Use IPortalComponentRequest#getResource(String resourceType, String resourcePath) method to access resources

Retrieves a File object denoting the path to the location type specified.

Returns:

a File object

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN