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 example : \webapps\irj\WEB-INF\plugins\portal
static IPortalRuntimeResources.LocationType	LT_PRIVATE_RESOURCES Location type for private resources example : \webapps\irj\WEB-INF\plugins\portal\resources
static IPortalRuntimeResources.LocationType	LT_PRIVATE_SERVICES Location type for private resources for services example : \webapps\irj\WEB-INF\plugins\portal\services
static IPortalRuntimeResources.LocationType	LT_PRT_CLASSES Location type for the portal classpath example : \webapps\irj\WEB-INF\classes
static IPortalRuntimeResources.LocationType	LT_PRT_LIBS Location type for the portal lib path example : \webapps\irj\WEB-INF\lib
static IPortalRuntimeResources.LocationType	LT_PUBLIC_DEPLOYMENT Location type for the public home path example : \webapps\irj
static IPortalRuntimeResources.LocationType	LT_PUBLIC_RESOURCES Location type for public resources example : \webapps\irj\resources
static IPortalRuntimeResources.LocationType	LT_PUBLIC_SERVICES Location type for public resources for services example : \webapps\irj\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 example : \webapps\irj\WEB-INF\deployment
static IPortalRuntimeResources.LocationType	LT_SYSTEM_DEPLOYMENT_PCD Location type for the PCD original content example : \webapps\irj\WEB-INF\deployment\Pcd
static IPortalRuntimeResources.LocationType	LT_SYSTEM_DEPLOYMENT_TEMP Location type for temporary files during the deployment example : \webapps\irj\WEB-INF\deployment\temp
static IPortalRuntimeResources.LocationType	LT_SYSTEM_HOME Home path to system resources example : \webapps\irj\WEB-INF\plugins\portal
static IPortalRuntimeResources.LocationType	LT_SYSTEM_RESOURCES Location type for system resources example : \webapps\irj\WEB-INF\plugins\portal\system

Method Summary

IPortalComponent	getDefaultPersonalizationDelegate() Gets the runtime wide defined default personalization delegate
File	getLocation(IPortalRuntimeResources.LocationType locationType) Retrieves a File object denoting the path to the location type specified.
String	getPath(IPortalRuntimeResources.LocationType locationType) Retrieves the full path to the location type specified.
ResourceBundle	getPortalBundle(Locale locale) Gets a ResourceBundle that was defined for the whole Runtime.
IResource	getResource(String resourceType, File file) Returns a IResource object to the file specified.
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

public static final IPortalRuntimeResources.LocationType LT_PUBLIC_DEPLOYMENT

Location type for the public home path

example : \webapps\irj

LT_PRIVATE_DEPLOYMENT

public static final IPortalRuntimeResources.LocationType LT_PRIVATE_DEPLOYMENT

Location type for the private home path

example : \webapps\irj\WEB-INF\plugins\portal

LT_PUBLIC_RESOURCES

public static final IPortalRuntimeResources.LocationType LT_PUBLIC_RESOURCES

Location type for public resources

example : \webapps\irj\resources

LT_PRIVATE_RESOURCES

public static final IPortalRuntimeResources.LocationType LT_PRIVATE_RESOURCES

Location type for private resources

example : \webapps\irj\WEB-INF\plugins\portal\resources

LT_PUBLIC_SERVICES

public static final IPortalRuntimeResources.LocationType LT_PUBLIC_SERVICES

Location type for public resources for services

example : \webapps\irj\services

LT_PRIVATE_SERVICES

public static final IPortalRuntimeResources.LocationType LT_PRIVATE_SERVICES

Location type for private resources for services

example : \webapps\irj\WEB-INF\plugins\portal\services

LT_SYSTEM_HOME

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_HOME

Home path to system resources

example : \webapps\irj\WEB-INF\plugins\portal

LT_SYSTEM_RESOURCES

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_RESOURCES

Location type for system resources

example : \webapps\irj\WEB-INF\plugins\portal\system

LT_SYSTEM_DEPLOYMENT

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT

Location type for system deployment

example : \webapps\irj\WEB-INF\deployment

LT_SYSTEM_DEPLOYMENT_PCD

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT_PCD

Location type for the PCD original content

example : \webapps\irj\WEB-INF\deployment\Pcd

LT_SYSTEM_DEPLOYMENT_TEMP

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_DEPLOYMENT_TEMP

Location type for temporary files during the deployment

example : \webapps\irj\WEB-INF\deployment\temp

LT_SYSTEM_CONTENT

public static final IPortalRuntimeResources.LocationType LT_SYSTEM_CONTENT

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

example : \webapps\irj\WEB-INF\plugins\portal\content

LT_PRT_LIBS

public static final IPortalRuntimeResources.LocationType LT_PRT_LIBS

Location type for the portal lib path

example : \webapps\irj\WEB-INF\lib

LT_PRT_CLASSES

public static final IPortalRuntimeResources.LocationType LT_PRT_CLASSES

Location type for the portal classpath

example : \webapps\irj\WEB-INF\classes

Method Detail

getPortalBundle

public 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

public IPortalComponent getDefaultPersonalizationDelegate()

Gets the runtime wide defined default personalization delegate

Returns:

A default personalization delegate

getService

public 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

public 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

public 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

public IResource getResource(String resourceType,
                             File file)

Returns a IResource object to the file specified.

Parameters:

file - the File object associated to this resource

Returns:

an IResource object

See Also:

IResource

getPath

public String getPath(IPortalRuntimeResources.LocationType locationType)

Retrieves the full path to the location type specified.

Returns:

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

getLocation

public File getLocation(IPortalRuntimeResources.LocationType locationType)

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

Returns:

a File object